Class ImageCompressionOptions

Options used to control texture compression.

Index

Constructors

Properties

_format _isNormalMap _isSRGB _quality _usePerceptualMetrics

Accessors

format isNormalMap isSRGB quality usePerceptualMetrics

Methods

assign clone isEqual isEqual

Constructors

constructor

new ImageCompressionOptions(format?, isNormalMap?, isSRGB?, usePerceptualMetrics?, quality?): ImageCompressionOptions
Parameters
- Optionalformat: EnumValue<ImageCompressionFormat, number>
- OptionalisNormalMap: boolean
- OptionalisSRGB: boolean
- OptionalusePerceptualMetrics: boolean
- Optionalquality: EnumValue<FeatureQuality5, number>
Returns ImageCompressionOptions

Properties

`Protected`_format

_format: EnumValue<ImageCompressionFormat, number>

`Protected`_isNormalMap

_isNormalMap: boolean

`Protected`_isSRGB

_isSRGB: boolean

`Protected`_quality

_quality: EnumValue<FeatureQuality5, number>

`Protected`_usePerceptualMetrics

_usePerceptualMetrics: boolean

Accessors

format

get format(): EnumValue<ImageCompressionFormat, number>
Returns EnumValue<ImageCompressionFormat, number>
set format(value): void
Parameters
- value: EnumValue<ImageCompressionFormat, number>
Returns void

isNormalMap

get isNormalMap(): boolean
Returns boolean
set isNormalMap(value): void
Parameters
- value: boolean
Returns void

isSRGB

get isSRGB(): boolean
Returns boolean
set isSRGB(value): void
Parameters
- value: boolean
Returns void

quality

get quality(): EnumValue<FeatureQuality5, number>
Returns EnumValue<FeatureQuality5, number>
set quality(value): void
Parameters
- value: EnumValue<FeatureQuality5, number>
Returns void

usePerceptualMetrics

get usePerceptualMetrics(): boolean
Returns boolean
set usePerceptualMetrics(value): void
Parameters
- value: boolean
Returns void

Methods

assign

assign(other): ImageCompressionOptions
Copies all properties defined by the prototype of ImageCompressionOptions from other to this instance.
Parameters
- other: Immutable<ImageCompressionOptions>
Returns ImageCompressionOptions

clone

clone(): ImageCompressionOptions
Clones this instance and returns a new ImageCompressionOptions with identical values.

Returns ImageCompressionOptions

isEqual

isEqual(this, other): boolean
Determines if this ImageCompressionOptions instance is equal to the other instance.
Parameters
- this: Immutable<ImageCompressionOptions>
- other: Immutable<ImageCompressionOptions>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both ImageCompressionOptions instances are equal.
Parameters
- lhs: Immutable<ImageCompressionOptions>
- rhs: Immutable<ImageCompressionOptions>
Returns boolean