Interface Attachment

interface, represents render target Attachment. Subinterface of Image

Hierarchy

BanubaSDK.Image
- Attachment

Index

Methods

asAttachment asCameraTexture asCubemap asSegmentationMask asTextTexture asTexture asVideo asWeightedLut getAttachmentType getClearColor getFilteringMode getHeight getName getType getWidth setClearColor setFilteringMode setHeight setWidth

Methods

asAttachment

asAttachment(): Attachment
cast to Attachment subinterface. May throw.

Returns Attachment

Inherited from Image.asAttachment

asCameraTexture

asCameraTexture(): CameraTexture
cast to CameraTexture subinterface. May throw.

Returns CameraTexture

Inherited from Image.asCameraTexture

asCubemap

asCubemap(): Cubemap
cast to Cubemap subinterface. May throw.

Returns Cubemap

Inherited from Image.asCubemap

asSegmentationMask

asSegmentationMask(): SegmentationMask
cast to SegmentationMask subinterface. May throw.

Returns SegmentationMask

Inherited from Image.asSegmentationMask

asTextTexture

asTextTexture(): TextTexture
cast to TextTexture subinterface. May throw.

Returns TextTexture

Inherited from Image.asTextTexture

asTexture

asTexture(): Texture
cast to Texture subinterface. May throw.

Returns Texture

Inherited from Image.asTexture

asVideo

asVideo(): BanubaSDK.Video
cast to Video subinterface. May throw.

Returns BanubaSDK.Video

Inherited from Image.asVideo

asWeightedLut

asWeightedLut(): WeightedLut
cast to WeightedLut subinterface. May throw.

Returns WeightedLut

Inherited from Image.asWeightedLut

getAttachmentType

getAttachmentType(): AttachmentType
Returns AttachmentType
Attachment type. Can be color, or depth

getClearColor

getClearColor(): Vec3
Returns Vec3
Attachment clear color

getFilteringMode

getFilteringMode(): TextureFilteringMode
Returns TextureFilteringMode
filtering mode

getHeight

getHeight(): number
Returns number
attachment height

getName

getName(): string
Returns string
Image name

Inherited from Image.getName

getType

getType(): ImageType
Returns ImageType
Image type. type of Image subinterface

Inherited from Image.getType

getWidth

getWidth(): number
Returns number
attachment width

setClearColor

setClearColor(color): void
Parameters
- color: Vec3
  
  color. Also implicitly set Attachment load behavior to clear.
Returns void

setFilteringMode

setFilteringMode(value): void
set attachment Texture filtering mode
Parameters
- value: TextureFilteringMode
  
  mode
Returns void

setHeight

setHeight(value): void
set Attachment height
Parameters
- value: number
Returns void

setWidth

setWidth(value): void
set Attachment width
Parameters
- value: number
Returns void