Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ThinRenderTargetTexture

This is a tiny helper class to wrap a RenderTargetWrapper in a texture usable as the input of an effect.

Hierarchy

Implements

Index

Constructors

constructor

  • Instantiates a new ThinRenderTargetTexture. Tiny helper class to wrap a RenderTargetWrapper in a texture. This can be used as an internal texture wrapper in ThinEngine to benefit from the cache and to hold on the associated RTT

    Parameters

    Returns ThinRenderTargetTexture

Properties

anisotropicFilteringLevelSearch playground for anisotropicFilteringLevel

anisotropicFilteringLevel: number

With compliant hardware and browser (supporting anisotropic filtering) this defines the level of anisotropic filtering in the texture. The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.

delayLoadStateSearch playground for delayLoadState

delayLoadState: number

Define the current state of the loading sequence when in delayed load mode.

wrapRSearch playground for wrapR

wrapR: number
ValueTypeDescription
0CLAMP_ADDRESSMODE
1WRAP_ADDRESSMODE
2MIRROR_ADDRESSMODE

Accessors

coordinatesMode

  • get coordinatesMode(): number
  • How a texture is mapped. Unused in thin texture mode.

    Returns number

is2DArray

  • get is2DArray(): boolean
  • set is2DArray(value: boolean): any
  • Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.

    Returns boolean

  • Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.

    Parameters

    • value: boolean

    Returns any

is3D

  • get is3D(): boolean
  • set is3D(value: boolean): any
  • Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.

    Returns boolean

  • Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.

    Parameters

    • value: boolean

    Returns any

isCube

  • get isCube(): boolean
  • set isCube(value: boolean): any
  • Define if the texture is a cube texture or if false a 2d texture.

    Returns boolean

  • Define if the texture is a cube texture or if false a 2d texture.

    Parameters

    • value: boolean

    Returns any

renderTarget

  • Gets the render target wrapper associated with this render target

    Returns Nullable<RenderTargetWrapper>

samplingMode

  • get samplingMode(): number
  • Get the current sampling mode associated with the texture.

    Returns number

wrapU

  • get wrapU(): number
  • set wrapU(value: number): any
  • ValueTypeDescription
    0CLAMP_ADDRESSMODE
    1WRAP_ADDRESSMODE
    2MIRROR_ADDRESSMODE

    Returns number

  • ValueTypeDescription
    0CLAMP_ADDRESSMODE
    1WRAP_ADDRESSMODE
    2MIRROR_ADDRESSMODE

    Parameters

    • value: number

    Returns any

wrapV

  • get wrapV(): number
  • set wrapV(value: number): any
  • ValueTypeDescription
    0CLAMP_ADDRESSMODE
    1WRAP_ADDRESSMODE
    2MIRROR_ADDRESSMODE

    Returns number

  • ValueTypeDescription
    0CLAMP_ADDRESSMODE
    1WRAP_ADDRESSMODE
    2MIRROR_ADDRESSMODE

    Parameters

    • value: number

    Returns any

Methods

delayLoadSearch playground for delayLoad

  • delayLoad(): void
  • Triggers the load sequence in delayed load mode.

    Returns void

disposeSearch playground for dispose

  • dispose(disposeOnlyFramebuffers?: boolean): void
  • Dispose the texture and release its associated resources.

    Parameters

    • Optional disposeOnlyFramebuffers: boolean

    Returns void

getBaseSizeSearch playground for getBaseSize

  • Get the base size of the texture. It can be different from the size if the texture has been resized for POT for instance

    Returns ISize

    the base size

getClassNameSearch playground for getClassName

  • getClassName(): string
  • Get the class name of the texture.

    Returns string

    "ThinRenderTargetTexture"

getInternalTextureSearch playground for getInternalTexture

getSizeSearch playground for getSize

  • Get the size of the texture.

    Returns ISize

    the texture size.

isReadySearch playground for isReady

  • isReady(): boolean
  • Get if the texture is ready to be used (downloaded, converted, mip mapped...).

    Returns boolean

    true if fully ready

releaseInternalTextureSearch playground for releaseInternalTexture

  • releaseInternalTexture(): void
  • Release and destroy the underlying lower level texture aka internalTexture.

    Returns void

resizeSearch playground for resize

  • Resize the texture to a new desired size. Be careful as it will recreate all the data in the new texture.

    Parameters

    • size: RenderTargetTextureSize

      Define the new size. It can be:

      • a number for squared texture,
      • an object containing { width: number, height: number }

    Returns void

updateSamplingModeSearch playground for updateSamplingMode

  • updateSamplingMode(samplingMode: number): void
  • Update the sampling mode of the texture. Default is Trilinear mode.

    ValueTypeDescription
    1NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEARNearest is: mag = nearest, min = nearest, mip = linear
    2BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEARESTBilinear is: mag = linear, min = linear, mip = nearest
    3TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEARTrilinear is: mag = linear, min = linear, mip = linear
    4NEAREST_NEAREST_MIPNEAREST
    5NEAREST_LINEAR_MIPNEAREST
    6NEAREST_LINEAR_MIPLINEAR
    7NEAREST_LINEAR
    8NEAREST_NEAREST
    9LINEAR_NEAREST_MIPNEAREST
    10LINEAR_NEAREST_MIPLINEAR
    11LINEAR_LINEAR
    12LINEAR_NEAREST

    mag: magnification filter (close to the viewer) min: minification filter (far from the viewer) mip: filter used between mip map levels

    Parameters

    • samplingMode: number

      Define the new sampling mode of the texture

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static property
  • Static method