Header menu logo Nu

Framebuffer Module

Functions and values

Function or value Description

Framebuffer.DestroyColorBuffers (color, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyColorBuffers (color, renderbuffer, framebuffer)

Parameters:
    color : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy color buffers.

color : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyColoringBuffers (color, depth, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyColoringBuffers (color, depth, renderbuffer, framebuffer)

Parameters:
    color : Texture
    depth : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy coloring buffers.

color : Texture
depth : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyEnvironmentFilterBuffers (environmentFilter, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyEnvironmentFilterBuffers (environmentFilter, renderbuffer, framebuffer)

Parameters:
    environmentFilter : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy environment filter buffers.

environmentFilter : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyFilterBilateralDownSampleBuffers (downSample, upSample, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyFilterBilateralDownSampleBuffers (downSample, upSample, renderbuffer, framebuffer)

Parameters:
    downSample : Texture
    upSample : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy filter bilateral down-sample buffers.

downSample : Texture
upSample : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyFilterBloomSampleBuffers (bloomSamples, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyFilterBloomSampleBuffers (bloomSamples, renderbuffer, framebuffer)

Parameters:
    bloomSamples : Texture array
    renderbuffer : uint32
    framebuffer : uint32

Destroy filter bloom sample buffers.

bloomSamples : Texture array
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyFilterBox1dBuffers (filterBoxBlurTexture, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyFilterBox1dBuffers (filterBoxBlurTexture, renderbuffer, framebuffer)

Parameters:
    filterBoxBlurTexture : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy filter box 1d buffers.

filterBoxBlurTexture : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyFilterGaussian2dBuffers (filterGaussianTexture, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyFilterGaussian2dBuffers (filterGaussianTexture, renderbuffer, framebuffer)

Parameters:
    filterGaussianTexture : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy filter gaussian 2d buffers.

filterGaussianTexture : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyGeometryBuffers (position, albedo, material, normalPlus, subdermalPlus, scatterPlus, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyGeometryBuffers (position, albedo, material, normalPlus, subdermalPlus, scatterPlus, renderbuffer, framebuffer)

Parameters:

Destroy geometry buffers.

position : Texture
albedo : Texture
material : Texture
normalPlus : Texture
subdermalPlus : Texture
scatterPlus : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyIrradianceBuffers (irradiance, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyIrradianceBuffers (irradiance, renderbuffer, framebuffer)

Parameters:
    irradiance : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy irradiance buffers.

irradiance : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyLightMappingBuffers (lightMapping, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyLightMappingBuffers (lightMapping, renderbuffer, framebuffer)

Parameters:
    lightMapping : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy light mapping buffers.

lightMapping : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyLightingBuffers (lightAccum, fogAccum, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyLightingBuffers (lightAccum, fogAccum, renderbuffer, framebuffer)

Parameters:
    lightAccum : Texture
    fogAccum : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy lighting buffers.

lightAccum : Texture
fogAccum : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyShadowCascadeArrayBuffers (shadowCascadeArray, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyShadowCascadeArrayBuffers (shadowCascadeArray, renderbuffer, framebuffer)

Parameters:
    shadowCascadeArray : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy shadow cascade array buffers.

shadowCascadeArray : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyShadowCascadeFilterBuffers (shadowCascadeFilter, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyShadowCascadeFilterBuffers (shadowCascadeFilter, renderbuffer, framebuffer)

Parameters:
    shadowCascadeFilter : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy shadow cascade filter buffers.

shadowCascadeFilter : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyShadowMapBuffers (shadowMap, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyShadowMapBuffers (shadowMap, renderbuffer, framebuffer)

Parameters:
    shadowMap : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy shadow map buffers.

shadowMap : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroyShadowTextureBuffers (shadowTexture, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroyShadowTextureBuffers (shadowTexture, renderbuffer, framebuffer)

Parameters:
    shadowTexture : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy shadow texture buffers.

shadowTexture : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.DestroySsaoBuffers (ssao, renderbuffer, framebuffer)

Full Usage: Framebuffer.DestroySsaoBuffers (ssao, renderbuffer, framebuffer)

Parameters:
    ssao : Texture
    renderbuffer : uint32
    framebuffer : uint32

Destroy ssao buffers.

ssao : Texture
renderbuffer : uint32
framebuffer : uint32

Framebuffer.TryCreateColorBuffers (resolutionX, resolutionY, filtered, depthAndStencil)

Full Usage: Framebuffer.TryCreateColorBuffers (resolutionX, resolutionY, filtered, depthAndStencil)

Parameters:
    resolutionX : int
    resolutionY : int
    filtered : bool
    depthAndStencil : bool

Returns: Either<string, (Texture * uint32 * uint32)>

Attempt to create general-purpose color buffers with optional linear filters.

resolutionX : int
resolutionY : int
filtered : bool
depthAndStencil : bool
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateColoringBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateColoringBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * Texture * uint32 * uint32)>

Attempt to create coloring buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * Texture * uint32 * uint32)>

Framebuffer.TryCreateEnvironmentFilterBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateEnvironmentFilterBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Create environment filter buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateFilterBilateralDownSampleBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateFilterBilateralDownSampleBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * Texture * uint32 * uint32)>

Create filter bilateral down-sample buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * Texture * uint32 * uint32)>

Framebuffer.TryCreateFilterBloomSampleBuffers (resolutionX, resolutionY, resolutionZ)

Full Usage: Framebuffer.TryCreateFilterBloomSampleBuffers (resolutionX, resolutionY, resolutionZ)

Parameters:
    resolutionX : int
    resolutionY : int
    resolutionZ : int

Returns: Either<string, (Texture[] * uint32 * uint32)>

Create filter bloom sample buffers.

resolutionX : int
resolutionY : int
resolutionZ : int
Returns: Either<string, (Texture[] * uint32 * uint32)>

Framebuffer.TryCreateFilterBox1dBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateFilterBox1dBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Create filter box 1d buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateFilterGaussian2dBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateFilterGaussian2dBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Create filter gaussian 2d buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateGeometryBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateGeometryBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * Texture * Texture * Texture * Texture * Texture * uint32 * uint32)>

Create a geometry buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * Texture * Texture * Texture * Texture * Texture * uint32 * uint32)>

Framebuffer.TryCreateIrradianceBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateIrradianceBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Create irradiance buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateLightMappingBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateLightMappingBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Create light mapping buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateLightingBuffers (resolutionX, resolutionY)

Full Usage: Framebuffer.TryCreateLightingBuffers (resolutionX, resolutionY)

Parameters:
    resolutionX : int
    resolutionY : int

Returns: Either<string, (Texture * Texture * uint32 * uint32)>

Attempt to create lighting buffers.

resolutionX : int
resolutionY : int
Returns: Either<string, (Texture * Texture * uint32 * uint32)>

Framebuffer.TryCreateShadowCascadeArrayBuffers (shadowCascadeResolutionX, shadowCascadeResolutionY, shadowCascadeLevels)

Full Usage: Framebuffer.TryCreateShadowCascadeArrayBuffers (shadowCascadeResolutionX, shadowCascadeResolutionY, shadowCascadeLevels)

Parameters:
    shadowCascadeResolutionX : int
    shadowCascadeResolutionY : int
    shadowCascadeLevels : int

Returns: Either<string, (Texture * uint32 * uint32)>

Attempt to create shadow cascade array buffers.

shadowCascadeResolutionX : int
shadowCascadeResolutionY : int
shadowCascadeLevels : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateShadowCascadeFilterBuffers (shadowResolutionX, shadowResolutionY)

Full Usage: Framebuffer.TryCreateShadowCascadeFilterBuffers (shadowResolutionX, shadowResolutionY)

Parameters:
    shadowResolutionX : int
    shadowResolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Attempt to create shadow cascade filter buffers.

shadowResolutionX : int
shadowResolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateShadowMapBuffers (shadowResolutionX, shadowResolutionY)

Full Usage: Framebuffer.TryCreateShadowMapBuffers (shadowResolutionX, shadowResolutionY)

Parameters:
    shadowResolutionX : int
    shadowResolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Attempt to create shadow map buffers.

shadowResolutionX : int
shadowResolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateShadowTextureBuffers (shadowResolutionX, shadowResolutionY)

Full Usage: Framebuffer.TryCreateShadowTextureBuffers (shadowResolutionX, shadowResolutionY)

Parameters:
    shadowResolutionX : int
    shadowResolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Attempt to create shadow texture buffers.

shadowResolutionX : int
shadowResolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Framebuffer.TryCreateSsaoBuffers (ssaoResolutionX, ssaoResolutionY)

Full Usage: Framebuffer.TryCreateSsaoBuffers (ssaoResolutionX, ssaoResolutionY)

Parameters:
    ssaoResolutionX : int
    ssaoResolutionY : int

Returns: Either<string, (Texture * uint32 * uint32)>

Create ssao buffers.

ssaoResolutionX : int
ssaoResolutionY : int
Returns: Either<string, (Texture * uint32 * uint32)>

Type something to start searching.