Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.ShaderKit Class Reference

The ShaderKit class is a user space object. It is used for specifying all settings related to a ShaderDefinition. More...

Inheritance diagram for HPS.ShaderKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
 ShaderKit ()
 The default constructor creates an empty ShaderKit object. More...
 
 ShaderKit (HPS.ShaderKit in_kit)
 The copy constructor creates a new ShaderKit object that contains the same settings as the source ShaderKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.ShaderKit in_kit)
 Copies the source ShaderKit into this ShaderKit. More...
 
void Show (out HPS.ShaderKit out_kit)
 Copies this ShaderKit into the given ShaderKit. More...
 
override bool Empty ()
 Indicates whether this ShaderKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.ShaderKit in_kit)
 Check if the source ShaderKit is equivalent to this ShaderKit. More...
 
HPS.ShaderKit SetSource (string in_source)
 Sets the source code for the shader. More...
 
HPS.ShaderKit SetMultitexture (bool in_state)
 Sets whether to apply diffuse textures from layers greater than <span class='code>0 on top of the shader when it is applied to geometry. More...
 
HPS.ShaderKit SetParameterizationSource (HPS.Shader.Parameterization in_source)
 Sets the parameterization source for the shader. More...
 
HPS.ShaderKit SetTransformMatrix (HPS.MatrixKit in_transform)
 Sets the transform matrix for the shader. More...
 
HPS.ShaderKit UnsetSource ()
 Removes the source code for the shader. More...
 
HPS.ShaderKit UnsetMultitexture ()
 Removes whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. More...
 
HPS.ShaderKit UnsetParameterizationSource ()
 Removes the parameterization source for the shader. More...
 
HPS.ShaderKit UnsetTransformMatrix ()
 Removes the transform matrix for the shader. More...
 
HPS.ShaderKit UnsetEverything ()
 Removes all settings from this ShaderKit. More...
 
bool ShowSource (out string out_source)
 Shows the source code for the shader. More...
 
bool ShowMultitexture (out bool out_state)
 Shows whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. More...
 
bool ShowParameterizationSource (out HPS.Shader.Parameterization out_source)
 Shows the parameterization source for the shader. More...
 
bool ShowTransformMatrix (out HPS.MatrixKit out_transform)
 Shows the transform matrix for the shader. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static bool operator== (HPS.ShaderKit a, HPS.ShaderKit b)
 
static bool operator!= (HPS.ShaderKit a, HPS.ShaderKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The ShaderKit class is a user space object. It is used for specifying all settings related to a ShaderDefinition.

Constructor & Destructor Documentation

HPS.ShaderKit.ShaderKit ( )
inline

The default constructor creates an empty ShaderKit object.

HPS.ShaderKit.ShaderKit ( HPS.ShaderKit  in_kit)
inline

The copy constructor creates a new ShaderKit object that contains the same settings as the source ShaderKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shader_kit" kindref="compound">ShaderKit</ref> to copy.

Member Function Documentation

override bool HPS.ShaderKit.Empty ( )
inlinevirtual

Indicates whether this ShaderKit has any values set on it.

Returns
true if no values are set on this ShaderKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.ShaderKit.Equals ( HPS.ShaderKit  in_kit)
inline

Check if the source ShaderKit is equivalent to this ShaderKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shader_kit" kindref="compound">ShaderKit</ref> to compare to this <ref refid="class_h_p_s_1_1_shader_kit" kindref="compound">ShaderKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.ShaderKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.ShaderKit.Set ( HPS.ShaderKit  in_kit)
inline

Copies the source ShaderKit into this ShaderKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shader_kit" kindref="compound">ShaderKit</ref> to copy.
HPS.ShaderKit HPS.ShaderKit.SetMultitexture ( bool  in_state)
inline

Sets whether to apply diffuse textures from layers greater than <span class='code>0 on top of the shader when it is applied to geometry.

Parameters
in_stateWhether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. If true, the additional textures will be applied; if false, the addtional textures will not be applied.
Returns
A reference to this ShaderKit.
HPS.ShaderKit HPS.ShaderKit.SetParameterizationSource ( HPS.Shader.Parameterization  in_source)
inline

Sets the parameterization source for the shader.

Parameters
in_sourceThe parameterization source for the shader.
Returns
A reference to this ShaderKit.
HPS.ShaderKit HPS.ShaderKit.SetSource ( string  in_source)
inline

Sets the source code for the shader.

Parameters
in_sourceThe source code for the shader.
Returns
A reference to this ShaderKit.
HPS.ShaderKit HPS.ShaderKit.SetTransformMatrix ( HPS.MatrixKit  in_transform)
inline

Sets the transform matrix for the shader.

Parameters
in_transformThe transform matrix for the shader.
Returns
A reference to this ShaderKit.
void HPS.ShaderKit.Show ( out HPS.ShaderKit  out_kit)
inline

Copies this ShaderKit into the given ShaderKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_shader_kit" kindref="compound">ShaderKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_shader_kit" kindref="compound">ShaderKit</ref>.
bool HPS.ShaderKit.ShowMultitexture ( out bool  out_state)
inline

Shows whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.

Parameters
out_statewhether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.
Returns
true if the flag is valid, false otherwise.
bool HPS.ShaderKit.ShowParameterizationSource ( out HPS.Shader.Parameterization  out_source)
inline

Shows the parameterization source for the shader.

Parameters
out_sourceThe parameterization source for the shader.
Returns
true if the parameterization source is valid, false otherwise.
bool HPS.ShaderKit.ShowSource ( out string  out_source)
inline

Shows the source code for the shader.

Parameters
out_sourceThe source code for the shader.
Returns
true if the source code is valid, false otherwise.
bool HPS.ShaderKit.ShowTransformMatrix ( out HPS.MatrixKit  out_transform)
inline

Shows the transform matrix for the shader.

Parameters
out_transformThe transform matrix for the shader.
Returns
true if the transform is valid, false otherwise.
HPS.ShaderKit HPS.ShaderKit.UnsetEverything ( )
inline

Removes all settings from this ShaderKit.

Returns
A reference to this ShaderKit.
HPS.ShaderKit HPS.ShaderKit.UnsetMultitexture ( )
inline

Removes whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.

Returns
A reference to this ShaderKit.
HPS.ShaderKit HPS.ShaderKit.UnsetParameterizationSource ( )
inline

Removes the parameterization source for the shader.

Returns
A reference to this ShaderKit.
HPS.ShaderKit HPS.ShaderKit.UnsetSource ( )
inline

Removes the source code for the shader.

Returns
A reference to this ShaderKit.
HPS.ShaderKit HPS.ShaderKit.UnsetTransformMatrix ( )
inline

Removes the transform matrix for the shader.

Returns
A reference to this ShaderKit.

The documentation for this class was generated from the following file: