rhodonite
    Preparing search index...

    Class RenderTargetTextureCube

    A cube texture that can be used as a render target for rendering operations. This class extends AbstractTexture and implements IRenderable to provide cube map rendering capabilities with support for multiple mip levels.

    const cubeTexture = new RenderTargetTextureCube();
    cubeTexture.create({
      width: 512,
      height: 512,
      format: TextureFormat.RGBA8
    });

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

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

    Accessors

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

    Methods

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

    Constructors

    Properties

    Protected Optional__canvasContext

    __canvasContext?: CanvasRenderingContext2D

    Protected__engine

    __engine: Engine

    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__isDummyTexture

    __isDummyTexture: boolean = false

    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

    hdriFormat: EnumIO = HdriFormat.HDR_LINEAR
    currentMaxObjectCount: number = 0

    Current maximum object count for UID generation

    InvalidObjectUID: -1

    Invalid object UID constant

    Accessors

    _fbo

    • 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

    • get htmlImageElement(): HTMLImageElement | undefined

      Gets the HTML image element associated with this texture.

      Returns HTMLImageElement | undefined

      The HTML image element or undefined if not available

    • get isDummyTexture(): boolean

      Checks whether this texture is marked as a dummy (placeholder) texture.

      Returns boolean

      True if the texture is marked as dummy, false otherwise

    • get isTextureReady(): boolean

      Checks if the texture is ready for use.

      Returns boolean

      True if the texture is ready, false otherwise

    • get isTransparent(): boolean

      Checks if the texture contains transparent pixels.

      Returns boolean

      True if the texture has transparency, false otherwise

    • get objectUID(): number

      Gets the unique object identifier

      Returns number

      The object's UID

    • get startedToLoad(): boolean

      Checks if the texture has started loading.

      Returns boolean

      True if loading has started, false otherwise

    • get uniqueName(): string

      Gets the unique name of this object

      Returns string

      The unique name string

    • get uri(): string | undefined

      Gets the URI/URL of the texture source.

      Returns string | undefined

      The texture URI or undefined if not set

    Methods

    _copyFrom

    • Creates and initializes the cube render target texture with the specified parameters. This method sets up the internal texture resources and calculates mip levels if not provided.

      Parameters

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

        Configuration object for texture creation

        • format: TextureFormatEnum

          Internal texture format to use

        • height: number

          Height of each cube face in pixels (should equal width for proper cube)

        • OptionalmipLevelCount?: number

          Optional number of mip levels. If not provided, calculates automatically

        • width: number

          Width of each cube face in pixels

      Returns void

      cubeTexture.create({
        width: 1024,
        height: 1024,
        mipLevelCount: 10,
        format: TextureFormat.RGBA16F
      });

    • Creates an HTMLCanvasElement containing the texture data read from GPU. This is useful for displaying texture previews when htmlImageElement is not available. Works with both WebGL and WebGPU backends.

      Returns Promise<HTMLCanvasElement | undefined>

      Promise resolving to an HTMLCanvasElement with the texture content, or undefined if the texture is not ready or reading fails

    • Creates a texture view for a specific cube face and mip level that can be used as a render target. This method is WebGPU-specific and allows rendering to individual faces of the cube texture.

      Parameters

      • faceIdx: number

        Index of the cube face (0-5: +X, -X, +Y, -Y, +Z, -Z)

      • mipLevel: number

        Mip level to create the view for (0 = base level)

      Returns void

      This method only works when using the WebGPU rendering backend. For WebGL, face-specific rendering is handled differently through framebuffer operations.

    • Destroys all 3D API resources associated with this texture. This method releases GPU memory and invalidates the texture resource UID.

      Returns boolean

      Always returns true to indicate successful cleanup

      After calling this method, the texture cannot be used until recreated. This is automatically called during resize operations.

    • Generates mipmaps for the cube texture using the graphics API. This method creates a complete mipmap chain for all faces of the cube texture, which is useful for proper filtering and rendering quality.

      Returns void

      This operation should be called after rendering to the base level (mip 0) to ensure proper mipmap generation from the rendered content.

    • 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

    • 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

    • Retrieves a complete tag object (name and value) for the specified tag name

      Parameters

      • tagName: string

        The name of the tag to retrieve

      Returns Tag

      A Tag object containing the name and value

    • 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

    • Reads the texture data from GPU and returns it as a Uint8Array. This method works with both WebGL and WebGPU backends. Useful for textures that don't have an associated htmlImageElement (e.g., dummy textures).

      Returns Promise<Uint8Array<ArrayBufferLike> | undefined>

      Promise resolving to the pixel data as a Uint8Array in RGBA format, or undefined if the texture is not ready or reading fails

    • 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

    • 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

    • 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

    • 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

    • Resizes the cube texture to new dimensions. This method destroys the current texture resources and recreates them with the specified width and height.

      Parameters

      • width: number

        New width for each cube face in pixels

      • height: number

        New height for each cube face in pixels

      Returns void

      All existing texture content will be lost during the resize operation. The mip level count will be recalculated based on the new dimensions.

    • Marks the texture as ready for use. This method sets the internal ready state flag to indicate that the texture has been properly initialized and can be used for rendering.

      Returns void

      This is typically called internally after successful texture creation and resource allocation.

    • 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

    • 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

    • 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

    • 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

    • 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 WeakRef<RnObject> | undefined

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods