Texture | rhodonite

Hierarchy

AbstractTexture
- Texture

Index

Constructors

constructor

Accessors

Constructors

constructor

new Texture(): Texture

Overrides AbstractTexture.constructor
- Defined in foundation/textures/Texture.ts:27
Returns Texture

Properties

Protected Optional __canvasContext

__canvasContext?: CanvasRenderingContext2D

Protected __format

__format: EnumIO = PixelFormat.RGBA

Protected __hasTransparentPixels

__hasTransparentPixels: boolean = false

Protected __height

__height: number = 0

Protected Optional __htmlCanvasElement

__htmlCanvasElement?: HTMLCanvasElement

Protected Optional __htmlImageElement

__htmlImageElement?: HTMLImageElement

Protected Optional __img

__img?: HTMLImageElement

Protected __internalFormat

__internalFormat: EnumIO = TextureParameter.RGBA8

Protected __isTextureReady

__isTextureReady: boolean = false

Protected __level

__level: number = 0

Protected __magFilter

__magFilter: EnumIO = TextureParameter.Linear

Protected __minFilter

__minFilter: EnumIO = TextureParameter.Linear

Protected __name

__name: string = 'untitled'

Protected __startedToLoad

__startedToLoad: boolean = false

Protected __type

__type: ComponentTypeEnum = ComponentType.UnsignedByte

Protected Optional __uri

__uri?: string

Protected __width

__width: number = 0

Protected __wrapS

__wrapS: EnumIO = TextureParameter.ClampToEdge

Protected __wrapT

__wrapT: EnumIO = TextureParameter.ClampToEdge

autoDetectTransparency

autoDetectTransparency: boolean = false

autoResize

autoResize: boolean = true

cgApiResourceUid

cgApiResourceUid: number = -1

Static Readonly InvalidObjectUID

InvalidObjectUID: -1 = -1

Static Private Optional __BasisFile

__BasisFile?: (new (x: Uint8Array) => _BasisFile)

Type declaration

- new (x: Uint8Array): _BasisFile
- Parameters
  - x: Uint8Array
  Returns _BasisFile

Static Private Optional __basisLoadPromise

__basisLoadPromise?: Promise<void>

Static Private __loadedBasisFunc

__loadedBasisFunc: boolean = false

Static Protected __textureMap

__textureMap: Map<number, AbstractTexture> = ...

Static currentMaxObjectCount

currentMaxObjectCount: number = 0

Accessors

height

get height(): number
set height(val: number): void

Inherited from AbstractTexture.height
- Defined in foundation/textures/AbstractTexture.ts:74
Returns number
Inherited from AbstractTexture.height
- Defined in foundation/textures/AbstractTexture.ts:78
Parameters
- val: number
Returns void

htmlCanvasElement

get htmlCanvasElement(): HTMLCanvasElement

Inherited from AbstractTexture.htmlCanvasElement
- Defined in foundation/textures/AbstractTexture.ts:94
Returns HTMLCanvasElement

htmlImageElement

get htmlImageElement(): undefined | HTMLImageElement

Inherited from AbstractTexture.htmlImageElement
- Defined in foundation/textures/AbstractTexture.ts:90
Returns undefined | HTMLImageElement

isTextureReady

get isTextureReady(): boolean

Inherited from AbstractTexture.isTextureReady
- Defined in foundation/textures/AbstractTexture.ts:82
Returns boolean

isTransparent

get isTransparent(): boolean

Inherited from AbstractTexture.isTransparent
- Defined in foundation/textures/AbstractTexture.ts:208
Returns boolean

magFilter

get magFilter(): EnumIO

Inherited from AbstractTexture.magFilter
- Defined in foundation/textures/AbstractTexture.ts:248
Returns EnumIO

minFilter

get minFilter(): EnumIO

Inherited from AbstractTexture.minFilter
- Defined in foundation/textures/AbstractTexture.ts:252
Returns EnumIO

name

get name(): string
set name(name: string): void

Inherited from AbstractTexture.name
- Defined in foundation/textures/AbstractTexture.ts:124
Returns string
Inherited from AbstractTexture.name
- Defined in foundation/textures/AbstractTexture.ts:120
Parameters
- name: string
Returns void

objectUID

get objectUID(): number

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

Returns number

startedToLoad

get startedToLoad(): boolean

Inherited from AbstractTexture.startedToLoad
- Defined in foundation/textures/AbstractTexture.ts:86
Returns boolean

textureUID

get textureUID(): number

Inherited from AbstractTexture.textureUID
- Defined in foundation/textures/AbstractTexture.ts:62
Returns number

uniqueName

get uniqueName(): string

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

Returns string

uri

get uri(): undefined | string

Inherited from AbstractTexture.uri
- Defined in foundation/textures/AbstractTexture.ts:112
Returns undefined | string

width

get width(): number
set width(val: number): void

Inherited from AbstractTexture.width
- Defined in foundation/textures/AbstractTexture.ts:66
Returns number
Inherited from AbstractTexture.width
- Defined in foundation/textures/AbstractTexture.ts:70
Parameters
- val: number
Returns void

wrapS

get wrapS(): EnumIO

Inherited from AbstractTexture.wrapS
- Defined in foundation/textures/AbstractTexture.ts:256
Returns EnumIO

wrapT

get wrapT(): EnumIO

Inherited from AbstractTexture.wrapT
- Defined in foundation/textures/AbstractTexture.ts:260
Returns EnumIO

Methods

Private __setBasisTexture

__setBasisTexture(uint8Array: Uint8Array, __namedParameters?: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; type: undefined | ComponentTypeEnum; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO }): void

- Defined in foundation/textures/Texture.ts:84
Parameters
- uint8Array: Uint8Array
- __namedParameters: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; type: undefined | ComponentTypeEnum; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO } = {}
  - anisotropy: undefined | boolean
  - format: undefined | EnumIO
  - generateMipmap: undefined | boolean
  - internalFormat: undefined | EnumIO
  - isPremultipliedAlpha: undefined | boolean
  - level: undefined | number
  - magFilter: undefined | EnumIO
  - minFilter: undefined | EnumIO
  - type: undefined | ComponentTypeEnum
  - wrapS: undefined | EnumIO
  - wrapT: undefined | EnumIO
Returns void

_copyFrom

_copyFrom(rnObject: RnObject): void

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

createInternalCanvasContext

createInternalCanvasContext(): void

Inherited from AbstractTexture.createInternalCanvasContext
- Defined in foundation/textures/AbstractTexture.ts:212
Returns void

generate1x1TextureFrom

generate1x1TextureFrom(rgbaStr?: string): void

- Defined in foundation/textures/Texture.ts:323
Parameters
- rgbaStr: string = 'rgba(255,255,255,1)'
Returns void

generateCompressedTextureFromTypedArray

generateCompressedTextureFromTypedArray(typedArray: TypedArray, width: number, height: number, compressionTextureType: EnumIO, __namedParameters?: { anisotropy: undefined | boolean; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO }): void

- Defined in foundation/textures/Texture.ts:402
Parameters
- typedArray: TypedArray
- width: number
- height: number
- compressionTextureType: EnumIO
- __namedParameters: { anisotropy: undefined | boolean; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO } = {}
  - anisotropy: undefined | boolean
  - magFilter: undefined | EnumIO
  - minFilter: undefined | EnumIO
  - wrapS: undefined | EnumIO
  - wrapT: undefined | EnumIO
Returns void

generateCompressedTextureWithMipmapFromTypedArray

generateCompressedTextureWithMipmapFromTypedArray(textureDataArray: TextureData[], compressionTextureType: EnumIO, __namedParameters?: { anisotropy: undefined | boolean; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO }): void

- Defined in foundation/textures/Texture.ts:450
Parameters
- textureDataArray: TextureData[]
- compressionTextureType: EnumIO
- __namedParameters: { anisotropy: undefined | boolean; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO } = {}
  - anisotropy: undefined | boolean
  - magFilter: undefined | EnumIO
  - minFilter: undefined | EnumIO
  - wrapS: undefined | EnumIO
  - wrapT: undefined | EnumIO
Returns void

generateTextureFromBasis

generateTextureFromBasis(uint8Array: Uint8Array, options: { anisotropy?: boolean; format?: EnumIO; generateMipmap?: boolean; internalFormat?: EnumIO; isPremultipliedAlpha?: boolean; level?: number; magFilter: EnumIO; minFilter: EnumIO; type?: ComponentTypeEnum; wrapS: EnumIO; wrapT: EnumIO }): void

- Defined in foundation/textures/Texture.ts:31
Parameters
- uint8Array: Uint8Array
- options: { anisotropy?: boolean; format?: EnumIO; generateMipmap?: boolean; internalFormat?: EnumIO; isPremultipliedAlpha?: boolean; level?: number; magFilter: EnumIO; minFilter: EnumIO; type?: ComponentTypeEnum; wrapS: EnumIO; wrapT: EnumIO }
  - Optional anisotropy?: boolean
  - Optional format?: EnumIO
  - Optional generateMipmap?: boolean
  - Optional internalFormat?: EnumIO
  - Optional isPremultipliedAlpha?: boolean
  - Optional level?: number
  - magFilter: EnumIO
  - minFilter: EnumIO
  - Optional type?: ComponentTypeEnum
  - wrapS: EnumIO
  - wrapT: EnumIO
Returns void

generateTextureFromImage

generateTextureFromImage(image: HTMLImageElement, __namedParameters?: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; type: undefined | ComponentTypeEnum; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO }): void

- Defined in foundation/textures/Texture.ts:175
Parameters
- image: HTMLImageElement
- __namedParameters: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; type: undefined | ComponentTypeEnum; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO } = {}
  - anisotropy: undefined | boolean
  - format: undefined | EnumIO
  - generateMipmap: undefined | boolean
  - internalFormat: undefined | EnumIO
  - isPremultipliedAlpha: undefined | boolean
  - level: undefined | number
  - magFilter: undefined | EnumIO
  - minFilter: undefined | EnumIO
  - type: undefined | ComponentTypeEnum
  - wrapS: undefined | EnumIO
  - wrapT: undefined | EnumIO
Returns void

generateTextureFromKTX2

generateTextureFromKTX2(uint8Array: Uint8Array, __namedParameters?: { anisotropy: undefined | boolean; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO }): Promise<void>

- Defined in foundation/textures/Texture.ts:141
Parameters
- uint8Array: Uint8Array
- __namedParameters: { anisotropy: undefined | boolean; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO } = {}
  - anisotropy: undefined | boolean
  - magFilter: undefined | EnumIO
  - minFilter: undefined | EnumIO
  - wrapS: undefined | EnumIO
  - wrapT: undefined | EnumIO
Returns Promise<void>

generateTextureFromTypedArray

generateTextureFromTypedArray(typedArray: TypedArray, __namedParameters?: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO }): void

- Defined in foundation/textures/Texture.ts:357
Parameters
- typedArray: TypedArray
- __namedParameters: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO } = {}
  - anisotropy: undefined | boolean
  - format: undefined | EnumIO
  - generateMipmap: undefined | boolean
  - internalFormat: undefined | EnumIO
  - isPremultipliedAlpha: undefined | boolean
  - level: undefined | number
  - magFilter: undefined | EnumIO
  - minFilter: undefined | EnumIO
  - wrapS: undefined | EnumIO
  - wrapT: undefined | EnumIO
Returns void

generateTextureFromUri

generateTextureFromUri(imageUri: string, __namedParameters?: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; type: undefined | ComponentTypeEnum; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO }): Promise<void>

- Defined in foundation/textures/Texture.ts:245
Parameters
- imageUri: string
- __namedParameters: { anisotropy: undefined | boolean; format: undefined | EnumIO; generateMipmap: undefined | boolean; internalFormat: undefined | EnumIO; isPremultipliedAlpha: undefined | boolean; level: undefined | number; magFilter: undefined | EnumIO; minFilter: undefined | EnumIO; type: undefined | ComponentTypeEnum; wrapS: undefined | EnumIO; wrapT: undefined | EnumIO } = {}
  - anisotropy: undefined | boolean
  - format: undefined | EnumIO
  - generateMipmap: undefined | boolean
  - internalFormat: undefined | EnumIO
  - isPremultipliedAlpha: undefined | boolean
  - level: undefined | number
  - magFilter: undefined | EnumIO
  - minFilter: undefined | EnumIO
  - type: undefined | ComponentTypeEnum
  - wrapS: undefined | EnumIO
  - wrapT: undefined | EnumIO
Returns Promise<void>

getImageData

getImageData(x: number, y: number, width: number, height: number): ImageData

Inherited from AbstractTexture.getImageData
- Defined in foundation/textures/AbstractTexture.ts:128
Parameters
- x: number
- y: number
- width: number
- height: number
Returns ImageData

getPixelAs

getPixelAs(x: number, y: number, typeClass: typeof Vector3 | typeof Vector4 | typeof MutableVector3 | typeof MutableVector4 | typeof ColorRgb | typeof ColorRgba): any

Inherited from AbstractTexture.getPixelAs
- Defined in foundation/textures/AbstractTexture.ts:141
Parameters
- x: number
- y: number
- typeClass: typeof Vector3 | typeof Vector4 | typeof MutableVector3 | typeof MutableVector4 | typeof ColorRgb | typeof ColorRgba
Returns any

getPixelAsArray

getPixelAsArray(x: number, y: number): Uint8ClampedArray

Inherited from AbstractTexture.getPixelAsArray
- Defined in foundation/textures/AbstractTexture.ts:171
get the pixel data at (x,y) in the Texture as Uint8Clamped Array

Parameters
- x: number
  
  x position in the texture
- y: number
  
  y position in the texture
Returns Uint8ClampedArray
a pixel data as Uint8Clamped Array

getTag

getTag(tagName: string): Tag

Inherited from AbstractTexture.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 AbstractTexture.getTagValue
- Defined in foundation/core/RnObject.ts:148
Gets the value of the tag.

Parameters
- tagName: string
  
  The tag name.
Returns any

getTextureDataFloat

getTextureDataFloat(channels: number): TextureDataFloat

Inherited from AbstractTexture.getTextureDataFloat
- Defined in foundation/textures/AbstractTexture.ts:225
Parameters
- channels: number
Returns TextureDataFloat

hasTag

hasTag(tagName: string): boolean

Inherited from AbstractTexture.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

importWebGLTextureDirectly

importWebGLTextureDirectly(webGLTexture: WebGLTexture, width?: number, height?: number): void

- Defined in foundation/textures/Texture.ts:496
Parameters
- webGLTexture: WebGLTexture
- width: number = 0
- height: number = 0
Returns void

matchTag

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

Inherited from AbstractTexture.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 AbstractTexture.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 AbstractTexture.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 AbstractTexture.removeTag
- Defined in foundation/core/RnObject.ts:180
Remove the tag.

Parameters
- tagName: string
  
  The tag name.
Returns void

setPixel

setPixel(x: number, y: number, value: Vector3 | Vector4 | MutableVector3 | MutableVector4 | ColorRgb | ColorRgba): void

Inherited from AbstractTexture.setPixel
- Defined in foundation/textures/AbstractTexture.ts:176
Parameters
- x: number
- y: number
- value: Vector3 | Vector4 | MutableVector3 | MutableVector4 | ColorRgb | ColorRgba
Returns void

setPixelAtChannel

setPixelAtChannel(x: number, y: number, channelIdx: number, value: number): void

Inherited from AbstractTexture.setPixelAtChannel
- Defined in foundation/textures/AbstractTexture.ts:201
Parameters
- x: number
- y: number
- channelIdx: number
- value: number
Returns void

tryToSetTag

tryToSetTag(tag: Tag): boolean

Inherited from AbstractTexture.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 AbstractTexture.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 AbstractTexture.validateTagString
- Defined in foundation/core/RnObject.ts:118
Validate the string of tags.

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

Static _reset

_reset(): void

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

Static getRhodoniteTexture

getRhodoniteTexture(textureUid: number): undefined | AbstractTexture

Inherited from AbstractTexture.getRhodoniteTexture
- Defined in foundation/textures/AbstractTexture.ts:116
Parameters
- textureUid: number
Returns undefined | AbstractTexture

Static getRnObject

getRnObject(objectUid: number): RnObject

Inherited from AbstractTexture.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 AbstractTexture.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 AbstractTexture.searchByTag
- Defined in foundation/core/RnObject.ts:56
Parameters
- tag: string
- value: string
Returns undefined | RnObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Texture

Properties

Protected Optional __canvasContext

Protected __format

Protected __hasTransparentPixels

Protected __height

Protected Optional __htmlCanvasElement

Protected Optional __htmlImageElement

Protected Optional __img

Protected __internalFormat

Protected __isTextureReady

Protected __level

Protected __magFilter

Protected __minFilter

Protected __name

Protected __startedToLoad

Protected __type

Protected Optional __uri

Protected __width

Protected __wrapS

Protected __wrapT

autoDetectTransparency

autoResize

cgApiResourceUid

Static Readonly InvalidObjectUID

Static Private Optional __BasisFile

Type declaration

Parameters

x: Uint8Array

Returns _BasisFile

Static Private Optional __basisLoadPromise

Static Private __loadedBasisFunc

Static Protected __textureMap

Static currentMaxObjectCount

Accessors

height

Returns number

Parameters

val: number

Returns void

htmlCanvasElement

Returns HTMLCanvasElement

htmlImageElement

Returns undefined | HTMLImageElement

isTextureReady

Returns boolean

isTransparent

Returns boolean

magFilter

Returns EnumIO

minFilter

Returns EnumIO

name

Returns string

Parameters

name: string

Returns void

objectUID

Returns number

startedToLoad

Returns boolean

textureUID

Returns number

uniqueName

Returns string

uri

Returns undefined | string

width

Returns number

Parameters

val: number

Returns void