Header menu logo Nu

Attachment Module

Attachment operations.

Functions and values

Function or value Description

Attachment.createAmbientAttachment resolutionX resolutionY context

Full Usage: Attachment.createAmbientAttachment resolutionX resolutionY context

Parameters:
Returns: Texture

Create ambient attachment.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createBloomSampleAttachments resolutionX resolutionY context

Full Usage: Attachment.createBloomSampleAttachments resolutionX resolutionY context

Parameters:
Returns: Texture[]

Create bloom sample attachments.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture[]

Attachment.createColorAttachment textureType optionalUsageFlags internalFormat pixelFormat resolutionX resolutionY context

Full Usage: Attachment.createColorAttachment textureType optionalUsageFlags internalFormat pixelFormat resolutionX resolutionY context

Parameters:
Returns: Texture

Create a color attachment.

textureType : TextureType
optionalUsageFlags : VkImageUsageFlags
internalFormat : ImageFormat
pixelFormat : PixelFormat
resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createColoringAttachments resolutionX resolutionY context

Full Usage: Attachment.createColoringAttachments resolutionX resolutionY context

Parameters:
Returns: Texture * Texture

Create coloring attachments.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture * Texture

Attachment.createCompositionAttachment resolutionX resolutionY context

Full Usage: Attachment.createCompositionAttachment resolutionX resolutionY context

Parameters:
Returns: Texture

Create composition attachments.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createDepthAttachment optionalUsages resolutionX resolutionY context

Full Usage: Attachment.createDepthAttachment optionalUsages resolutionX resolutionY context

Parameters:
Returns: Texture

Create depth attachment.

optionalUsages : VkImageUsageFlags
resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createEnvironmentFilterAttachment resolutionX resolutionY context

Full Usage: Attachment.createEnvironmentFilterAttachment resolutionX resolutionY context

Parameters:
Returns: Texture

Create environment filter attachment.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createFoggingAttachment resolutionX resolutionY context

Full Usage: Attachment.createFoggingAttachment resolutionX resolutionY context

Parameters:
Returns: Texture

Create fogging attachment.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createGammaCorrectionAttachments resolutionX resolutionY context

Full Usage: Attachment.createGammaCorrectionAttachments resolutionX resolutionY context

Parameters:
Returns: Texture

Create gamma correction attachments.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createGeometryAttachments resolutionX resolutionY context

Full Usage: Attachment.createGeometryAttachments resolutionX resolutionY context

Parameters:
Returns: Texture * Texture * Texture * Texture * Texture * Texture * Texture * Texture

Create geometry attachments.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture * Texture * Texture * Texture * Texture * Texture * Texture * Texture

Attachment.createIrradianceAttachment resolutionX resolutionY context

Full Usage: Attachment.createIrradianceAttachment resolutionX resolutionY context

Parameters:
Returns: Texture

Create irradiance attachment.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createLightMappingAttachment resolutionX resolutionY context

Full Usage: Attachment.createLightMappingAttachment resolutionX resolutionY context

Parameters:
Returns: Texture

Create light mapping attachment.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createLightingAttachment resolutionX resolutionY context

Full Usage: Attachment.createLightingAttachment resolutionX resolutionY context

Parameters:
Returns: Texture

Create lighting attachment.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.createShadowCascadeArrayAttachments shadowCascadeResolutionX shadowCascadeResolutionY shadowCascadeLevels context

Full Usage: Attachment.createShadowCascadeArrayAttachments shadowCascadeResolutionX shadowCascadeResolutionY shadowCascadeLevels context

Parameters:
    shadowCascadeResolutionX : int
    shadowCascadeResolutionY : int
    shadowCascadeLevels : int
    context : VulkanContext

Returns: Texture * Texture

Create shadow cascade array attachments.

shadowCascadeResolutionX : int
shadowCascadeResolutionY : int
shadowCascadeLevels : int
context : VulkanContext
Returns: Texture * Texture

Attachment.createShadowMapAttachments shadowResolutionX shadowResolutionY context

Full Usage: Attachment.createShadowMapAttachments shadowResolutionX shadowResolutionY context

Parameters:
    shadowResolutionX : int
    shadowResolutionY : int
    context : VulkanContext

Returns: Texture * Texture

Create shadow map attachments.

shadowResolutionX : int
shadowResolutionY : int
context : VulkanContext
Returns: Texture * Texture

Attachment.createShadowTextureArrayAttachments shadowResolutionX shadowResolutionY shadowResolutionZ context

Full Usage: Attachment.createShadowTextureArrayAttachments shadowResolutionX shadowResolutionY shadowResolutionZ context

Parameters:
    shadowResolutionX : int
    shadowResolutionY : int
    shadowResolutionZ : int
    context : VulkanContext

Returns: Texture * Texture

Create shadow texture array attachments.

shadowResolutionX : int
shadowResolutionY : int
shadowResolutionZ : int
context : VulkanContext
Returns: Texture * Texture

Attachment.createToneMappingAttachments resolutionX resolutionY context

Full Usage: Attachment.createToneMappingAttachments resolutionX resolutionY context

Parameters:
Returns: Texture

Create tone-mapping attachments.

resolutionX : int
resolutionY : int
context : VulkanContext
Returns: Texture

Attachment.destroyAmbientAttachment ambient context

Full Usage: Attachment.destroyAmbientAttachment ambient context

Parameters:

Destroy ambient attachment.

ambient : Texture
context : VulkanContext

Attachment.destroyBloomSampleAttachments bloomSamples context

Full Usage: Attachment.destroyBloomSampleAttachments bloomSamples context

Parameters:

Destroy bloom sample attachments.

bloomSamples : Texture array
context : VulkanContext

Attachment.destroyColorAttachment color context

Full Usage: Attachment.destroyColorAttachment color context

Parameters:

Destroy color attachment.

color : Texture
context : VulkanContext

Attachment.destroyColoringAttachments (color, depth) context

Full Usage: Attachment.destroyColoringAttachments (color, depth) context

Parameters:

Destroy coloring attachments.

color : Texture
depth : Texture
context : VulkanContext

Attachment.destroyCompositionAttachment color context

Full Usage: Attachment.destroyCompositionAttachment color context

Parameters:

Destroy composition attachments.

color : Texture
context : VulkanContext

Attachment.destroyDepthAttachment depth context

Full Usage: Attachment.destroyDepthAttachment depth context

Parameters:

Destroy depth attachment.

depth : Texture
context : VulkanContext

Attachment.destroyEnvironmentFilterAttachment environmentfilter context

Full Usage: Attachment.destroyEnvironmentFilterAttachment environmentfilter context

Parameters:

Destroy environment filter attachment.

environmentfilter : Texture
context : VulkanContext

Attachment.destroyFoggingAttachment fogging context

Full Usage: Attachment.destroyFoggingAttachment fogging context

Parameters:

Destroy fogging attachment.

fogging : Texture
context : VulkanContext

Attachment.destroyGammaCorrectionAttachment gammaCorrection context

Full Usage: Attachment.destroyGammaCorrectionAttachment gammaCorrection context

Parameters:

Destroy gamma-correction attachments.

gammaCorrection : Texture
context : VulkanContext

Attachment.destroyGeometryAttachments (depth, albedo, material, normalPlus, subdermalPlus, scatterPlus, clearCoatPlus, z) context

Full Usage: Attachment.destroyGeometryAttachments (depth, albedo, material, normalPlus, subdermalPlus, scatterPlus, clearCoatPlus, z) context

Parameters:

Destroy geometry attachments.

depth : Texture
albedo : Texture
material : Texture
normalPlus : Texture
subdermalPlus : Texture
scatterPlus : Texture
clearCoatPlus : Texture
z : Texture
context : VulkanContext

Attachment.destroyIrradianceAttachment irradiance context

