J.1 General

This annex defines the mapping of concepts of the programmable shaders component to the Microsoft High Level Shading Language (HLSL) (see [HLSL]). It applies to the ProgramShader, ShaderProgram and PackagedShader nodes with the language field set to "HLSL".

J.2 Topics

Table 1 provides links to the major topics in this annex.

J.3 Interaction with other nodes and components

J.3.1 Vertex shader

The vertex shader replaces the vertex processing done by the Microsoft Direct3D graphics pipeline. While using a vertex shader, state information regarding transformation and lighting operations is ignored by the fixed-function pipeline. The HLSL specification states that the following functionality is disabled if a vertex shader is supplied:

1. The model view matrix is not applied to vertex coordinates.
2. The projection matrix is not applied to vertex coordinates.
3. The texture matrices are not applied to texture coordinates.
4. The normals are not transformed to eye coordinates.
5. The normals are not rescaled or normalized.
6. Texture coordinates are not generated automatically.
7. Per vertex lighting is not performed.
8. Color material lighting is not performed.
9. Point size distance attenuation is not performed.

J.3.2 Fragment Shader

The fragment shader, also know as a pixel shader in HLSL, replaces the fixed functionality of the Direct3D fragment processor. The HLSL specification states that textures are not applied if a fragment shader is supplied.

J.3.3 LoadSensor

The LoadSensor node (See 9.4.3 LoadSensor) has two output fields isActive and isLoaded. The isLoaded field behaviour is unchanged.

The isActive field is defined to issue a TRUE event when all the following conditions have been satisfied:

1. The content identified by the url field has been successfully loaded.
2. The shader program has been successfully compiled without error.

J.3.4 Vertex attributes

Each vertex attribute node directly maps the name field to a Direct3D usage type for use within a Direct3D vertex declaration (with the prefix "D3DDECLUSAGE_" prepended to the name), as well as an HLSL binding semantic of the same name defined on the varying inputs to a shader program. This language binding allows the use of the predefined Direct3D vertex declaration usage types and HLSL binding semantics listed in Table J.2.

The X3D browser implementation shall automatically assign appropriate internal index values for each attribute in the case where multiple nodes have the same value in the name field.

J.4 Data Type and Parameter Mappings

J.4.1 Node fields

Fields that are of type SFNode/MFNode are ignored unless the value is of type X3DTextureNode, X3DMaterialNode, or X3DLightNode. Field instances of type X3DTextureNode are mapped according to the appropriate Direct3D sampler data type. The mapping from texture nodes to built-in sampler types is defined in Table J.3.

X3D does not define mappings to the HLSL types sampler1D, sampler1DShadow and sampler2DShadow.

Field instances of type X3DMaterialNode and X3DLightNode are mapped to structures that shall be declared in the shader program as defined in Table J.4.

struct X3DMaterial {
    float4 diffuseColor;
    float4 ambientColor;
    float4 specularColor;
    float4 emissiveColor;
    float power;
};

struct X3DLight {
    int type;
    float4 diffuseColor;
    float4 specularColor;
    float4 ambientColor;
    point3 position;
    point3 direction;
    float range;
    float falloff;
    float attenuation0;
    float attenuation1;
    float attenuation2;
    float theta;
    float phi;
    bool on;
};

J.4.2 X3D field types to HLSL data types

Table J.5 specifies the mapping of X3D field types to data types used in the HLSL Language.

HLSL defines maximum supported lengths of each array data type, which may conflict with the minimum support requirements for X3D.

J4.3 X3D world state to HLSL parameter names

Certain internal states of the X3D world, such as transformation matrices, or the viewer's position in world space, are neither readily available via the HLSL shader program nor directly accessible from the X3D scene graph. Thus, if used, these state values shall be explicitly passed in to the shader program as named parameters. This binding defines an automatic mapping of these states to predefined shader program parameter names. Table J.6 defines the mapping of internal states of the X3D world to parameter names used in HLSL programs.

The following suffixes can be applied to the matrix built-in values. A suffix of I signifies the inverse of the matrix. T signifies the transpose of the matrix. IT signifies the inverse transpose of the matrix.

J.5 Event model

J.5.1 Changing URL fields

When the url receives an event changing the value, the X3D browser shall immediately attempt to download the new source. Upon successful download, the browser shall attempt to compile the new source and issue the appropriate LoadSensor events. It shall not automatically activate the shader program, nor disable the currently running shader.

Values defined at load time of the file do not require an explicit request to activate the shader program. The X3D browser shall be assumed to automatically activate the program once all the objects have successfully downloaded. If some of the shader source files are not downloaded or compiled ( e.g., due to errors) no activation will occur for the shader program.

J.5.2 Changing the attrib field

Per-vertex attributes may be defined as one of the fields of X3DComposedGeometryNode. These may be changed at runtime by adding or removing node instances. Adding new node instances to the field shall require that the user request an explicit activate in order to make them visible to the shader.

J.5.3 Activating programs

The user may, at any time, request that the X3D browser activate the composing shader objects by sending a TRUE value to the activate inputOnly field of the ProgramShader or PackagedShader node. Users may need to force a re-activation of the node under various circumstances, such as changing the url field of one or more ShaderProgram or PackagedShader nodes, or adding or removing ShaderProgram nodes from the programs field of the ProgramShader node. Reactivating the shader shall replace the existing shader with the new compiled shader for subsequent rendering.