Class RenderTargetTexture

A texture that can be used as a render target for off-screen rendering. This class extends AbstractTexture and implements IRenderable to provide functionality for rendering to texture, which is commonly used for post-processing effects, shadow mapping, and other advanced rendering techniques.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

__canvasContext? __format __hasTransparentPixels __height __htmlCanvasElement? __htmlImageElement? __img? __internalFormat __isTextureReady __level __mipLevelCount __name __startedToLoad __type __uri? __width _recommendedTextureSampler? _samplerResourceUid _tags _textureResourceUid _textureViewAsRenderTargetResourceUid _textureViewResourceUid InvalidObjectUID currentMaxObjectCount

Accessors

_fbo fbo height htmlCanvasElement htmlImageElement isTextureReady isTransparent name objectUID startedToLoad textureUID uniqueName uri width

Methods

_copyFrom create createCubeTextureViewAsRenderTarget createInternalCanvasContext destroy3DAPIResources downloadTexturePixelData generateMipmaps getHeightAtMipLevel getImageData getPixelAs getPixelAsArray getPixelValueAt getTag getTagValue getTextureDataFloat getTexturePixelData getWidthAtMipLevel hasTag matchTag matchTags matchTagsAsFreeStrings removeTag resize setPixel setPixelAtChannel tryToSetTag tryToSetUniqueName unregister validateTagString _reset getRnObject getRnObjectByName searchByTag

Constructors

constructor

Properties

Protected Optional__canvasContext

__canvasContext?: CanvasRenderingContext2D

Protected__format

__format: EnumIO = PixelFormat.RGBA

Protected__hasTransparentPixels

__hasTransparentPixels: boolean = false

Protected__height

__height: number = 0

Protected Optional__htmlCanvasElement

__htmlCanvasElement?: HTMLCanvasElement

Protected Optional__htmlImageElement

__htmlImageElement?: HTMLImageElement

Protected Optional__img

__img?: HTMLImageElement

Protected__internalFormat

__internalFormat: TextureFormatEnum = TextureFormat.RGBA8

Protected__isTextureReady

__isTextureReady: boolean = false

Protected__level

__level: number = 0

Protected__mipLevelCount

__mipLevelCount: number = 1

Protected__name

__name: string = 'untitled'

Protected__startedToLoad

__startedToLoad: boolean = false

Protected__type

__type: ComponentTypeEnum = ComponentType.UnsignedByte

Protected Optional__uri

__uri?: string

Protected__width

__width: number = 0

Optional_recommendedTextureSampler

_recommendedTextureSampler?: Sampler

_samplerResourceUid

_samplerResourceUid: number = -1

_tags

_tags: RnTags = {}

Collection of tags associated with this object

_textureResourceUid

_textureResourceUid: number = -1

The unique identifier for the underlying texture resource

_textureViewAsRenderTargetResourceUid

_textureViewAsRenderTargetResourceUid: number = -1

The unique identifier for the texture view used as a render target

_textureViewResourceUid

_textureViewResourceUid: number = -1

The unique identifier for the texture view resource

Static ReadonlyInvalidObjectUID

InvalidObjectUID: -1 = -1

Invalid object UID constant

StaticcurrentMaxObjectCount

currentMaxObjectCount: number = 0

Current maximum object count for UID generation

Accessors

_fbo

fbo

height

htmlCanvasElement

  • get htmlCanvasElement(): HTMLCanvasElement

  • Gets or creates an HTML canvas element with the texture content. If an image element exists, it will be drawn onto the canvas.

    Returns HTMLCanvasElement

    The HTML canvas element containing the texture data

htmlImageElement

  • get htmlImageElement(): undefined | HTMLImageElement

  • Gets the HTML image element associated with this texture.

    Returns undefined | HTMLImageElement

    The HTML image element or undefined if not available

isTextureReady

  • get isTextureReady(): boolean

  • Checks if the texture is ready for use.

    Returns boolean

    True if the texture is ready, false otherwise

