-
Notifications
You must be signed in to change notification settings - Fork 9
core.Class.QuadRenderer
@monogrid/gainmap-js / core / QuadRenderer
Defined in: src/core/QuadRenderer.ts:147
Utility class used for rendering a texture with a material
TType extends TextureDataType
TMaterial extends Material
new QuadRenderer<
TType,TMaterial>(options):QuadRenderer<TType,TMaterial>
Defined in: src/core/QuadRenderer.ts:165
Constructs a new QuadRenderer
QuadRendererOptions<TType, TMaterial>
Parameters for this QuadRenderer
QuadRenderer<TType, TMaterial>
get colorSpace():
ColorSpace
Defined in: src/core/QuadRenderer.ts:408
ColorSpace
get height():
number
Defined in: src/core/QuadRenderer.ts:378
Height of the texture
number
set height(
value):void
Defined in: src/core/QuadRenderer.ts:379
number
void
get material():
TMaterial
Defined in: src/core/QuadRenderer.ts:403
The Material used.
TMaterial
get renderer():
WebGLRenderer
Defined in: src/core/QuadRenderer.ts:387
The renderer used
WebGLRenderer
get renderTarget():
WebGLRenderTarget<Texture>
Defined in: src/core/QuadRenderer.ts:392
The WebGLRenderTarget used.
WebGLRenderTarget<Texture>
set renderTarget(
value):void
Defined in: src/core/QuadRenderer.ts:393
WebGLRenderTarget
void
get type():
TType
Defined in: src/core/QuadRenderer.ts:407
TType
get width():
number
Defined in: src/core/QuadRenderer.ts:369
Width of the texture
number
set width(
value):void
Defined in: src/core/QuadRenderer.ts:370
number
void
dispose(
disposeRenderTarget?):void
Defined in: src/core/QuadRenderer.ts:344
Will dispose of all assets used by this renderer.
boolean
will dispose of the renderTarget which will not be usable later
set this to true if you passed the renderTarget.texture to a PMREMGenerator
or are otherwise done with it.
void
const loader = new HDRJPGLoader(renderer)
const result = await loader.loadAsync('gainmap.jpeg')
const mesh = new Mesh(geometry, new MeshBasicMaterial({ map: result.renderTarget.texture }) )
// DO NOT dispose the renderTarget here,
// it is used directly in the material
result.dispose()const loader = new HDRJPGLoader(renderer)
const pmremGenerator = new PMREMGenerator( renderer );
const result = await loader.loadAsync('gainmap.jpeg')
const envMap = pmremGenerator.fromEquirectangular(result.renderTarget.texture)
const mesh = new Mesh(geometry, new MeshStandardMaterial({ envMap }) )
// renderTarget can be disposed here
// because it was used to generate a PMREM texture
result.dispose(true)disposeOnDemandRenderer():
void
Defined in: src/core/QuadRenderer.ts:306
If using a disposable renderer, it will dispose it.
void
render():
void
Defined in: src/core/QuadRenderer.ts:248
Renders the input texture using the specified material
void
toArray():
TextureDataTypeToBufferType<TType>
Defined in: src/core/QuadRenderer.ts:265
Obtains a Buffer containing the rendered texture.
TextureDataTypeToBufferType<TType>
a TypedArray containing RGBA values from this renderer
Error if the browser cannot read pixels from this RenderTarget type.
toDataTexture(
options?):DataTexture
Defined in: src/core/QuadRenderer.ts:279
Performs a readPixel operation in the renderTarget and returns a DataTexture containing the read data
options
DataTexture
staticinstantiateRenderer():WebGLRenderer
Defined in: src/core/QuadRenderer.ts:235
Instantiates a temporary renderer
WebGLRenderer