Editor.Assets.PerformanceCompressionSettings
ClassSets runtime-performance-tuned texture compression with optional mipmaps; assign to AssetImportMetadata.compressionSettings.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
const perf = Editor.Assets.PerformanceCompressionSettings.create(scene);
perf.mipmap = true;
perf.level = Editor.Assets.TextureCompressionLevel.Medium;
const tex = model.project.assetManager.assets.find((a) => a.isOfType('FileTexture'));
if (!Editor.isNull(tex) && !Editor.isNull(tex.fileMeta)) {
tex.fileMeta.compressionSettings = perf;
}
console.log(`PerformanceCompression mipmap=${perf.mipmap} level=${perf.level}`);
Extends
Properties
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
level
level:
TextureCompressionLevel
Compression level controlling the quality-versus-size tradeoff.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
mipmap
mipmap:
boolean
Whether mipmaps are generated and stored alongside the compressed texture.
type
readonlytype:string
The entity's type.
Inherited from
Methods
create()
staticcreate(scene):PerformanceCompressionSettings
Creates a new PerformanceCompressionSettings entity within the given scene.
Parameters
| Parameter | Type |
|---|---|
scene | Scene |
Returns
PerformanceCompressionSettings
Overrides
SizeCompressionSettings.create
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
SizeCompressionSettings.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
SizeCompressionSettings.getMeta
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
SizeCompressionSettings.getOwnedEntities
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
SizeCompressionSettings.getTypeName
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
SizeCompressionSettings.getTypeName
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
SizeCompressionSettings.isOfType
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean