Ogre::GpuSharedParametersUsage Class Reference
Core » Materials

This class records the usage of a set of shared parameters in a concrete set of GpuProgramParameters. More...

`#include <OgreGpuProgramParams.h>`

Inheritance diagram for Ogre::GpuSharedParametersUsage:
[legend]

## Classes

struct | CopyDataEntry

## Public Member Functions

| GpuSharedParametersUsage (GpuSharedParametersPtr sharedParams, GpuProgramParameters *params)
| Construct usage. More...
void | _copySharedParamsToTargetParams ()
| Update the target parameters by copying the data from the shared parameters. More...
const Any & | _getRenderSystemData () const
| Internal method that the RenderSystem might use to store optional data. More...
void | _setRenderSystemData (const Any &data) const
| Internal method that the RenderSystem might use to store optional data. More...
const String & | getName () const
| Get the name of the shared parameter set. More...
GpuSharedParametersPtr | getSharedParams () const
GpuProgramParameters * | getTargetParams () 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)

## Protected Types

typedef vector< CopyDataEntry >::type | CopyDataList

## Protected Member Functions

void | initCopyData ()

## Protected Attributes

CopyDataList | mCopyDataList
unsigned long | mCopyDataVersion
| Version of shared params we based the copydata on. More...
GpuProgramParameters * | mParams
Any | mRenderSystemData
GpuSharedParametersPtr | mSharedParams

## Detailed Description

This class records the usage of a set of shared parameters in a concrete set of GpuProgramParameters.

Definition at line 619 of file OgreGpuProgramParams.h.

## Member Typedef Documentation

## CopyDataList

typedef vector<CopyDataEntry>::type Ogre::GpuSharedParametersUsage::CopyDataList

protected

Definition at line 631 of file OgreGpuProgramParams.h.

## Constructor & Destructor Documentation

## GpuSharedParametersUsage()

Ogre::GpuSharedParametersUsage::GpuSharedParametersUsage | ( | GpuSharedParametersPtr | sharedParams,
|  | GpuProgramParameters * | params
| ) |  |

Construct usage.

## Member Function Documentation

## _copySharedParamsToTargetParams()

void Ogre::GpuSharedParametersUsage::_copySharedParamsToTargetParams | ( |  | ) |

Update the target parameters by copying the data from the shared parameters.

Note
  This method may not actually be called if the RenderSystem supports using shared parameters directly in their own shared buffer; in which case the values should not be copied out of the shared area into the individual parameter set, but bound separately.

## _getRenderSystemData()

const Any& Ogre::GpuSharedParametersUsage::_getRenderSystemData | ( |  | ) | const

Internal method that the RenderSystem might use to store optional data.

Definition at line 667 of file OgreGpuProgramParams.h.

## _setRenderSystemData()

void Ogre::GpuSharedParametersUsage::_setRenderSystemData | ( | const Any & | data | ) | const

Internal method that the RenderSystem might use to store optional data.

Definition at line 665 of file OgreGpuProgramParams.h.

## getName()

const String& Ogre::GpuSharedParametersUsage::getName | ( | void |  | ) | const

Get the name of the shared parameter set.

Definition at line 659 of file OgreGpuProgramParams.h.

References Ogre::GpuSharedParameters::getName().

## getSharedParams()

GpuSharedParametersPtr Ogre::GpuSharedParametersUsage::getSharedParams | ( |  | ) | const

Definition at line 661 of file OgreGpuProgramParams.h.

## getTargetParams()

GpuProgramParameters* Ogre::GpuSharedParametersUsage::getTargetParams | ( |  | ) | const

Definition at line 662 of file OgreGpuProgramParams.h.

## initCopyData()

void Ogre::GpuSharedParametersUsage::initCopyData | ( |  | ) |

protected

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## Member Data Documentation

## mCopyDataList

CopyDataList Ogre::GpuSharedParametersUsage::mCopyDataList

protected

Definition at line 633 of file OgreGpuProgramParams.h.

## mCopyDataVersion

unsigned long Ogre::GpuSharedParametersUsage::mCopyDataVersion

protected

Version of shared params we based the copydata on.

Definition at line 639 of file OgreGpuProgramParams.h.

## mParams

GpuProgramParameters* Ogre::GpuSharedParametersUsage::mParams

protected

Definition at line 624 of file OgreGpuProgramParams.h.

## mRenderSystemData

Any Ogre::GpuSharedParametersUsage::mRenderSystemData

mutable protected

Definition at line 636 of file OgreGpuProgramParams.h.

## mSharedParams

GpuSharedParametersPtr Ogre::GpuSharedParametersUsage::mSharedParams

protected

Definition at line 622 of file OgreGpuProgramParams.h.

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

- OgreGpuProgramParams.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.