API Documentation
Viewport.h
1 // Viewport.h
3 //
5 
6 namespace nkGraphics
7 {
13  class Viewport
14  {
15  public :
16 
20  virtual ~Viewport () ;
21 
22  // Getters
26  virtual float getWidth () const = 0 ;
30  virtual float getHeight () const = 0 ;
34  virtual float getMinDepth () const = 0 ;
38  virtual float getMaxDepth () const = 0 ;
42  virtual float getTopLeftX () const = 0 ;
46  virtual float getTopLeftY () const = 0 ;
50  virtual nkMemory::StringView getName () const ;
54  virtual bool getDirtyViewport () const ;
55 
56  // Setters
62  virtual void setWidth (float width) = 0 ;
68  virtual void setHeight (float height) = 0 ;
74  virtual void setMinDepth (float value) = 0 ;
80  virtual void setMaxDepth (float value) = 0 ;
86  virtual void setTopLeftX (float value) = 0 ;
92  virtual void setTopLeftY (float value) = 0 ;
98  virtual void setName (nkMemory::StringView name) ;
104  virtual void setDirtyViewport (bool value) ;
105 
106  public :
107 
108  // Statics
116  static nkMemory::UniquePtr<Viewport> create (System* system = nullptr) ;
117  } ;
118 }
nkGraphics::Viewport::getDirtyViewport
virtual bool getDirtyViewport() const
nkGraphics::Viewport::getTopLeftY
virtual float getTopLeftY() const =0
nkGraphics::Viewport::getMaxDepth
virtual float getMaxDepth() const =0
nkGraphics::System
Main interface with the component system.
Definition: System.h:14
nkGraphics::Viewport::getMinDepth
virtual float getMinDepth() const =0
nkGraphics::Viewport
Holds all the information needed about a viewport.
Definition: Viewport.h:14
nkGraphics::Viewport::setDirtyViewport
virtual void setDirtyViewport(bool value)
nkGraphics::Viewport::create
static nkMemory::UniquePtr< Viewport > create(System *system=nullptr)
nkGraphics::Viewport::getHeight
virtual float getHeight() const =0
nkGraphics::Viewport::setMinDepth
virtual void setMinDepth(float value)=0
nkGraphics::Viewport::setMaxDepth
virtual void setMaxDepth(float value)=0
nkGraphics::Viewport::setWidth
virtual void setWidth(float width)=0
nkGraphics::Viewport::~Viewport
virtual ~Viewport()
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkGraphics::Viewport::getName
virtual nkMemory::StringView getName() const
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::Viewport::getWidth
virtual float getWidth() const =0
nkGraphics::Viewport::setName
virtual void setName(nkMemory::StringView name)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::Viewport::getTopLeftX
virtual float getTopLeftX() const =0
nkGraphics::Viewport::setTopLeftY
virtual void setTopLeftY(float value)=0
nkGraphics::Viewport::setTopLeftX
virtual void setTopLeftX(float value)=0
nkGraphics::Viewport::setHeight
virtual void setHeight(float height)=0