Skip to main content

Editor.Assets.PassUiData

Class

Shader pass UI configuration data.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const assetManager = model.project.assetManager;

// Find Material assets and inspect PassUiData for each pass
const materials = assetManager.assets.filter(
a => a.isOfType('Material')
) as Editor.Assets.Material[];

let totalBindings = 0;
for (const material of materials) {
for (const info of material.passInfos) {
// Each pass exposes uiData with shaderType, extraDefines, and passBindings
const uiData: Editor.Assets.PassUiData = info.uiData;
if (!uiData) continue;
totalBindings += uiData.passBindings.length;
}
}

console.log(`Inspected ${materials.length} material(s), ${totalBindings} total pass binding(s)`);

Extends

Properties

extraDefines

readonly extraDefines: string[]

Additional preprocessor defines for the shader pass.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

EntityStructure.id


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

EntityStructure.meta


passBindings

readonly passBindings: PassBinding[]

Bindings between shader parameters and material inputs.


shaderType

readonly shaderType: ShaderType

Type of shader for this pass.


type

readonly type: string

The entity's type.

Inherited from

EntityStructure.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

EntityStructure.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Inherited from

EntityStructure.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

EntityStructure.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

EntityStructure.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

EntityStructure.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

EntityStructure.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

EntityStructure.isSame