ImageBuffer

Image buffer. Draw a single image. Optionally interpolate.

Hierarchy

Buffer
- ImageBuffer

Index

Constructors

constructor

Accessors

Constructors

constructor

new ImageBuffer(data: ImageBufferData, params: ImageBufferParameters): ImageBuffer

Overrides Buffer.constructor
- Defined in src/buffer/image-buffer.ts:67
Parameters
- data: ImageBufferData
  
  buffer data
- params: ImageBufferParameters
Returns ImageBuffer

Properties

alwaysTransparent

alwaysTransparent: boolean = true

dynamic

dynamic: boolean = true

fragmentShader

fragmentShader: string = "Image.frag"

geometry

geometry: BufferGeometry = new BufferGeometry()

group

group: Group = new Group()

hasWireframe

hasWireframe: boolean = false

indexVersion

indexVersion: number = 0

isImpostor

isImpostor: boolean = false

isLine

isLine: boolean = false

isPoint

isPoint: boolean = false

isSurface

isSurface: boolean = false

isText

isText: boolean = false

material

material: ShaderMaterial

parameterTypes

parameterTypes: { filter: object } & { matrix: {}; background: object; clipCenter: object; clipNear: object; clipRadius: object; depthWrite: object; diffuse: object; diffuseInterior: object; flatShaded: object; interiorColor: object; interiorDarkening: object; metalness: object; opacity: object; opaqueBack: object; roughness: object; side: object; useInteriorColor: object; wireframe: object } = ImageBufferParameterTypes

parameters

parameters: ImageBufferParameters

Optional picking

picking: Picker

pickingGroup

pickingGroup: Group = new Group()

pickingMaterial

pickingMaterial: ShaderMaterial

pickingTex

pickingTex: DataTexture

pickingUniforms

pickingUniforms: Uniforms

tex

tex: DataTexture

uniforms

uniforms: Uniforms

vertexShader

vertexShader: string = "Image.vert"

visible

visible: boolean = true

Optional wireframeGeometry

wireframeGeometry: BufferGeometry

wireframeGroup

wireframeGroup: Group = new Group()

Optional wireframeIndex

wireframeIndex: Uint32Array | Uint16Array

wireframeIndexCount

wireframeIndexCount: number = 0

wireframeIndexVersion

wireframeIndexVersion: number = -1

wireframeMaterial

wireframeMaterial: ShaderMaterial

Accessors

attributeSize

get attributeSize(): number

Inherited from Buffer.attributeSize
- Defined in src/buffer/buffer.ts:238
Returns number

defaultParameters

get defaultParameters(): { filter: "linear" | "nearest" | "cubic-bspline" | "cubic-catmulrom" | "cubic-mitchell"; forceTransparent: true } & { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }

Overrides Buffer.defaultParameters
- Defined in src/buffer/image-buffer.ts:58
Returns { filter: "linear" | "nearest" | "cubic-bspline" | "cubic-catmulrom" | "cubic-mitchell"; forceTransparent: true } & { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }

matrix

get matrix(): Matrix4
set matrix(m: Matrix4): void

Inherited from Buffer.matrix
- Defined in src/buffer/buffer.ts:226
Returns Matrix4
Inherited from Buffer.matrix
- Defined in src/buffer/buffer.ts:223
Parameters
- m: Matrix4
Returns void

pickable

get pickable(): boolean

Inherited from Buffer.pickable
- Defined in src/buffer/buffer.ts:242
Returns boolean

size

get size(): number

Inherited from Buffer.size
- Defined in src/buffer/buffer.ts:234
Returns number

transparent

get transparent(): boolean

Inherited from Buffer.transparent
- Defined in src/buffer/buffer.ts:230
Returns boolean

Methods

_getMesh

_getMesh(materialName: BufferMaterials): LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

Inherited from Buffer._getMesh
- Defined in src/buffer/buffer.ts:473
Parameters
- materialName: BufferMaterials
Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

addAttributes

addAttributes(attributes: {}): void

Inherited from Buffer.addAttributes
- Defined in src/buffer/buffer.ts:579
Parameters
- attributes: {}
  - [k: string]: _BufferAttribute
Returns void

addUniforms

addUniforms(uniforms: Uniforms): void

Inherited from Buffer.addUniforms
- Defined in src/buffer/buffer.ts:569
Parameters
- uniforms: Uniforms
Returns void

dispose

dispose(): void

Inherited from Buffer.dispose
- Defined in src/buffer/buffer.ts:851
Free buffer resources

Returns void

getDefines

getDefines(type: BufferTypes): {}

Overrides Buffer.getDefines
- Defined in src/buffer/image-buffer.ts:115
Parameters
- type: BufferTypes
Returns {}

getFragmentShader

getFragmentShader(type?: BufferTypes): string

Inherited from Buffer.getFragmentShader
- Defined in src/buffer/buffer.ts:527
Parameters
- Optional type: BufferTypes
Returns string

getMesh

getMesh(): LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

Inherited from Buffer.getMesh
- Defined in src/buffer/buffer.ts:495
Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

getParameters

getParameters(): { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }

Inherited from Buffer.getParameters
- Defined in src/buffer/buffer.ts:565
Returns { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }
- background: boolean
- clipCenter: Vector3
- clipNear: number
- clipRadius: number
- depthWrite: boolean
- diffuse: number
- diffuseInterior: boolean
- disablePicking: boolean
- flatShaded: boolean
- forceTransparent: boolean
- interiorColor: number
- interiorDarkening: number
- matrix: Matrix4
- metalness: number
- opacity: number
- opaqueBack: boolean
- roughness: number
- side: "double" | "front" | "back"
- sortParticles: boolean
- useInteriorColor: boolean
- wireframe: boolean

getPickingMesh

getPickingMesh(): LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

Inherited from Buffer.getPickingMesh
- Defined in src/buffer/buffer.ts:515
Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

getRenderOrder

getRenderOrder(): number

Inherited from Buffer.getRenderOrder
- Defined in src/buffer/buffer.ts:457
Returns number

getShader

getShader(name: string, type?: BufferTypes): string

Inherited from Buffer.getShader
- Defined in src/buffer/buffer.ts:519
Parameters
- name: string
- Optional type: BufferTypes
Returns string

getVertexShader

getVertexShader(type?: BufferTypes): string

Inherited from Buffer.getVertexShader
- Defined in src/buffer/buffer.ts:523
Parameters
- Optional type: BufferTypes
Returns string

getWireframeMesh

getWireframeMesh(): LineSegments<BufferGeometry, ShaderMaterial>

Inherited from Buffer.getWireframeMesh
- Defined in src/buffer/buffer.ts:499
Returns LineSegments<BufferGeometry, ShaderMaterial>

initIndex

initIndex(index: Uint32Array | Uint16Array): void

Inherited from Buffer.initIndex
- Defined in src/buffer/buffer.ts:252
Parameters
- index: Uint32Array | Uint16Array
Returns void

makeMaterial

makeMaterial(): void

Overrides Buffer.makeMaterial
- Defined in src/buffer/image-buffer.ts:152
Returns void

makeWireframeGeometry

makeWireframeGeometry(): void

Inherited from Buffer.makeWireframeGeometry
- Defined in src/buffer/buffer.ts:319
Returns void

makeWireframeIndex

makeWireframeIndex(): void

Inherited from Buffer.makeWireframeIndex
- Defined in src/buffer/buffer.ts:337
Returns void

setAttributes

setAttributes(data: any): void

Inherited from Buffer.setAttributes
- Defined in src/buffer/buffer.ts:705
Sets buffer attributes

example

var buffer = new Buffer(); buffer.setAttributes({ attrName: attrData });

Parameters
- data: any
  
  An object where the keys are the attribute names and the values are the attribute data.
Returns void

setMatrix

setMatrix(m: Matrix4): void

Inherited from Buffer.setMatrix
- Defined in src/buffer/buffer.ts:246
Parameters
- m: Matrix4
Returns void

setParameters

setParameters(params: Partial<BufferParameters>): void

Inherited from Buffer.setParameters
- Defined in src/buffer/buffer.ts:636
Set buffer parameters

Parameters
- params: Partial<BufferParameters>
  
  buffer parameters object
Returns void

setProperties

setProperties(data: any): void

Inherited from Buffer.setProperties
- Defined in src/buffer/buffer.ts:796
Parameters
- data: any
Returns void

setUniforms

setUniforms(data: any): void

Overrides Buffer.setUniforms
- Defined in src/buffer/image-buffer.ts:173
Parameters
- data: any
Returns void

setVisibility

setVisibility(value: boolean): void

Inherited from Buffer.setVisibility
- Defined in src/buffer/buffer.ts:829
Set buffer visibility

Parameters
- value: boolean
  
  visibility value
Returns void

toJSON

toJSON(): any

Inherited from Buffer.toJSON
- Defined in src/buffer/buffer.ts:863
Customize JSON serialization to avoid circular references

Returns any

updateRenderOrder

updateRenderOrder(): void

Inherited from Buffer.updateRenderOrder
- Defined in src/buffer/buffer.ts:601
Returns void

updateShader

updateShader(): void

Inherited from Buffer.updateShader
- Defined in src/buffer/buffer.ts:613
Returns void

updateTexture

updateTexture(): void

- Defined in src/buffer/image-buffer.ts:133
Returns void

updateWireframeIndex

updateWireframeIndex(): void

Inherited from Buffer.updateWireframeIndex
- Defined in src/buffer/buffer.ts:435
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: ImageBufferData

params: ImageBufferParameters

Returns ImageBuffer

Properties

alwaysTransparent

dynamic

fragmentShader

geometry

group

hasWireframe

indexVersion

isImpostor

isLine

isPoint

isSurface

isText

material

parameterTypes

parameters

Optional picking

pickingGroup

pickingMaterial

pickingTex

pickingUniforms

tex

uniforms

vertexShader

visible

Optional wireframeGeometry

wireframeGroup

Optional wireframeIndex

wireframeIndexCount

wireframeIndexVersion

wireframeMaterial

Accessors

attributeSize

Returns number

defaultParameters

matrix

Returns Matrix4

Parameters

m: Matrix4

Returns void

pickable

Returns boolean

size

Returns number

transparent

Returns boolean

Methods

_getMesh

Parameters

materialName: BufferMaterials

Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

addAttributes

Parameters

attributes: {}

[k: string]: _BufferAttribute

Returns void

addUniforms

Parameters

uniforms: Uniforms

Returns void

dispose

Returns void

getDefines

Parameters

type: BufferTypes

Returns {}

getFragmentShader

Parameters