Class FrameBuffer

Hierarchy

RnObject
- FrameBuffer

Constructors

constructor

new FrameBuffer(): FrameBuffer

Overrides RnObject.constructor
- Defined in foundation/renderer/FrameBuffer.ts:24
Returns FrameBuffer

Properties

Private __colorAttachmentMap

__colorAttachmentMap: Map<RenderBufferTargetEnum, IRenderable> = ...

Private __colorAttachments

__colorAttachments: IRenderable[] = []

Private Optional __depthAttachment

__depthAttachment?: IRenderable

Private Optional __depthStencilAttachment

__depthStencilAttachment?: IRenderable

Private Optional __stencilAttachment

__stencilAttachment?: IRenderable

cgApiResourceUid

cgApiResourceUid: number = CGAPIResourceRepository.InvalidCGAPIResourceUid

height

height: number = 0

width

width: number = 0

Static Readonly InvalidObjectUID

InvalidObjectUID: -1 = -1

Static currentMaxObjectCount

currentMaxObjectCount: number = 0

Accessors

colorAttachments

get colorAttachments(): IRenderable[]

- Defined in foundation/renderer/FrameBuffer.ts:32
Returns IRenderable[]

colorAttachmentsRenderBufferTargets

get colorAttachmentsRenderBufferTargets(): RenderBufferTargetEnum[]

- Defined in foundation/renderer/FrameBuffer.ts:28
Returns RenderBufferTargetEnum[]

depthAttachment

get depthAttachment(): undefined | IRenderable

- Defined in foundation/renderer/FrameBuffer.ts:36
Returns undefined | IRenderable

depthStencilAttachment

get depthStencilAttachment(): undefined | IRenderable

- Defined in foundation/renderer/FrameBuffer.ts:44
Returns undefined | IRenderable

framebufferUID

get framebufferUID(): number

- Defined in foundation/renderer/FrameBuffer.ts:79
Returns number

objectUID

get objectUID(): number

Inherited from RnObject.objectUID
- Defined in foundation/core/RnObject.ts:68
Gets the objectUID of the object.

Returns number

stencilAttachment

get stencilAttachment(): undefined | IRenderable

- Defined in foundation/renderer/FrameBuffer.ts:40
Returns undefined | IRenderable

uniqueName

get uniqueName(): string

Inherited from RnObject.uniqueName
- Defined in foundation/core/RnObject.ts:238
Get the unique name of the entity.

Returns string

Methods

_copyFrom

_copyFrom(rnObject: RnObject): void

Inherited from RnObject._copyFrom
- Defined in foundation/core/RnObject.ts:252
Parameters
- rnObject: RnObject
Returns void

create

create(width: number, height: number): number

- Defined in foundation/renderer/FrameBuffer.ts:69
Parameters
- width: number
- height: number
Returns number

destroy3DAPIResources

destroy3DAPIResources(): void

- Defined in foundation/renderer/FrameBuffer.ts:180
Returns void

getColorAttachedRenderTargetTexture

getColorAttachedRenderTargetTexture(index: number): undefined | RenderTargetTexture

- Defined in foundation/renderer/FrameBuffer.ts:48
Parameters
- index: number
Returns undefined | RenderTargetTexture

getDepthAttachedRenderTargetTexture

getDepthAttachedRenderTargetTexture(): undefined | RenderTargetTexture

- Defined in foundation/renderer/FrameBuffer.ts:61
Returns undefined | RenderTargetTexture

getTag

getTag(tagName: string): Tag

Inherited from RnObject.getTag
- Defined in foundation/core/RnObject.ts:156
Gets the tag object.

Parameters
- tagName: string
  
  The tag name.
Returns Tag

getTagValue

getTagValue(tagName: string): any

Inherited from RnObject.getTagValue
- Defined in foundation/core/RnObject.ts:148
Gets the value of the tag.

Parameters
- tagName: string
  
  The tag name.
Returns any

hasTag

hasTag(tagName: string): boolean

Inherited from RnObject.hasTag
- Defined in foundation/core/RnObject.ts:168
Gets the boolean value whether this object has the tag or not.

Parameters
- tagName: string
  
  The tag name.
Returns boolean

matchTag

