Type

Tag

Description

xml

<name>

This tag specifies the name your effect should be displayed under.

Without this tag, the effect will display a filename ending in .FX, for example: ExampleShader.fx

xml

<description>

This tag specifies what description should appear under your effect. It should include what the effect does.

If you're using LLM descriptions, check for zero-width spaces and other inconsistencies. Don't assume LLM knows what it's talking about.

xml

<author>

This tag displays who created the shader. 

Enter your name or nickname here.

If your effect is partially based on someone else's work, you should also include credit for that person(s).

xml

<copyright>

This tag identifies the author's copyright notice.

xml

<company>

This tag displays information about the company.

(If you're not in one, don't add this tag.)

xml

<website>

This tag should contain information about your website; you can also insert a link to your GitHub here.

(Optional but recommended)

xml

<email>

This tag should contain a valid email address to contact the author.

(Optional but recommended)

xml

<dx8>

This tag should contain "yes" or "no" if your effect works under Direct3D 8 (the .FX file must be written in assembler).

(You can also indicate that it supports by inserting "1", another number sets it as "no")

It is not recommended to write the effect for D3D8 because it further limits the D3D9 effect, making it impossible to create advanced effects.

xml

<PSVersion>

If your effect is running in D3D8, the "Ps" column doesn't display the required pixel shader. Set this tag to "1.1" if your effect uses ps.1.1, "1.2" if ps.1.2, etc., to display the information.

If your effect doesn't run in D3D8, set it to "auto".

xml

<VSVersion>

Similar to <PSVersion>, but there is no separate category for "Vs" (Vertex Shader) in the shader list.

xml

<BackgroundTexture>

If your effect should use a background texture, set the tag to "1", otherwise set it to "0".

xml

<zbuffer>

If your shader uses Z-Buffer (aka. "DEPTH", "VS_DEPTH"), set this to "1" so that the shader can use the buffer, otherwise set it to "0".

(Currently only works for D3D9)

xml

<sourcecode>

In this tag, you can place the entire D3D8/D3D9 code, so instead of having .XML and .FX files, you can have only the .XML file.

Example:
<sourcecode>
<![CDATA[
/* Shader DX8/DX9 here */
]]>
</sourcecode>

(It is not recommended using this metod)

Type

Tag

Description

Value

xml

<parametr>

This tag defines a new parameter that the shader allows to be modified.

(None)

xml

<name>

In this tag, it specifies the name of the parameter.

(Any* Characters must be from the ASCII table)

xml

<code>

xml

<variable>

Declaration of the variable name that you will refer to in the shader.

xml

<description>

Description of what a given parameter does in the shader.

xml

<type>

The type that your variable specifies

int for Intergers or Flags;

float for Floats;

int_float4 for Colors;

image for Texture;

xml

<property>

This tag determines how data is entered into the variable.

edit for entering a number like a textbox (only when <type> is int or float);

spin for entering a number that you can add or subtract with the arrows (only when <type> is int or float);

slider for a slider where you can change the number (only when <type> is int or float);

checkbox for a bool variable, i.e. 0 or 1 (only when <type> is int);

color for RGBA color variable (only when <type> is int_float4);

image for texture variable (only when <type> is image);

xml

<value>

The tag specifies what default value the parameter should have.

32-bit number (only when <type> is int, float or int_float4);
0 or 1 (only when <type> is int and when <property> is checkbox);
Path to texture file (only when <type> is image);

xml

<preview_value>

The tag sets a preview value only in the effects selection window.

xml

<min>

Specifies the minimum value that can be set in the Properties window (this does not work when setting the value from the Event Editor);

It also requires that the <property> tag be either slider or spin.

32-bit number (only when <type> is int or float);

xml

<max>

Specifies the maximum value that can be set in the Properties window (this does not work when setting the value from the Event Editor);

It also requires that the <property> tag be either slider or spin.

xml

<delta>

Specifies the step value when changing the value via arrows when <type> is float and <property> is spin.

32-bit number (only when <type> is float);

Type

Tag

Description

Value

xml

<sampler>

In this tag it declares the sampler settings for how the texture should be rendered

(None)

xml

<index>

In this tag, set the texture index value as you have it in the shader; 0 for Self texture; 1, 2, 3 for separate, etc.

(Unsigned 32-Bit integer value)

xml

<filter>

The tag specifies how pixels are to be interpolated between each other.

point for Nearest-Point Sampling / Pixelated (only for Direct3D 9 and Direct3D 11);

linear for Bilinear Filtering / Antialiasing (only for Direct3D 9 and Direct3D 11);

anisotropic for Anisotropic Filtering (only for Direct3D 9);

xml

<addressU>

This tag specifies how the graphics card should interpret U' (X axis for texCoord) which is outside the range of 0 to 1.

clamp for stretched values ​​outside the range 0 to 1;

wrap for looping values ​​outside the range 0 to 1;

mirror for looping values ​​outside the range 0 to 1 and mirroring;

border for using the color from the <bordercolor> tag when the coordinate is outside the range of 0 to 1;

xml

<addressV>

This tag specifies how the graphics card should interpret V' (Y axis for texCoord) which is outside the range of 0 to 1.

xml

<addressW>

This tag specifies how the graphics card should interpret W' (Z axis for texCoord) which is outside the range of 0 to 1.

xml

<bordercolor>

The color that will be used when texCoord goes outside the range of 0 to 1;

(Unsigned 32-Bit integer value) Same rule as int_float4;