|
|
Each DXSAS compliant effect must define, as a minimum, a single global effect parameter with the global semantic. The global parameter can also use one or more optional annotations. The syntax is as follows:
int VariableName : SasGlobal
<
SasVersion
[OptionalAnnotations]
>;
where:
The only required annotation is SasVersion. It is declared like this:
int3 SasVersion = { major, minor, revision };
where:
The current version is 1.0.0. There is no default value for this annotation.
This declares the person who created the effect. It is declared like this:
string SasEffectAuthor = "value";
where value is a string that identifies the effect author. The default is an empty string.
This declares the software that the effect was authored on. It is declared like this:
string SasEffectAuthoringSoftware = "value";
where value is a string that identifies the effect authoring software. The default is an empty string.
This declares the effect category. It is declared like this:
string SasEffectCategory = "value";
where value is a string that identifies the effect category. The default is an empty string. The category is expressed via a path-like value using the forward slash as a delimiter. Effects can only belong to one category as there is no syntax for expressing inclusion in multiple paths within a single SasEffectCategory value. The value of this annotation is not treated as case-sensitive by the host application.
This declares the company that created the effect. It is declared like this:
string SasEffectCompany = "value";
where value is a string that identifies the name of the company that owns the effect. The default is an empty string.
This describes the effect. It is declared like this:
string SasEffectDescription = "value";
where value is a string that describes the effect. The default is an empty string.
This is a help string that can be displayed to the user whenever help on the associated effect is requested. It is declared like this:
string SasEffectHelp = "value";
where value is a string that can be displayed if the user requests help. The default is an empty string.
This annotation allows tools and users to record the revision number of the associated effect file. For example, users could insert appropriate keywords in the value of this annotation to invoke keyword substitution in their favorite revision control software. It is declared like this:
string SasEffectRevision = "value";
where value is a string that identifies the effect revision. The default is an empty string.
Here is an example that uses only the single, required annotation:
int gp : SasGlobal
<
int3 SasVersion = {1,0,0};
>;
Here is an example that uses the required annotation and several optional annotations:
int gp : SasGlobal
<
int3 SasVersion = {1,0,0};
string SasEffectAuthoring = "Mike's Shader";
string SasEffectAuthoringSoftware = "fxe 2.5.4";
string SasEffectCategory = "/surface/procedural/wood";
string SasEffectCompany = "Microsoft Corporation";
string SasEffectDescription = "Renders an irridescent surface.";
string SasEffectHelp = "For more information, see http://somelocation/skin.htm";
string SasEffectRevision = "$Revision$";
>;