Difference between revisions of "Effect FX Composer 2 extension"

From COLLADA Public Wiki
Jump to: navigation, search
(experiment with inserting new template)
(Undo revision 7092 by LLutz74 (talk))
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{extensions|company=NVIDIA|product=FX Composer 2}}
+
{{extension|company=NVIDIA|product=FX Composer 2}}
{{extensions
+
 
| company = yourcompanyname
+
==<import> Element==
| product = yourproductname}}
 
 
'''Category:''' <!-- fill in  --> (See [[list of specification categories]])
 
'''Category:''' <!-- fill in  --> (See [[list of specification categories]])
  
 
'''Introduction:''' <!-- fill in one sentence starting with a verb that describes purpose of this element -->
 
'''Introduction:''' <!-- fill in one sentence starting with a verb that describes purpose of this element -->
 +
Custom HLSL and CGFX Profiles for FX Composer.
  
==Concepts==
+
===Concepts===
 
<!-- Background info needed to understand this element's purpose and place within COLLADA -->
 
<!-- Background info needed to understand this element's purpose and place within COLLADA -->
 +
This <extra> at the <effect> level defines an effect with a direct reference to an external <code>.fx or .cgfx</code> file.
 +
It also includes compiler options for the specified effect file and can appear more than one time in the case of multiple profiles.
  
==Attributes==
+
===Attributes===
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|-
 
|-
 
!Name||Type||Description||Required?
 
!Name||Type||Description||Required?
 
|-
 
|-
|example||xs:token||A text string value that specifies blah.||Yes
+
| url || ||The url of the effect file to import.||  
 +
|-
 +
| compiler_options || || Compiler options for the specified file ||
 +
|-
 +
| profile || || The name of the profile (fx or cgfx) ||
 +
|-
 
|}
 
|}
 
+
===Related Elements===
==Related Elements==
 
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|-
 
|-
 
!Parent element(s)
 
!Parent element(s)
|list_here
+
|<effect>
 
|-
 
|-
 
!Extra and/or Technique
 
!Extra and/or Technique
|fill_in--e.g., <extra type="foo">/<technique profile="BAR">
+
|<extra type="import">/<technique profile="NVIDIA_FXCOMPOSER">
 
|-
 
|-
 
!Child elements
 
!Child elements
|list_here or state None
+
|None
 
|-
 
|-
 
!Other
 
!Other
Line 34: Line 40:
 
|}
 
|}
  
==Child Elements==
+
===Details===
{| {{prettytable}}
 
|-
 
!Name||Description||Default||Occurrences
 
|-
 
|Example||Specifies foo.||N/A||0 or more
 
|}
 
 
 
==Details==
 
 
<!-- Additional info about how and where to use the element (and its children), lists of additional relevant links, detailed value tables for element or attribute values, etc. -->
 
<!-- Additional info about how and where to use the element (and its children), lists of additional relevant links, detailed value tables for element or attribute values, etc. -->
  
==Examples==
+
=== Example ===
<!-- Really required. -->
 
== Custom HLSL and CGFX Profiles for FX Composer ==
 
This <extra> at the <effect> level defines an effect with a direct reference to an external <code>.fx or .cgfx</code> file.
 
It also includes compiler options for the specified effect file and can appear more than one time in the case of multiple profiles.
 
 
 
{| border=1 cellspacing=0 cellpadding=3 align=center
 
|-
 
!width=20%| Attribute !! Description
 
|-
 
| url || The url of the effect file to import.
 
|-
 
| compiler_options || Compiler options for the specified file
 
|-
 
| profile || The name of the profile (fx or cgfx)
 
|-
 
|}
 
 
 
== Example ==
 
 
  <effect id="Effect1" name="Gooch">
 
  <effect id="Effect1" name="Gooch">
 
     <profile_COMMON>
 
     <profile_COMMON>

Latest revision as of 18:03, 26 September 2011

Extension information
  • Purpose: unstated
  • Company(s): NVIDIA
  • Product(s): FX Composer 2
  • Last updated: unstated
  • Contact for technical issues:
This article is part of the COLLADA extensions directory
Adding to the extensions directory

<import> Element

Category: (See list of specification categories)

Introduction: Custom HLSL and CGFX Profiles for FX Composer.

Concepts

This <extra> at the <effect> level defines an effect with a direct reference to an external .fx or .cgfx file. It also includes compiler options for the specified effect file and can appear more than one time in the case of multiple profiles.

Attributes

Name Type Description Required?
url The url of the effect file to import.
compiler_options Compiler options for the specified file
profile The name of the profile (fx or cgfx)

Related Elements

Parent element(s) <effect>
Extra and/or Technique <extra type="import">/<technique profile="NVIDIA_FXCOMPOSER">
Child elements None
Other list any other relevant elements

Details

Example

<effect id="Effect1" name="Gooch">
   <profile_COMMON>
       <technique sid="__fxc2_default">
           <constant/>
       </technique>
   </profile_COMMON>
   <extra type="import">
       <technique profile="NVIDIA_FXCOMPOSER">
           <import url="../Projects/Gooch.cgfx" compiler_options="" profile="cgfx"/>
       </technique>
   </extra>
</effect>