API Documentation
CompositorNode.h
1 // CompositorNode.h
3 //
5 
6 namespace nkGraphics
7 {
12  {
13  public :
14 
21  CompositorNode (System* system) noexcept ;
25  CompositorNode (const CompositorNode&) = delete ;
29  virtual ~CompositorNode () ;
30 
31  // Getters
43  bool getActive () const ;
44 
45  // Setters
51  void setName (const nkMemory::StringView& name) ;
64  virtual void setActive (bool value) ;
65 
66  // TargetOperations management
78  TargetOperations* getOperations (unsigned int index) const ;
82  unsigned int getOperationsCount () const ;
88  virtual void deleteOperations (unsigned int index) ;
96  virtual void changeOperationsOrder (unsigned int fromIndex, unsigned int toIndex) ;
97 
102  virtual void renderOperations () ;
103 
109  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
115  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
116 
117  // Operators
122  } ;
123 }
nkGraphics::CompositorNode::setActive
virtual void setActive(bool value)
nkGraphics::CompositorNode::getOperations
TargetOperations * getOperations(unsigned int index) const
nkGraphics::System
Main interface with the component system.
Definition: System.h:14
nkGraphics::CompositorNode::CompositorNode
CompositorNode(const CompositorNode &)=delete
nkGraphics::CompositorNode::~CompositorNode
virtual ~CompositorNode()
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkGraphics::CompositorNode::getParentCompositor
Compositor * getParentCompositor() const
nkGraphics::Compositor
A compositor, describing how to compose the rendering pipeline.
Definition: Compositor.h:23
nkGraphics::CompositorNode::addOperations
TargetOperations * addOperations()
nkGraphics::CompositorNode::deleteOperations
virtual void deleteOperations(unsigned int index)
nkGraphics::CompositorNode::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkGraphics::CompositorNode
A node in the rendering graph described by a Compositor.
Definition: CompositorNode.h:12
nkGraphics::TargetOperations
Describes a target operation set.
Definition: TargetOperations.h:15
nkGraphics::CompositorNode::CompositorNode
CompositorNode(System *system) noexcept
nkGraphics::CompositorNode::operator=
CompositorNode & operator=(const CompositorNode &)=delete
nkGraphics::CompositorNode::changeOperationsOrder
virtual void changeOperationsOrder(unsigned int fromIndex, unsigned int toIndex)
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::CompositorNode::getName
nkMemory::StringView getName() const
nkGraphics::CompositorNode::setParentCompositor
void setParentCompositor(Compositor *value)
nkGraphics::CompositorNode::setName
void setName(const nkMemory::StringView &name)
nkGraphics::CompositorNode::getActive
bool getActive() const
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::CompositorNode::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkGraphics::CompositorNode::renderOperations
virtual void renderOperations()
nkGraphics::CompositorNode::getOperationsCount
unsigned int getOperationsCount() const