Class TextureResourceMetaData

Resource meta-data for Texture resources.

Hierarchy (view full)

Constructors

constructor

Accessors

affixResourceFlags affixResourceUUID contentType depth description displayName format height importOptions importSourceData isColorspaceSRGB mipmapCount pathInSourceAsset polyverseAssetID polyverseData polyverseLibraryID sampleCount sourcePath textureType usage width

Methods

getAffixResourceDataNumberValue getAffixResourceDataStringValue setAffixResourceDataNumberValue setAffixResourceDataStringValue

Constructors

Protectedconstructor

Accessors

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.

  • set affixResourceUUID(value): void

  • Parameters

    Returns void

contentType

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

  • set description(value): void

  • Parameters

    • value: string

    Returns void

displayName

  • get displayName(): string

  • The name of the Resource to be displayed.

    Returns string

  • set displayName(value): void

  • Parameters

    • value: string

    Returns void

format

height

  • get height(): number

  • Returns the height of the texture.

    Returns number

importOptions

  • get importOptions(): ImportOptions

  • The import options.

    Returns ImportOptions

  • set importOptions(value): void

  • Parameters

    Returns void

importSourceData

  • get importSourceData(): SourceAssetData

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

    Returns SourceAssetData

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

polyverseAssetID

  • get polyverseAssetID(): string

  • The Polyverse Library ID, if imported via Polyverse.

    Returns string

polyverseData

  • get polyverseData(): JsonObject

  • Polyverse specific data, set if imported via Polyverse.

    Returns JsonObject

polyverseLibraryID

  • get polyverseLibraryID(): string

  • The Polyverse Library ID, if imported via Polyverse.

    Returns string

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

  • set sourcePath(value): void

  • Parameters

    Returns void

textureType

usage

width

  • get width(): number

  • Returns the width of the texture.

    Returns number

Methods

getAffixResourceDataNumberValue

getAffixResourceDataStringValue

setAffixResourceDataNumberValue

setAffixResourceDataStringValue

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods