Skip to main content

Shader

Asset ID:shader

A GPU shader

Asset schema properties

uuid

uuid

Unique identifier for the asset

name

string

Name of the asset

blendMode

0invalid1opaque2alpha_blended3masked

Default:0(invalid)

The blend mode for the shader, used for batching purposes. Only valid for material shaders

materialDescriptor

array[object]

Data descriptor for material shaders

Parameter description

name

string

Parameter name

categories

array[string]

Categories

default

numberstringbooleanarray[number]

Parameter default value

nativeType

Parameter native type

type

Parameter type

moduleDescriptions

array[object]

Descriptions of all modules that compose this shader

Description of a shader module

payloadOffset

uint32

Offset in byte in the shader payload buffer

payloadSize

uint32

Size in byte of the compiled module

shaderStage

integer

The shader stage

usedBindings

uint64

Bindings used by this module

nodeDataDescriptor

array[object]

Data descriptor for render graph node shaders

Parameter description

name

string

Parameter name

categories

array[string]

Categories

default

numberstringbooleanarray[number]

Parameter default value

nativeType

Parameter native type

type

Parameter type

optComputeSettings

object

{

sizeReference,

workgroupSize,

workloadScalingFactor,

}

Compute shader settings. Only valid for compute shaders

optVertexDescriptor

array[object]

Vertex description. Only valid when a vertex shader module is present

Description of a vertex attribute

binding

uint32

Binding number

format

integer

Format

location

uint32

Location

offset

uint32

Default:0

Offset

semantic

1position2normal4tex_coord8skin_bone_ids16skin_weights32custom

Semantic

stride

uint32

Stride between consecutive elements within the buffer

payloadSize

uint32

The size in byte of the compiled shader code (accumulated size of all modules)

shaderStages

uint32

Vulkan bit mask of all shader stages present in this shader