isTransparent

  • get isTransparent(): boolean

  • Checks if the texture contains transparent pixels.

    Returns boolean

    True if the texture has transparency, false otherwise

name

objectUID

  • get objectUID(): number

  • Gets the unique object identifier

    Returns number

    The object's UID

startedToLoad

  • get startedToLoad(): boolean

  • Checks if the texture has started loading.

    Returns boolean

    True if loading has started, false otherwise

textureUID

uniqueName

  • get uniqueName(): string

  • Gets the unique name of this object

    Returns string

    The unique name string

uri

  • get uri(): undefined | string

  • Gets the URI/URL of the texture source.

    Returns undefined | string

    The texture URI or undefined if not set

width

Methods

_copyFrom

create

  • create(params): void

  • Creates and initializes the render target texture with the specified parameters.

    Parameters

    • params: {
          format: TextureFormatEnum;
          height: number;
          mipLevelCount?: number;
          width: number;
      }

      Configuration object for the render target texture

      • format: TextureFormatEnum

        Internal format of the texture

      • height: number

        Height of the texture in pixels

      • OptionalmipLevelCount?: number

        Number of mip levels to generate (optional, defaults to full mip chain)

      • width: number

        Width of the texture in pixels

    Returns void

createCubeTextureViewAsRenderTarget

  • createCubeTextureViewAsRenderTarget(faceIdx, mipLevel): void

  • Creates a cube texture view as a render target for the specified face and mip level. This method is currently not implemented and serves as a placeholder for future functionality.

    Parameters

    • faceIdx: number

      Index of the cube face (0-5)

    • mipLevel: number

      Mip level to create the view for

    Returns void

createInternalCanvasContext

destroy3DAPIResources

downloadTexturePixelData

  • downloadTexturePixelData(): Promise<void>

  • Downloads the texture pixel data as a PNG image file. This method creates a canvas, draws the texture data to it, and triggers a download of the resulting image.

    Returns Promise<void>

generateMipmaps

  • generateMipmaps(): void

  • Generates mipmaps for the render target texture. Mipmaps are pre-calculated, optimized sequences of images that accompany a main texture, intended to increase rendering speed and reduce aliasing artifacts.

    Returns void

getHeightAtMipLevel

getImageData

  • getImageData(x, y, width, height): ImageData

  • Retrieves image data from a rectangular region of the texture. Creates an internal canvas context if one doesn't exist.

    Parameters

    • x: number

      The x-coordinate of the top-left corner

    • y: number

      The y-coordinate of the top-left corner

    • width: number

      The width of the region

    • height: number

      The height of the region

    Returns ImageData

    ImageData object containing the pixel data

getPixelAs

  • getPixelAs(x, y, typeClass): any

  • Gets a single pixel value at the specified coordinates as a specific type. Supports various color and vector types for different use cases.

    Parameters

    • x: number

      The x-coordinate of the pixel

    • y: number

      The y-coordinate of the pixel

    • typeClass:
          | typeof Vector3
          | typeof Vector4
          | typeof MutableVector3
          | typeof MutableVector4
          | typeof ColorRgb
          | typeof ColorRgba

      The class type to return the pixel as (ColorRgb, ColorRgba, Vector3, etc.)

    Returns any

    An instance of the specified type containing the pixel data

getPixelAsArray

  • getPixelAsArray(x, y): Uint8ClampedArray

  • Gets the pixel data at the specified coordinates as a raw Uint8ClampedArray. This provides direct access to the RGBA values as 8-bit integers.

    Parameters

    • x: number

      The x-coordinate of the pixel

    • y: number

      The y-coordinate of the pixel

    Returns Uint8ClampedArray

    A Uint8ClampedArray containing the RGBA pixel data

getPixelValueAt

  • getPixelValueAt(x, y, argByteArray?): Promise<Vector4>

  • Gets the pixel value at the specified coordinates. The coordinate system has its origin at the bottom-left corner.

    Parameters

    • x: number

      Horizontal pixel position (0 is left edge)

    • y: number

      Vertical pixel position (0 is bottom edge)

    • OptionalargByteArray: Uint8Array

      Optional pre-fetched pixel data array to avoid redundant GPU reads

    Returns Promise<Vector4>

    A promise that resolves to a Vector4 containing the RGBA pixel values (0-255)

