ConstructorOptions

sealed interface ConstructorOptions(source)

Properties

Link copied to clipboard
abstract var clearColor: Color?

The color to clear the output texture to. Default value - Color.BLACK

Link copied to clipboard
abstract var forcePowerOfTwo: Boolean?

Whether or not to force the texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions. Default value - false

Link copied to clipboard
abstract var fragmentShader: String

The fragment shader to use. The default sampler2D uniforms are colorTexture and depthTexture. The color texture is the output of rendering the scene or the previous stage. The depth texture is the output from rendering the scene. The shader should contain one or both uniforms. There is also a vec2 varying named v_textureCoordinates that can be used to sample the textures.

Link copied to clipboard
abstract var name: String?

The unique name of this post-process stage for reference by other stages in a composite. If a name is not supplied, a GUID will be generated. Default value - createGuid()

Link copied to clipboard

The pixel data type of the output texture. Default value - PixelDatatype.UNSIGNED_BYTE

Link copied to clipboard
abstract var pixelFormat: PixelFormat?

The color pixel format of the output texture. Default value - PixelFormat.RGBA

Link copied to clipboard

How to sample the input color texture. Default value - PostProcessStageSampleMode.NEAREST

Link copied to clipboard

The rectangle to use for the scissor test.

Link copied to clipboard
abstract var textureScale: Double?

A number in the range (0.0, 1.0] used to scale the texture dimensions. A scale of 1.0 will render this post-process stage to a texture the size of the viewport. Default value - 1.0

Link copied to clipboard
abstract var uniforms: Any?

An object whose properties will be used to set the shaders uniforms. The properties can be constant values or a function. A constant value can also be a URI, data URI, or HTML element to use as a texture.