C++ API Reference
MUniformParameterList Class Reference

Uniform Parameter. More...

#include <MUniformParameterList.h>

Public Member Functions

 MUniformParameterList ()
 Create a new, empty list of uniform parameters.
 
 ~MUniformParameterList ()
 Class destructor.
 
 MUniformParameterList (const MUniformParameterList &src)
 Copy constructor.
 
void append (const MUniformParameter &element)
 Append a new parameter to this end of this list. More...
 
int length () const
 Get the number of parameters in this list. More...
 
void setLength (int n)
 Set the number of parameters in this list. More...
 
MUniformParameter getElement (int n) const
 Get the nth parameter in this list. More...
 
void setElement (int n, const MUniformParameter &p)
 Get the nth parameter in this list. More...
 
const MUniformParameterListoperator= (const MUniformParameterList &other)
 Assignment operator. More...
 

Detailed Description

Uniform Parameter.

MUniformParameterArray specify the list of uniform shader parameters used by a hardware shader, allowing Maya to handle setting up the node and user interfaces to the data, the population and access of cached data, etc.

Examples:
dx11Shader/dx11Shader.cpp, dx11Shader/dx11Shader.h, glslShader/GLSLShader.h, and hlslShader/hlslShader.h.

Member Function Documentation

void append ( const MUniformParameter element)

Append a new parameter to this end of this list.

Parameters
[in]elementThe new parameter to append
Examples:
dx11Shader/dx11Shader.cpp.
int length ( ) const

Get the number of parameters in this list.

Returns
The number of parameters in this list.
Examples:
dx11Shader/dx11Shader.cpp.
void setLength ( int  n)

Set the number of parameters in this list.

If this is greater than the current number of parameters in the list, the caller is responsible for setting the new parameters to valid values using setElement.

Parameters
[in]nThe number of parameters in this list.
MUniformParameter getElement ( int  n) const

Get the nth parameter in this list.

Parameters
[in]nthe index of the element to return
Returns
The nth parameter in the list
Examples:
dx11Shader/dx11Shader.cpp.
void setElement ( int  n,
const MUniformParameter p 
)

Get the nth parameter in this list.

Parameters
[in]nthe index of the element to return
[out]pthe requested parameter
Returns
The nth parameter in the list
const MUniformParameterList & operator= ( const MUniformParameterList src)

Assignment operator.

Parameters
[in]srcRight operand.

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