RoyInterface / Exports / resource/texture/RoyTexture / RoyTexture

Class: RoyTexture

resource/texture/RoyTexture.RoyTexture

Implements

• RoyTransDataObject

Table of contents

Constructors

• constructor

Properties

• CLASS_NAME
• sGpuImplID
• sTypeClass
• ktxDecoder
• sHandleID
• m_id
• m_impl
• m_userData
• m_name
• m_srgb
• m_texWidth
• m_texHeight
• m_texDepth
• m_internalFormat
• m_usage
• m_miplevel
• m_samplerType
• m_provider
• INVALID_KEY
• m_uniKey
• m_alwaysInUse
• m_relMaterialMap
• m_relMaterialRefCountMap
• m_transDataInfo
• m_canTransfer

Accessors

• impl
• name
• srgb
• width
• height
• depth
• internalFormat
• usage
• miplevel
• samplerType
• provider
• uniKey
• alwaysInUse
• relMaterialMap
• relMaterialRefCountMap
• transDataInfo
• canTransfer

Methods

• registerImplClass
• createInstance
• destroyInstance
• getId
• setUserData
• getUserData
• deleteUserData
• isInUse
• addRelMaterial
• removeRelMaterial
• markTransDataDirty
• markCanTransfer
• initialize
• calUniKey
• isPowerOf2
• notifyUse
• upload
• setParamDirty
• canTextureArray
• markContentDirtyFromTexture
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData

Constructors

constructor

• new RoyTexture(transDataInfo?): RoyTexture

Parameters

Name	Type
transDataInfo?	RoyTransDataInfo

Returns

RoyTexture

Properties

CLASS_NAME

▪ Static CLASS_NAME: string = 'RoyTexture'

---

sGpuImplID

▪ Static sGpuImplID: number = 1

---

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoyTextureImplClass

---

ktxDecoder

▪ Static ktxDecoder: IRoyTextureKTXDecoder

---

sHandleID

▪ Static Protected sHandleID: number = 0

---

m_id

• Protected m_id: number = 0

---

m_impl

• Protected m_impl: RoyTextureImpl[]

---

m_userData

• Protected m_userData: object = {}

---

m_name

• Protected m_name: string = 'TextureNoName'

---

m_srgb

• Protected m_srgb: boolean = false

---

m_texWidth

• Protected m_texWidth: number = 128

---

m_texHeight

• Protected m_texHeight: number = 128

---

m_texDepth

• Protected m_texDepth: number = 1

---

m_internalFormat

• Protected m_internalFormat: Texture$InternalFormat = Texture$InternalFormat.RGBA8

---

m_usage

• Protected m_usage: Texture$Usage = Texture$Usage.DEFAULT

---

m_miplevel

• Protected m_miplevel: number = 0xff

---

m_samplerType

• Protected m_samplerType: Texture$Sampler

---

m_provider

• Protected m_provider: RoyTextureProvider = null

---

INVALID_KEY

▪ Static INVALID_KEY: string = 'RoyTexture_Null'

---

m_uniKey

• Private m_uniKey: string = RoyTexture.INVALID_KEY

---

m_alwaysInUse

• Private m_alwaysInUse: boolean = false

---

m_relMaterialMap

• Protected m_relMaterialMap: Map<number, RoyMaterialBase>

---

m_relMaterialRefCountMap

• Protected m_relMaterialRefCountMap: Map<number, number>

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

Accessors

impl

• get impl(): RoyTextureImpl[]

Returns

RoyTextureImpl[]

---

name

• get name(): string

Returns

string

---

srgb

• get srgb(): boolean

Returns

boolean

---

width

• get width(): number

Returns

number

---

height

• get height(): number

Returns

number

---

depth

• get depth(): number

Returns

number

---

internalFormat

• get internalFormat(): Texture$InternalFormat

Returns

Texture$InternalFormat

---

usage

• get usage(): Texture$Usage

Returns

Texture$Usage

---

miplevel

• get miplevel(): number

Returns

number

---

samplerType

• get samplerType(): Texture$Sampler

Returns

Texture$Sampler

---

provider

• get provider(): RoyTextureProvider

Returns

RoyTextureProvider

• set provider(value): void

Parameters

Name	Type
value	RoyTextureProvider

Returns

void

---

uniKey

• get uniKey(): string

Returns

string

• set uniKey(value): void

Parameters

Name	Type
value	string

Returns

void

---

alwaysInUse

• get alwaysInUse(): boolean

Returns

boolean

• set alwaysInUse(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

relMaterialMap

• get relMaterialMap(): Map<number, RoyMaterialBase>

Returns

Map<number, RoyMaterialBase>

---

relMaterialRefCountMap

• get relMaterialRefCountMap(): Map<number, number>

Returns

Map<number, number>

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Implementation of

RoyTransDataObject.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Implementation of

RoyTransDataObject.canTransfer

Methods

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoyTextureImplClass

Returns

void

---

createInstance

▸ createInstance(transDataInfo?): RoyTexture

Parameters

Name	Type
transDataInfo?	RoyTransDataInfo

Returns

RoyTexture

---

destroyInstance

▸ destroyInstance(royTexture): boolean

Parameters

Name	Type
royTexture	RoyTexture

Returns

boolean

---

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

---

isInUse

▸ isInUse(): boolean

Returns

boolean

---

addRelMaterial

▸ addRelMaterial(material): void

Parameters

Name	Type
material	RoyMaterialBase

Returns

void

---

removeRelMaterial

▸ removeRelMaterial(material): void

Parameters

Name	Type
material	RoyMaterialBase

Returns

void

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Implementation of

RoyTransDataObject.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

RoyTransDataObject.markCanTransfer

---

initialize

▸ initialize(options): void

Parameters

Name	Type
options	RoyTextureOptions

Returns

void

---

calUniKey

▸ calUniKey(): void

Returns

void

---

isPowerOf2

▸ isPowerOf2(): boolean

Returns

boolean

---

notifyUse

▸ notifyUse(): void

Returns

void

---

upload

▸ upload(userData?): void

Parameters

Name	Type
userData?	unknown

Returns

void

---

setParamDirty

▸ setParamDirty(): void

Returns

void

---

canTextureArray

▸ canTextureArray(options): boolean

Parameters

Name	Type
options	RoyTextureArrayOption

Returns

boolean

---

markContentDirtyFromTexture

▸ markContentDirtyFromTexture(): void

Returns

void

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Implementation of

RoyTransDataObject.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

void

Implementation of

RoyTransDataObject.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): RoyTextureData

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

RoyTextureData

Implementation of

RoyTransDataObject.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, texData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
texData	RoyTextureData

Returns

void