RenderTarget Class Reference
#include <material.h>
Class Description
RenderTarget is an abstraction of an OpenGL renderbuffer object.
You can attach multiple textures to the different 'slots' of this RenderTarget, to do multi-target rendering. Textures attached to slot0, slot1, slot2 and slot3 will all get the color; A Texture attached to slotDepth would get the zbuffer.
Definition at line 1048 of file material.h.
Inheritance diagram for RenderTarget:
Public Member Functions | |
| virtual void | DrawTexture (const class Texture *pTexture) |
| Paints the given texture into the rendertarget, stretching or shrinking it to fill the available space. More... | |
| virtual bool | Attach (mudbox::Texture *pTexture, Slot eSlot=eSlotColor0) |
| Attaches a texture to the RenderTarget. More... | |
| virtual void | Detach (Slot eSlot=eSlotColor0) |
| Detaches a texture from a slot in the rendertarget. More... | |
| virtual mudbox::Texture * | Texture (Slot eSlot=eSlotColor0) const |
| Returns the attached texture at a given slot. More... | |
| virtual unsigned int | Width (void) const |
| Returns the width of the rendertarget in pixels. More... | |
| virtual unsigned int | Height (void) const |
| Returns the height of the rendertarget in pixels. More... | |
| virtual void | SetSize (unsigned int iWidth, unsigned int iHeight) |
| Sets the size of the rendertarget in pixels. More... | |
| virtual void | Activate (void) |
| Makes this rendertarget active, but saves the previous one. More... | |
| virtual void | Restore (void) |
| Restores the previous rendertarget. More... | |
| virtual void | SetMultisampling (bool bMultisampling) |
| Public Member Functions inherited from Node | |
| Node (const QString &sStringID="", const QString &sDisplayName="") | |
| Standard constructor. More... | |
| virtual | ~Node (void) |
| virtual void | Initialize (void) |
| void | LoadTemplate (const QString &sFileName="", bool bStartEvent=false) |
| Use an external XML file to initialize the attributes. More... | |
| void | SaveTemplate (const QString &sFileName="", bool bSaveOnlyVisible=false) |
| Save current attributes as an XML template. More... | |
| unsigned int | Version (void) const |
| Returns the current version of the node. This number increases when the content of the node changed (when ContentChanged() called). More... | |
| void | SetVersion (unsigned int iVersion) |
| Sets the current version number for the node. More... | |
| unsigned int | ReferenceCount (void) const |
| Returns the number of pointers referencing this node. More... | |
| Attribute * | ReferencePointer (unsigned int iIndex) const |
| Returns the address of an attribute which refers to this node. The type of the attribute is always aptr. More... | |
| Node * | ReferenceNode (unsigned int iIndex) const |
| Returns the address of a node referencing this node. More... | |
| virtual QString | Name (const ClassDesc *pClass=0) const |
| Deprecated. More... | |
| virtual void | SetName (const QString &sName) |
| Deprecated. More... | |
| virtual QString | StringID (const ClassDesc *pClass=0) const |
| Returns the string id of the node. More... | |
| virtual void | SetStringID (const QString &sStringID) |
| Sets the string id of the node. More... | |
| virtual QString | DisplayName (void) const |
| Returns the display name of the node. More... | |
| virtual void | SetDisplayName (const QString &sDisplayName) |
| Sets the display name of the node. More... | |
| virtual QString | HelpID (void) const |
| Returns the help entry id of the node. Can be overwritten in derived classes. More... | |
| virtual void | SetHelpID (const QString &sHelpID) |
| Sets the help entry id of the node. More... | |
| void | Annex (Node *pSource, const QString &sCategory="") |
| Relink all the attributes of the source node to this one. More... | |
| virtual void | Serialize (Stream &s) |
| Serializes the node. More... | |
| bool | IsKindOf (const ClassDesc *pClass) const |
| Returns true if this node is derived from the pClass class. More... | |
| void | ContentChanged (void) const |
| This function must be called if the content of the node is changed. More... | |
| virtual void | CheckValidity (DiagnosticLevel iLevel=dgnLevel2) const |
| Checks the validity of this node. More... | |
| virtual void | CopyTo (Node *pNode) const |
| virtual Node * | Duplicate (void) const |
| virtual void | OnNodeEvent (const Attribute &cAttribute, NodeEventType cType) |
| This function is called if an event occurs with any of the attributes of the node. More... | |
| virtual void | OnEvent (const EventGate &cEvent) |
| This function is called when a generic event occurs. See EventGate class. More... | |
| void | RequestDeferredEvent (Attribute &cAttribute) |
| Request for a deferred event, which will occur only in the main loop. More... | |
| unsigned int | AttributeCount (void) const |
| Returns the number of attributes owned by the node. More... | |
| Attribute * | AttributeByIndex (int iIndex) const |
| Returns a specified attribute (or 0 if iIndex is greater than the number of attributes). More... | |
| Attribute * | AttributeByName (const QString &sName) const |
| Returns a specified attribute by its name. Returns 0 if the attribute not found. More... | |
| Attribute * | AttributeByID (const QString &sID) const |
| Returns a specified attribute by its ID. Returns 0 if the attribute not found. More... | |
| void | SetAttributeValue (const QString &sAttributeID, const QString &sNewValue) |
| Set the value of an attribute from a string. More... | |
| QString | AttributeValue (const QString &sAttributeID) const |
| Returns the current value of an attribute as a string. More... | |
| void | LogAttributes (void) const |
| Write all attributes into the log file. More... | |
| virtual QWidget * | CreatePropertiesWindow (QWidget *pParent) |
| Create a window which displays the attributes of the node. Can be overriden to provide a custom interface. More... | |
| Attribute * | AddAttribute (Attribute::AttributeType type, const QString &id) |
| Allows SDK users to add attributes at runtime. More... | |
| Node * | Next (void) const |
| Returns the next node in the chain. Used to enumerate the current nodes. See also First(). More... | |
| int | ID (void) const |
| Returns an ID for the node. The ID is unique in the whole application life. More... | |
| bool | SetID (int iID) |
| Set ID for the node. More... | |
Additional Inherited Members | |
| Public Types inherited from Node | |
| enum | DiagnosticLevel { dgnLevel1, dgnLevel2, dgnLevel3 } |
| Indicates the level of validity checking that is performed in CheckValidity() More... | |
| Static Public Member Functions inherited from Node | |
| static void | StartHashing () |
| This is called once in main once static ctors are done. More... | |
| static Node * | First (void) |
| This function will return the first node in the memory. Used to enumerate all the current nodes. See also Next(). More... | |
| static Node * | ByID (int iID) |
| Returns the node with the specified ID, or zero if such a node does not exists. More... | |
| static Node * | ByName (const QString &sClass, const QString &sName) |
| Search for a node with the name sName. More... | |
| Public Attributes inherited from Node | |
| AttributeThisPointer | m_pThis |
| DECLARE_CLASS | |
Member Function Documentation
Paints the given texture into the rendertarget, stretching or shrinking it to fill the available space.
|
virtual |
Attaches a texture to the RenderTarget.
The texture must have exactly the same size as the target.
- Parameters
-
[in] pTexture The texture to be attached to the RenderTarget [in] eSlot The slot to attach it to
|
virtual |
Detaches a texture from a slot in the rendertarget.
- Parameters
-
[in] eSlot The slot to detach a texture from
|
virtual |
Returns the attached texture at a given slot.
- Parameters
-
[in] eSlot The id for the slot being queried
Returns the height of the rendertarget in pixels.
Sets the size of the rendertarget in pixels.
|
virtual |
Set Multisample tag. To be removed.
The documentation for this class was generated from the following file:
- Mudbox/material.h