IX3dShadingModel

Interface

Inheritance 16 descendants

IX3dShadingModelcurrent

Class Documentation

A shading model: the object that tells the client how to light the meshes that a shader draws. A shader definition links one through IShaderDef.ShadingModel, and the client reads the model from the material when it loads and draws a mesh. A shading model carries no lighting parameters. Its class alone selects the behaviour:

Family	Meshes	What the model does
IEnvironmentShadingModel	map geometry	Selects the layout of each mesh's lighting block in the `.mapgeo` file, reads the block, and binds the mesh's lightmaps and probe
ISkinnedShadingModel	characters and other skinned meshes	Finds the light-grid cell of the draw and, for the standard model, uploads the cell's ambient colours
IParticleShadingModel	particles	Nothing per particle. Only the kind of model has an effect, see IParticleQuadShadingModel

Shipped data defines the shading models as objects in assets/shaders/shareddata.bin, next to the X3DSharedData object. Many shaders link the same model object.

Shared resources. A model can carry the same four kinds of shared resources as X3DSharedData. The client reads them once, when it sets up the render device, after the X3DSharedData lists, and registers them the same way. Across all models it registers each constant buffer object once and each texture, sampler and data buffer name once. If a model entry has the same name as an X3DSharedData entry, which of the two a shader binds is not yet identified.

Properties

SharedConstantBuffers

List<X3DSharedConstantBufferDef>

Documentation Edit documentation

Constant buffers that the model adds to the shared constant buffers, as X3DSharedData.constantBuffers does. A buffer object that a model has already registered is skipped.

SharedTextures

List<X3DSharedTextureDef>

Documentation Edit documentation

Textures that the model adds to the shared textures, as X3DSharedData.textures does. A name that a model has already registered is skipped.

objectPath

Hash

Documentation Edit documentation

Purpose not yet identified. Shipped models set it to a hash.

sharedDataBuffers

List2<X3DSharedDataBufferDef>

16.12

Documentation Edit documentation

Data buffers that the model adds to the shared data buffers, as X3DSharedData.dataBuffers does. A name that a model has already registered is skipped.

sharedSamplers

List2<X3DSharedSamplerDef>

14.23

Documentation Edit documentation

Samplers that the model adds to the shared samplers, as X3DSharedData.samplers does. A name that a model has already registered is skipped.

Referenced by 1 class · 1 property

IShaderDef ShadingModel Link<IX3dShadingModel>