API Documentation
Compositor.h
1 // Compositor.h
3 //
5 
6 namespace nkGraphics
7 {
23  {
24  public :
25 
29  virtual ~Compositor () ;
30 
31  // Getters
35  unsigned int getNodeCount () const ;
40  CompositorNode* getNode (unsigned int index) const ;
44  System* getSystem () const ;
52  bool getHidden () const ;
53 
54  // Setters
67  void setHidden (bool value) ;
68 
74  virtual CompositorNode* addNode () ;
80  virtual void deleteNode (unsigned int index) ;
88  virtual void changeNodeOrder (unsigned int fromIndex, unsigned int toIndex) ;
92  virtual void clearNodes () ;
93 
102  virtual void renderChain () ;
103 
109  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
115  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
116 
117  // Operators
121  Compositor& operator= (const Compositor&) = delete ;
122 
123  public :
124 
125  // Statics
133  static nkMemory::UniquePtr<Compositor> create (System* system = nullptr) ;
134  } ;
135 }
nkGraphics::System
Main interface with the component system.
Definition: System.h:14
nkGraphics::Compositor::setName
void setName(nkMemory::StringView value)
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkGraphics::Compositor
A compositor, describing how to compose the rendering pipeline.
Definition: Compositor.h:23
nkGraphics::Compositor::changeNodeOrder
virtual void changeNodeOrder(unsigned int fromIndex, unsigned int toIndex)
nkGraphics::Compositor::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkGraphics::Compositor::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkGraphics::Compositor::getHidden
bool getHidden() const
nkGraphics::CompositorNode
A node in the rendering graph described by a Compositor.
Definition: CompositorNode.h:12
nkGraphics::Compositor::setHidden
void setHidden(bool value)
nkGraphics::Compositor::getNode
CompositorNode * getNode(unsigned int index) const
nkGraphics::Compositor::addNode
virtual CompositorNode * addNode()
nkGraphics::Compositor::getNodeCount
unsigned int getNodeCount() const
nkGraphics::Compositor::operator=
Compositor & operator=(const Compositor &)=delete
nkGraphics::Compositor::~Compositor
virtual ~Compositor()
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkGraphics::Compositor::create
static nkMemory::UniquePtr< Compositor > create(System *system=nullptr)
nkGraphics::Compositor::deleteNode
virtual void deleteNode(unsigned int index)
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::Compositor::clearNodes
virtual void clearNodes()
nkGraphics::Compositor::renderChain
virtual void renderChain()
nkGraphics::Compositor::getName
nkMemory::StringView getName() const
nkGraphics::Compositor::getSystem
System * getSystem() const
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7