Class RenderTarget`Abstract`

Render target is a frame buffer or a texture that the render system renders the scene to.

Note

Sim thread unless noted otherwise. Retrieve core implementation from GetCore() for core thread only functionality.

Hierarchy (View Summary)

RenderTarget
- RenderTexture
- RenderWindow

Index

Constructors

Accessors

dotsPerInch dpiScale gammaCorrection height isWindow priority sampleCount width

Constructors

`Protected`constructor

new RenderTarget(isInternalConstructor?: boolean): RenderTarget
Parameters
- OptionalisInternalConstructor: boolean
Returns RenderTarget

Overrides FrameworkObject.constructor

Accessors

dotsPerInch

get dotsPerInch(): number

Returns the DPI scale factor of the render texture.

Returns number

dpiScale

get dpiScale(): number

Returns the DPI scale factor of the render texture.

Returns number

gammaCorrection

get gammaCorrection(): boolean

Returns boolean

height

get height(): number

Height of the render target, in pixels.

Returns number

isWindow

get isWindow(): boolean

Returns true if the render target is a window.

Returns boolean

priority

get priority(): number

Controls in what order is the render target rendered to compared to other render targets. Targets with higher priority will be rendered before ones with lower priority.

Returns number
set priority(value: number): void
Parameters
- value: number
Returns void

sampleCount

get sampleCount(): number

Controls how many samples are used for multisampling. (0 or 1 if multisampling is not used).

Returns number

width

get width(): number

Width of the render target, in pixels.

Returns number