matchTag(tagName: string, tagValue: string): boolean

Inherited from RnObject.matchTag
- Defined in foundation/core/RnObject.ts:191
Confirms the matching of the tag name and tag value.

Parameters
- tagName: string
  
  The tag name.
- tagValue: string
  
  The tag value.
Returns boolean

matchTags

matchTags(tags: RnTags): boolean

Inherited from RnObject.matchTags
- Defined in foundation/core/RnObject.ts:221
Confirm that this object's tags includes given set of tags.

Parameters
- tags: RnTags
  
  The set of tags.
Returns boolean

matchTagsAsFreeStrings

matchTagsAsFreeStrings(stringArray: string[]): boolean

Inherited from RnObject.matchTagsAsFreeStrings
- Defined in foundation/core/RnObject.ts:203
Confirm that this object's tags includes given an array of string.

Parameters
- stringArray: string[]
  
  an array of string.
Returns boolean

removeTag

removeTag(tagName: string): void

Inherited from RnObject.removeTag
- Defined in foundation/core/RnObject.ts:180
Remove the tag.

Parameters
- tagName: string
  
  The tag name.
Returns void

resize

resize(width: number, height: number): void

- Defined in foundation/renderer/FrameBuffer.ts:150
Parameters
- width: number
- height: number
Returns void

setColorAttachmentAt

setColorAttachmentAt(index: number, renderable: IRenderable): boolean

- Defined in foundation/renderer/FrameBuffer.ts:83
Parameters
- index: number
- renderable: IRenderable
Returns boolean

setDepthAttachment

setDepthAttachment(renderable: IRenderable): boolean

- Defined in foundation/renderer/FrameBuffer.ts:102
Parameters
- renderable: IRenderable
Returns boolean

setDepthStencilAttachment

setDepthStencilAttachment(renderable: IRenderable): boolean

- Defined in foundation/renderer/FrameBuffer.ts:134
Parameters
- renderable: IRenderable
Returns boolean

setStencilAttachment

setStencilAttachment(renderable: IRenderable): boolean

- Defined in foundation/renderer/FrameBuffer.ts:118
Parameters
- renderable: IRenderable
Returns boolean

tryToSetTag

tryToSetTag(tag: Tag): boolean

Inherited from RnObject.tryToSetTag
- Defined in foundation/core/RnObject.ts:131
Tries to set tag (name and value).

Parameters
- tag: Tag
Returns boolean

tryToSetUniqueName

tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean

Inherited from RnObject.tryToSetUniqueName
- Defined in foundation/core/RnObject.ts:93
Try to set a unique name of the entity.

Parameters
- name: string
- toAddNameIfConflict: boolean
  
  If true, force to add name string to the current unique name string. If false, give up to change name.
Returns boolean

validateTagString

validateTagString(val: string): boolean

Inherited from RnObject.validateTagString
- Defined in foundation/core/RnObject.ts:118
Validate the string of tags.

Parameters
- val: string
  
  The string to be validated
Returns boolean

whichColorAttachment

whichColorAttachment(renderable: IRenderable): number

- Defined in foundation/renderer/FrameBuffer.ts:209
Parameters
- renderable: IRenderable
Returns number

Static _reset

_reset(): void

Inherited from RnObject._reset
- Defined in foundation/core/RnObject.ts:245
internal
Returns void

Static getRnObject

getRnObject(objectUid: number): RnObject

Inherited from RnObject.getRnObject
- Defined in foundation/core/RnObject.ts:76
Gets the object by corresponding to the objectUID.

Parameters
- objectUid: number
  
  The objectUID of the object.
Returns RnObject

Static getRnObjectByName

getRnObjectByName(uniqueName: string): undefined | RnObject

Inherited from RnObject.getRnObjectByName
- Defined in foundation/core/RnObject.ts:84
Gets the object by the unique name.

Parameters
- uniqueName: string
  
  The unique name of the object.
Returns undefined | RnObject

Static searchByTag

searchByTag(tag: string, value: string): undefined | RnObject

Inherited from RnObject.searchByTag
- Defined in foundation/core/RnObject.ts:56
Parameters
- tag: string
- value: string
Returns undefined | RnObject

Generated using TypeDoc