getTag

getTagValue

  • getTagValue(tagName): any

  • Retrieves the value associated with a specific tag name

    Parameters

    • tagName: string

      The name of the tag whose value to retrieve

    Returns any

    The tag value, or undefined if the tag doesn't exist

getTextureDataFloat

getTexturePixelData

  • getTexturePixelData(): Promise<Uint8Array>

  • Retrieves the pixel data from the render target texture. This operation reads back the texture data from GPU memory to CPU memory.

    Returns Promise<Uint8Array>

    A promise that resolves to a Uint8Array containing the pixel data

getWidthAtMipLevel

hasTag

  • hasTag(tagName): boolean

  • Checks whether this object has a tag with the specified name

    Parameters

    • tagName: string

      The name of the tag to check for

    Returns boolean

    True if the tag exists (value is not null/undefined), false otherwise

matchTag

  • matchTag(tagName, tagValue): boolean

  • Checks if this object has a tag with the specified name and value

    Parameters

    • tagName: string

      The tag name to match

    • tagValue: string

      The tag value to match

    Returns boolean

    True if the object has a matching tag, false otherwise

matchTags

  • matchTags(tags): boolean

  • Checks if this object has all the specified tags with exactly matching values

    Parameters

    • tags: RnTags

      Object containing tag names as keys and expected values

    Returns boolean

    True if all specified tags exist with matching values, false otherwise

matchTagsAsFreeStrings

  • matchTagsAsFreeStrings(stringArray): boolean

  • Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.

    Parameters

    • stringArray: string[]

      Array of strings that must all be present in the combined tag string

    Returns boolean

    True if all strings are found in the combined tag string, false otherwise

removeTag

resize

  • resize(width, height): void

  • Resizes the render target texture to the specified dimensions. This operation destroys the existing resources and creates new ones.

    Parameters

    • width: number

      New width in pixels

    • height: number

      New height in pixels

    Returns void

setPixel

setPixelAtChannel

  • setPixelAtChannel(x, y, channelIdx, value): void

  • Sets a specific channel value for a pixel at the given coordinates. Useful for modifying individual color channels (R, G, B, A).

    Parameters

    • x: number

      The x-coordinate of the pixel

    • y: number

      The y-coordinate of the pixel

    • channelIdx: number

      The channel index (0=R, 1=G, 2=B, 3=A)

    • value: number

      The new value for the channel (0-255)

    Returns void

tryToSetTag

  • tryToSetTag(tag): boolean

  • Attempts to set a tag on this object. If the tag already exists, it will be replaced.

    Parameters

    • tag: Tag

      The tag object containing the name and value to set

    Returns boolean

    True if the tag was successfully set, false if the tag name contains invalid characters

tryToSetUniqueName

  • tryToSetUniqueName(name, toAddNameIfConflict): boolean

  • Attempts to set a unique name for this object

    Parameters

    • name: string

      The desired unique name

    • toAddNameIfConflict: boolean

      If true, appends UID to make name unique when conflicts occur; if false, fails on conflict

    Returns boolean

    True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false

unregister

validateTagString

  • validateTagString(val): boolean

  • Validates that a tag string contains only allowed characters (alphanumeric and underscore)

    Parameters

    • val: string

      The string to validate

    Returns boolean

    True if the string contains only valid characters, false if it contains invalid characters

Static_reset

StaticgetRnObject

StaticgetRnObjectByName

StaticsearchByTag

  • searchByTag(tag, value): undefined | WeakRef<RnObject>

  • Searches for the first object that has a specific tag with the given value

    Parameters

    • tag: string

      The tag name to search for

    • value: string

      The tag value to match

    Returns undefined | WeakRef<RnObject>

    WeakRef to the first matching object, or undefined if not found

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods