Class TextureResourceMetaData

Resource meta-data for Texture resources.

Hierarchy (View Summary)

ResourceMetaData
- TextureResourceMetaData

Constructors

`Protected`constructor

new TextureResourceMetaData(
isInternalConstructor?: boolean,
): TextureResourceMetaData
Parameters
- OptionalisInternalConstructor: boolean
Returns TextureResourceMetaData

Overrides ResourceMetaData.constructor

Accessors

affixResourceFlags

get affixResourceFlags(): EnumValue<AffixResourceFlags>

The flags for the relation to the dependent.

Returns EnumValue<AffixResourceFlags>

Inherited from ResourceMetaData.affixResourceFlags
set affixResourceFlags(value: EnumValue<AffixResourceFlags>): void
Parameters
- value: EnumValue<AffixResourceFlags>
Returns void

Inherited from ResourceMetaData.affixResourceFlags

affixResourceUUID

get affixResourceUUID(): UUID

The UUID of the resource that this instance depends on.

Returns UUID

Note
The resource may be unavailable in the library.

Inherited from ResourceMetaData.affixResourceUUID
set affixResourceUUID(value: UUID): void
Parameters
- value: UUID
Returns void

Inherited from ResourceMetaData.affixResourceUUID

contentType

get contentType(): EnumValue<TextureContentType>

Returns EnumValue<TextureContentType>

depth

get depth(): number

Returns the depth of the texture (only applicable for 3D textures).

Returns number

description

get description(): string

The description of the Resource.

Returns string

Inherited from ResourceMetaData.description
set description(value: string): void
Parameters
- value: string
Returns void

Inherited from ResourceMetaData.description

displayName

get displayName(): string

The name of the Resource to be displayed.

Returns string

Inherited from ResourceMetaData.displayName
set displayName(value: string): void
Parameters
- value: string
Returns void

Inherited from ResourceMetaData.displayName

format

get format(): EnumValue<PixelFormat>

Returns the pixel format for the texture surface.

Returns EnumValue<PixelFormat>

height

get height(): number

Returns the height of the texture.

Returns number

importOptions

get importOptions(): ImportOptions

The import options.

Returns ImportOptions

Inherited from ResourceMetaData.importOptions
set importOptions(value: ImportOptions): void
Parameters
- value: ImportOptions
Returns void

Inherited from ResourceMetaData.importOptions

importSourceData

get importSourceData(): SourceAssetData

The source asset data, used to regenerate the imported asset.

Returns SourceAssetData

Inherited from ResourceMetaData.importSourceData

isColorspaceSRGB

get isColorspaceSRGB(): boolean

Determines if the texture source data is sRGB colorspaced. If the texture format supports hardware sRGB conversion, the underlying data will be sRGB and convered to linear when sampled. Otherwise the data will be linearized on import.

Returns boolean

mipmapCount

get mipmapCount(): number

Gets the number of mipmaps to be used for this texture. This number excludes the top level map (which is always assumed to be present).

Returns number

pathInSourceAsset

get pathInSourceAsset(): FilePath

The path in the source asset when it was imported into the library.

Returns FilePath

Inherited from ResourceMetaData.pathInSourceAsset

polyverseAssetID

get polyverseAssetID(): string

The Polyverse Library ID, if imported via Polyverse.

Returns string

Inherited from ResourceMetaData.polyverseAssetID

polyverseData

get polyverseData(): JsonObject

Polyverse specific data, set if imported via Polyverse.

Returns JsonObject

Inherited from ResourceMetaData.polyverseData

polyverseLibraryID

get polyverseLibraryID(): string

The Polyverse Library ID, if imported via Polyverse.

Returns string

Inherited from ResourceMetaData.polyverseLibraryID

sampleCount

get sampleCount(): number

Gets the number of samples used for multisampling (0 or 1 if multisampling is not used).

Returns number

sourcePath

get sourcePath(): FilePath

The absolute file path where the file was imported from the users file system.

Returns FilePath

Inherited from ResourceMetaData.sourcePath
set sourcePath(value: FilePath): void
Parameters
- value: FilePath
Returns void

Inherited from ResourceMetaData.sourcePath

textureType

get textureType(): EnumValue<TextureType>

Gets the type of texture.

Returns EnumValue<TextureType>

usage

get usage(): EnumValue<TextureUsageFlag>

Returns a value that signals the engine in what way is the texture expected to be used.

Returns EnumValue<TextureUsageFlag>

width

get width(): number

Returns the width of the texture.

Returns number

Methods

getAffixResourceDataNumberValue

getAffixResourceDataNumberValue(key: string): number
Gets the affix resource data for the specified key.
Parameters
- key: string
Returns number

Inherited from ResourceMetaData.getAffixResourceDataNumberValue

getAffixResourceDataStringValue

getAffixResourceDataStringValue(key: string): string
Gets the affix resource data for the specified key.
Parameters
- key: string
Returns string

Inherited from ResourceMetaData.getAffixResourceDataStringValue

setAffixResourceDataNumberValue

setAffixResourceDataNumberValue(key: string, value: number): void
Sets the affaffixrix resource data key to the specified
Parameters
- key: string
- value: number
Returns void

Inherited from ResourceMetaData.setAffixResourceDataNumberValue

setAffixResourceDataStringValue

setAffixResourceDataStringValue(key: string, value: string): void
Sets the affix resource data key to the specified string
Parameters
- key: string
- value: string
Returns void

Inherited from ResourceMetaData.setAffixResourceDataStringValue