C# Class EffectEditor.EffectComponents.EffectComponent

An effect component - a function and information about return values
Inheritance: IComparable
Datei anzeigen Open project: vchelaru/FlatRedBall Class Usage Examples

Public Properties

Property Type Description
AvailableToPixelShader bool
AvailableToVertexShader bool
Code String
IsInline bool
MinimumPixelShaderProfile string
MinimumVertexShaderProfile string
Name String
Parameters List
ReturnType List

Public Methods

Method Description
CompareTo ( object obj ) : int
EffectComponent ( ) : System

Creates an empty effect component
FromFile ( String fileName ) : EffectComponent

Loads an effect component from file
FunctionHelperString ( ) : String

Gets a string to help with coding
FunctionString ( ) : String

Gets the function as a string
OutputStruct ( ) : String

Gets the output structure definition as a string
Save ( String fileName ) : void

Saves the component to a file
ToString ( ) : string

Method Details

CompareTo() public method

public CompareTo ( object obj ) : int
obj object
return int

EffectComponent() public method

Creates an empty effect component
public EffectComponent ( ) : System
return System

FromFile() public static method

Loads an effect component from file
public static FromFile ( String fileName ) : EffectComponent
fileName String The name of the file
return EffectComponent

FunctionHelperString() public method

Gets a string to help with coding
public FunctionHelperString ( ) : String
return String

FunctionString() public method

Gets the function as a string
public FunctionString ( ) : String
return String

OutputStruct() public method

Gets the output structure definition as a string
public OutputStruct ( ) : String
return String

Save() public method

Saves the component to a file
public Save ( String fileName ) : void
fileName String The name of the file
return void

ToString() public method

public ToString ( ) : string
return string

Property Details

AvailableToPixelShader public_oe property

Whether or not this component is available to a pixel shader
public bool AvailableToPixelShader
return bool

AvailableToVertexShader public_oe property

Whether or not this component is available to a vertex shader
public bool AvailableToVertexShader
return bool

Code public_oe property

The code for this component, without the function signature (this is auto-generated)
public String Code
return String

IsInline public_oe property

Whether or not the function should be inline
public bool IsInline
return bool

MinimumPixelShaderProfile public_oe property

The minimum pixel shader profile required to run this component (if available to pixel shaders)
public string MinimumPixelShaderProfile
return string

MinimumVertexShaderProfile public_oe property

The minimum vertex shader profile required to run this component (if available to vertex shaders)
public string MinimumVertexShaderProfile
return string

Name public_oe property

the name of this component Spaces are not allowed
public String Name
return String

Parameters public_oe property

The parameters required by this component
public List Parameters
return List

ReturnType public_oe property

The return type of this component (always a struct for simplicity on the backend)
public List ReturnType
return List