ViewportState encapsulates VkPipelineViewportStateCreateInfo settings passed when setting up GraphicsPipeline. More...
#include <ViewportState.h>
Inheritance diagram for vsg::ViewportState:
Collaboration diagram for vsg::ViewportState:
Public Member Functions | |
| ViewportState (const ViewportState &vs) | |
| ViewportState (const VkExtent2D &extent) | |
| Create ViewportState containing a single Viewport and Scissor pair with specified extent located at origin (x, y = {0,0}). Typically used for convenience when rendering to a whole window. | |
| ViewportState (int32_t x, int32_t y, uint32_t width, uint32_t height) | |
| Create ViewportState containing a single Viewport and Scissor pair with specified position and extent. | |
| void | set (int32_t x, int32_t y, uint32_t width, uint32_t height) |
| set to a single Viewport and Scissor pair with specified extent | |
| VkViewport & | getViewport () |
| get or create the first Viewport | |
| VkRect2D & | getScissor () |
| get or create the first Scissor | |
| int | compare (const Object &rhs) const override |
| compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater, | |
| void | read (Input &input) override |
| void | write (Output &output) const override |
| void | apply (Context &context, VkGraphicsPipelineCreateInfo &pipelineInfo) const override |
 Public Member Functions inherited from vsg::Inherit< GraphicsPipelineState, ViewportState > | |
| Inherit (Args &&... args) | |
| std::size_t | sizeofObject () const noexcept override |
| const char * | className () const noexcept override |
| const std::type_info & | type_info () const noexcept override |
| bool | is_compatible (const std::type_info &type) const noexcept override |
| int | compare (const Object &rhs) const override |
| void | accept (Visitor &visitor) override |
| void | accept (ConstVisitor &visitor) const override |
| void | accept (RecordTraversal &visitor) const override |
| Public Member Functions inherited from vsg::GraphicsPipelineState | |
| GraphicsPipelineState (const GraphicsPipelineState &gp) | |
| Public Member Functions inherited from vsg::Inherit< Object, GraphicsPipelineState > | |
| Inherit (Args &&... args) | |
| std::size_t | sizeofObject () const noexcept override |
| const char * | className () const noexcept override |
| const std::type_info & | type_info () const noexcept override |
| bool | is_compatible (const std::type_info &type) const noexcept override |
| int | compare (const Object &rhs) const override |
| void | accept (Visitor &visitor) override |
| void | accept (ConstVisitor &visitor) const override |
| void | accept (RecordTraversal &visitor) const override |
| Public Member Functions inherited from vsg::Object | |
| Object (const Object &) | |
| Object & | operator= (const Object &) |
| template<class T > | |
| T * | cast () |
| template<class T > | |
| const T * | cast () const |
| virtual void | traverse (Visitor &) |
| virtual void | traverse (ConstVisitor &) const |
| virtual void | traverse (RecordTraversal &) const |
| void | ref () const noexcept |
| void | unref () const noexcept |
| void | unref_nodelete () const noexcept |
| unsigned int | referenceCount () const noexcept |
| template<typename T > | |
| void | setValue (const std::string &key, const T &value) |
| void | setValue (const std::string &key, const char *value) |
| specialization of setValue to handle passing C strings | |
| template<typename T > | |
| bool | getValue (const std::string &key, T &value) const |
| get specified value type, return false if value associated with key is not assigned or is not the correct type | |
| void | setObject (const std::string &key, ref_ptr< Object > object) |
| assign an Object associated with key | |
| Object * | getObject (const std::string &key) |
| get Object pointer associated with key, return nullptr if no object associated with key has been assigned | |
| const Object * | getObject (const std::string &key) const |
| get const Object pointer associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| T * | getObject (const std::string &key) |
| get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| const T * | getObject (const std::string &key) const |
| get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| ref_ptr< Object > | getRefObject (const std::string &key) |
| get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned | |
| ref_ptr< const Object > | getRefObject (const std::string &key) const |
| get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| ref_ptr< T > | getRefObject (const std::string &key) |
| get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| const ref_ptr< const T > | getRefObject (const std::string &key) const |
| get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| void | removeObject (const std::string &key) |
| remove meta object or value associated with key | |
| Auxiliary * | getOrCreateAuxiliary () |
| Auxiliary * | getAuxiliary () |
| const Auxiliary * | getAuxiliary () const |
Public Attributes | |
| Viewports | viewports |
| VkPipelineViewportStateCreateInfo settings. | |
| Scissors | scissors |
| Public Attributes inherited from vsg::GraphicsPipelineState | |
| Mask | mask = MASK_ALL |
| apply GraphicsPipelineState when (mask & view.mask) is non zero | |
Additional Inherited Members | |
| Static Public Member Functions inherited from vsg::Inherit< GraphicsPipelineState, ViewportState > | |
| static ref_ptr< ViewportState > | create (Args &&... args) |
| static ref_ptr< ViewportState > | create_if (bool flag, Args &&... args) |
| Static Public Member Functions inherited from vsg::Inherit< Object, GraphicsPipelineState > | |
| static ref_ptr< GraphicsPipelineState > | create (Args &&... args) |
| static ref_ptr< GraphicsPipelineState > | create_if (bool flag, Args &&... args) |
| Static Public Member Functions inherited from vsg::Object | |
| static ref_ptr< Object > | create () |
| static ref_ptr< Object > | create_if (bool flag) |
| static void * | operator new (std::size_t count) |
| provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS | |
| static void | operator delete (void *ptr) |
| Protected Member Functions inherited from vsg::Object | |
| virtual void | _attemptDelete () const |
| void | setAuxiliary (Auxiliary *auxiliary) |
Detailed Description
ViewportState encapsulates VkPipelineViewportStateCreateInfo settings passed when setting up GraphicsPipeline.
The documentation for this class was generated from the following file:
- include/vsg/state/ViewportState.h
