OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::FloatGpuParameterControllerValue Class Reference

Predefined controller value for setting a single floating- point value in a constant parameter of a vertex or fragment program. More...

#include <OgrePredefinedControllers.h>

+ Inheritance diagram for Ogre::FloatGpuParameterControllerValue:
+ Collaboration diagram for Ogre::FloatGpuParameterControllerValue:

Public Member Functions

 FloatGpuParameterControllerValue (GpuProgramParametersSharedPtr params, size_t index)
 Constructor. More...
 
 ~FloatGpuParameterControllerValue ()
 
Real getValue (void) const
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
void setValue (Real value)
 

Protected Attributes

size_t mParamIndex
 The index of the parameter to be read or set. More...
 
GpuProgramParametersSharedPtr mParams
 The parameters to access. More...
 

Detailed Description

Predefined controller value for setting a single floating- point value in a constant parameter of a vertex or fragment program.

Remarks
Any value is accepted, it is propagated into the 'x' component of the constant register identified by the index. If you need to use named parameters, retrieve the index from the param object before setting this controller up.
Note
Retrieving a value from the program parameters is not currently supported, therefore do not use this controller value as a source, only as a target.

Definition at line 144 of file OgrePredefinedControllers.h.

Constructor & Destructor Documentation

Ogre::FloatGpuParameterControllerValue::FloatGpuParameterControllerValue ( GpuProgramParametersSharedPtr  params,
size_t  index 
)

Constructor.

Parameters
paramsThe parameters object to access
indexThe index of the parameter to be set
Ogre::FloatGpuParameterControllerValue::~FloatGpuParameterControllerValue ( )
inline

Definition at line 161 of file OgrePredefinedControllers.h.

Member Function Documentation

Real Ogre::FloatGpuParameterControllerValue::getValue ( void  ) const
virtual
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::FloatGpuParameterControllerValue::setValue ( Real  value)
virtual

Member Data Documentation

size_t Ogre::FloatGpuParameterControllerValue::mParamIndex
protected

The index of the parameter to be read or set.

Definition at line 150 of file OgrePredefinedControllers.h.

GpuProgramParametersSharedPtr Ogre::FloatGpuParameterControllerValue::mParams
protected

The parameters to access.

Definition at line 148 of file OgrePredefinedControllers.h.


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