API Documentation
ClearTargetsPass.h
1 // ClearTargetsPass.h
3 //
5 
6 namespace nkGraphics
7 {
14  class ClearTargetsPass : public Pass
15  {
16  public :
17 
18  // Getters
26  unsigned int getColorTargetIndex () const ;
30  float getClearDepthValue () const ;
34  unsigned char getClearStencilValue () const ;
38  bool getShouldClearColor () const ;
42  bool getShouldClearDepth () const ;
46  bool getShouldClearStencil () const ;
47 
48  // Setters
54  void setClearColor (const nkMaths::Vector& value) ;
60  void setColorTargetIndex (unsigned int value) ;
66  void setClearDepthValue (float value) ;
72  void setClearStencilValue (unsigned char value) ;
78  void setShouldClearColor (bool value) ;
84  void setShouldClearDepth (bool value) ;
90  void setShouldClearStencil (bool value) ;
91 
110  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
117  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
118  } ;
119 }
nkGraphics::ClearTargetsPass::setShouldClearDepth
void setShouldClearDepth(bool value)
nkGraphics::ClearTargetsPass::setColorTargetIndex
void setColorTargetIndex(unsigned int value)
nkGraphics::ClearTargetsPass::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkGraphics::ClearTargetsPass::getShouldClearDepth
bool getShouldClearDepth() const
nkGraphics::ClearTargetsPass::getClearColor
nkMaths::Vector getClearColor() const
nkGraphics::ClearTargetsPass::setShouldClearColor
void setShouldClearColor(bool value)
nkGraphics::ClearTargetsPass::setClearDepthValue
void setClearDepthValue(float value)
nkGraphics::ClearTargetsPass::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkGraphics::ClearTargetsPass
A clear target pass, during which some targets are cleared.
Definition: ClearTargetsPass.h:15
nkGraphics::ClearTargetsPass::setClearStencilValue
void setClearStencilValue(unsigned char value)
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkGraphics::ClearTargetsPass::getColorTargetIndex
unsigned int getColorTargetIndex() const
nkGraphics::ClearTargetsPass::getClearDepthValue
float getClearDepthValue() const
nkGraphics::Pass
The base for a pass within a TargetOperations.
Definition: Pass.h:15
nkGraphics::ClearTargetsPass::getShouldClearStencil
bool getShouldClearStencil() const
nkGraphics::ClearTargetsPass::getShouldClearColor
bool getShouldClearColor() const
nkGraphics::ClearTargetsPass::setShouldClearStencil
void setShouldClearStencil(bool value)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::ClearTargetsPass::getClearStencilValue
unsigned char getClearStencilValue() const
nkMaths::Vector
A 4-component vector class, with floats.
Definition: Vector.h:12
nkGraphics::ClearTargetsPass::setClearColor
void setClearColor(const nkMaths::Vector &value)