Full Usage: Attachment.destroyIrradianceAttachment irradiance context

Parameters:

Destroy irradiance attachment.

irradiance : Texture
context : VulkanContext

Attachment.destroyLightMappingAttachment lightmapping context

Full Usage: Attachment.destroyLightMappingAttachment lightmapping context

Parameters:

Destroy light mapping attachment.

lightmapping : Texture
context : VulkanContext

Attachment.destroyLightingAttachment lighting context

Full Usage: Attachment.destroyLightingAttachment lighting context

Parameters:

Destroy lighting attachment.

lighting : Texture
context : VulkanContext

Attachment.destroyShadowCascadeArrayAttachments colorTexture zTexture context

Full Usage: Attachment.destroyShadowCascadeArrayAttachments colorTexture zTexture context

Parameters:

Destroy shadow cascade array attachments.

colorTexture : Texture
zTexture : Texture
context : VulkanContext

Attachment.destroyShadowMapAttachments colorTexture zTexture context

Full Usage: Attachment.destroyShadowMapAttachments colorTexture zTexture context

Parameters:

Destroy shadow map attachments.

colorTexture : Texture
zTexture : Texture
context : VulkanContext

Attachment.destroyShadowTextureArrayAttachments colorTexture zTexture context

Full Usage: Attachment.destroyShadowTextureArrayAttachments colorTexture zTexture context

Parameters:

Destroy shadow texture array attachments.

colorTexture : Texture
zTexture : Texture
context : VulkanContext

Attachment.destroyToneMappingAttachments toneMapping context

Full Usage: Attachment.destroyToneMappingAttachments toneMapping context

Parameters:

Destroy tone-mapping attachments.

toneMapping : Texture
context : VulkanContext

Attachment.updateAmbientAttachmentSize resolutionX resolutionY ambient context

Full Usage: Attachment.updateAmbientAttachmentSize resolutionX resolutionY ambient context

Parameters:

Update size of ambient attachment.

resolutionX : int
resolutionY : int
ambient : Texture
context : VulkanContext

Attachment.updateBloomSampleAttachmentsSize resolutionX resolutionY bloomSamples context

Full Usage: Attachment.updateBloomSampleAttachmentsSize resolutionX resolutionY bloomSamples context

Parameters:

Update size of bloom sample attachments.

resolutionX : int
resolutionY : int
bloomSamples : Texture array
context : VulkanContext

Attachment.updateColorAttachmentSize resolutionX resolutionY color context

Full Usage: Attachment.updateColorAttachmentSize resolutionX resolutionY color context

Parameters:

Update size of color attachment.

resolutionX : int
resolutionY : int
color : Texture
context : VulkanContext

Attachment.updateColoringAttachmentsSize resolutionX resolutionY (color, depth) context

Full Usage: Attachment.updateColoringAttachmentsSize resolutionX resolutionY (color, depth) context

Parameters:

Update size of coloring attachments.

resolutionX : int
resolutionY : int
color : Texture
depth : Texture
context : VulkanContext

Attachment.updateCompositionAttachmentSize resolutionX resolutionY color context

Full Usage: Attachment.updateCompositionAttachmentSize resolutionX resolutionY color context

Parameters:

Update size of composition attachments.

resolutionX : int
resolutionY : int
color : Texture
context : VulkanContext

Attachment.updateDepthAttachmentSize resolutionX resolutionY depth context

Full Usage: Attachment.updateDepthAttachmentSize resolutionX resolutionY depth context

Parameters:

Update size of depth attachment.

resolutionX : int
resolutionY : int
depth : Texture
context : VulkanContext

Attachment.updateEnvironmentFilterAttachmentSize resolutionX resolutionY environmentfilter context

Full Usage: Attachment.updateEnvironmentFilterAttachmentSize resolutionX resolutionY environmentfilter context

Parameters:

Update size of environment filter attachment.

resolutionX : int
resolutionY : int
environmentfilter : Texture
context : VulkanContext

Attachment.updateFoggingAttachmentSize resolutionX resolutionY fogging context

Full Usage: Attachment.updateFoggingAttachmentSize resolutionX resolutionY fogging context

Parameters:

Update size of fogging attachment.

resolutionX : int
resolutionY : int
fogging : Texture
context : VulkanContext

Attachment.updateGammaCorrectionAttachmentsSize resolutionX resolutionY gammaCorrection context

Full Usage: Attachment.updateGammaCorrectionAttachmentsSize resolutionX resolutionY gammaCorrection context

Parameters:

Update size of gamma-correction attachments.

resolutionX : int
resolutionY : int
gammaCorrection : Texture
context : VulkanContext

Attachment.updateGeometryAttachmentsSize resolutionX resolutionY (depth, albedo, material, normalPlus, subdermalPlus, scatterPlus, clearCoatPlus, z) context

Full Usage: Attachment.updateGeometryAttachmentsSize resolutionX resolutionY (depth, albedo, material, normalPlus, subdermalPlus, scatterPlus, clearCoatPlus, z) context

Parameters:

Update size of geometry attachments.

resolutionX : int
resolutionY : int
depth : Texture
albedo : Texture
material : Texture
normalPlus : Texture
subdermalPlus : Texture
scatterPlus : Texture
clearCoatPlus : Texture
z : Texture
context : VulkanContext

Attachment.updateIrradianceAttachmentSize resolutionX resolutionY irradiance context

Full Usage: Attachment.updateIrradianceAttachmentSize resolutionX resolutionY irradiance context

Parameters:

Update size of irradiance attachment.

resolutionX : int
resolutionY : int
irradiance : Texture
context : VulkanContext

Attachment.updateLightMappingAttachmentSize resolutionX resolutionY lightmapping context

Full Usage: Attachment.updateLightMappingAttachmentSize resolutionX resolutionY lightmapping context

Parameters:

Update size of light mapping attachment.

resolutionX : int
resolutionY : int
lightmapping : Texture
context : VulkanContext

Attachment.updateLightingAttachmentSize resolutionX resolutionY lighting context

Full Usage: Attachment.updateLightingAttachmentSize resolutionX resolutionY lighting context

Parameters:

Update size of lighting attachment.

resolutionX : int
resolutionY : int
lighting : Texture
context : VulkanContext

Attachment.updateShadowCascadeArrayAttachmentsSize resolutionX resolutionY colorTexture zTexture context

Full Usage: Attachment.updateShadowCascadeArrayAttachmentsSize resolutionX resolutionY colorTexture zTexture context

Parameters:

Update size of shadow cascade array attachments.

resolutionX : int
resolutionY : int
colorTexture : Texture
zTexture : Texture
context : VulkanContext

Attachment.updateShadowMapAttachmentsSize resolutionX resolutionY colorTexture zTexture context

Full Usage: Attachment.updateShadowMapAttachmentsSize resolutionX resolutionY colorTexture zTexture context

Parameters:

Update size of shadow map attachments.

resolutionX : int
resolutionY : int
colorTexture : Texture
zTexture : Texture
context : VulkanContext

Attachment.updateShadowTextureArrayAttachmentsSize resolutionX resolutionY colorTexture zTexture context

Full Usage: Attachment.updateShadowTextureArrayAttachmentsSize resolutionX resolutionY colorTexture zTexture context

Parameters:

Update size of shadow texture array attachments.

resolutionX : int
resolutionY : int
colorTexture : Texture
zTexture : Texture
context : VulkanContext

Attachment.updateToneMappingAttachmentsSize resolutionX resolutionY toneMapping context

Full Usage: Attachment.updateToneMappingAttachmentsSize resolutionX resolutionY toneMapping context

Parameters:

Update size of tone-mapping attachments.

resolutionX : int
resolutionY : int
toneMapping : Texture
context : VulkanContext

Type something to start searching.