RoyInterface / Exports / resource/rendertarget/RoyRenderTarget / RoyRenderTarget

Class: RoyRenderTarget

resource/rendertarget/RoyRenderTarget.RoyRenderTarget

Table of contents

Constructors

• constructor

Properties

• sTypeClass
• m_sampleCount
• m_attachments
• m_impl
• sHandleID
• m_id
• m_name
• m_userData

Accessors

• sampleCount
• attachments
• impl
• name

Methods

• registerImplClass
• createInstance
• destroyInstance
• getId
• setUserData
• getUserData
• deleteUserData
• addAttachment
• removeAttachment
• upload
• destroy

Constructors

constructor

• new RoyRenderTarget(name): RoyRenderTarget

Parameters

Name	Type
name	string

Returns

RoyRenderTarget

Properties

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoyRenderTargetImplClass

---

m_sampleCount

• Protected m_sampleCount: number = 1

---

m_attachments

• Protected m_attachments: Attachment[]

---

m_impl

• Protected m_impl: RoyRenderTargetImpl[]

---

sHandleID

▪ Static Protected sHandleID: number = 0

---

m_id

• Protected m_id: number = 0

---

m_name

• Protected m_name: string = 'DefaultName'

---

m_userData

• Private m_userData: object = {}

Accessors

sampleCount

• get sampleCount(): number

Returns

number

• set sampleCount(value): void

Parameters

Name	Type
value	number

Returns

void

---

attachments

• get attachments(): Attachment[]

Returns

Attachment[]

---

impl

• get impl(): RoyRenderTargetImpl[]

Returns

RoyRenderTargetImpl[]

---

name

• get name(): string

Returns

string

Methods

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoyRenderTargetImplClass

Returns

void

---

createInstance

▸ createInstance(name): RoyRenderTarget

Parameters

Name	Type
name	string

Returns

RoyRenderTarget

---

destroyInstance

▸ destroyInstance(royRT): void

Parameters

Name	Type
royRT	RoyRenderTarget

Returns

void

---

getId

▸ getId(): number

Returns

number

---

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

---

addAttachment

▸ addAttachment(attachment): void

Parameters

Name	Type
attachment	Attachment

Returns

void

---

removeAttachment

▸ removeAttachment(attachment): void

Parameters

Name	Type
attachment	Attachment

Returns

void

---

upload

▸ upload(): void

Returns

void

---

destroy

▸ destroy(): void

Returns

void