vsg 1.1.13
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::MultisampleState Class Reference

MultisampleState encapsulates VkPipelineMultisampleStateCreateInfo settings passed when setting up GraphicsPipeline. More...

#include <MultisampleState.h>

Inheritance diagram for vsg::MultisampleState:
Collaboration diagram for vsg::MultisampleState:

Public Member Functions

 MultisampleState (VkSampleCountFlagBits rasterizationSamples=VK_SAMPLE_COUNT_1_BIT)
 MultisampleState (const MultisampleState &ms)
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, MultisampleState >
 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
void accept (Visitor &visitor) override
Public Member Functions inherited from vsg::GraphicsPipelineState
 GraphicsPipelineState (const GraphicsPipelineState &gp)
void record (CommandBuffer &) const override
Public Member Functions inherited from vsg::Inherit< StateCommand, 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
void accept (Visitor &visitor) override
Public Member Functions inherited from vsg::StateCommand
 StateCommand (uint32_t in_slot=0)
 StateCommand (const StateCommand &rhs, const CopyOp &copyop)
int compare (const Object &rhs_object) 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
Public Member Functions inherited from vsg::Inherit< Command, StateCommand >
 Inherit (Args &&... args)
Public Member Functions inherited from vsg::Command
 Command (const Command &rhs, const CopyOp &copyop={})
Public Member Functions inherited from vsg::Inherit< Compilable, Command >
 Inherit (Args &&... args)
Public Member Functions inherited from vsg::Compilable
 Compilable (const Compilable &rhs, const CopyOp &copyop={})
virtual void compile (Context &)
Public Member Functions inherited from vsg::Inherit< Node, Compilable >
 Inherit (Args &&... args)
Public Member Functions inherited from vsg::Node
 Node (const Node &rhs, const CopyOp &copyop={})
ref_ptr< Objectclone (const CopyOp &copyop={}) const override
Public Member Functions inherited from vsg::Inherit< Object, Node >
 Inherit (Args &&... args)
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Object & operator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual void traverse (Visitor &)
virtual void accept (ConstVisitor &visitor) const
virtual void traverse (ConstVisitor &) const
virtual void accept (RecordTraversal &visitor) 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

VkSampleCountFlagBits rasterizationSamples = VK_SAMPLE_COUNT_1_BIT
 VkPipelineMultisampleStateCreateInfo settings.
VkBool32 sampleShadingEnable = VK_FALSE
float minSampleShading = 0.0f
std::vector< VkSampleMask > sampleMasks
VkBool32 alphaToCoverageEnable = VK_FALSE
VkBool32 alphaToOneEnable = VK_FALSE
Public Attributes inherited from vsg::GraphicsPipelineState
Mask mask = MASK_ALL
 apply GraphicsPipelineState when (mask & view.mask) is non zero
Public Attributes inherited from vsg::StateCommand
uint32_t slot = 0

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< GraphicsPipelineState, MultisampleState >
static ref_ptr< MultisampleStatecreate (Args &&... args)
static ref_ptr< MultisampleStatecreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< StateCommand, GraphicsPipelineState >
static ref_ptr< GraphicsPipelineStatecreate (Args &&... args)
static ref_ptr< GraphicsPipelineStatecreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Command, StateCommand >
static ref_ptr< StateCommandcreate (Args &&... args)
static ref_ptr< StateCommandcreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Compilable, Command >
static ref_ptr< Commandcreate (Args &&... args)
static ref_ptr< Commandcreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Node, Compilable >
static ref_ptr< Compilablecreate (Args &&... args)
static ref_ptr< Compilablecreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Node
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_NODES_OBJECTS
static void operator delete (void *ptr)
Static Public Member Functions inherited from vsg::Inherit< Object, Node >
static ref_ptr< Nodecreate (Args &&... args)
static ref_ptr< Nodecreate_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

MultisampleState encapsulates VkPipelineMultisampleStateCreateInfo settings passed when setting up GraphicsPipeline.

Member Function Documentation

◆ apply()

void vsg::MultisampleState::apply ( Context & context,
VkGraphicsPipelineCreateInfo & pipelineInfo ) const
overridevirtual

◆ compare()

int vsg::MultisampleState::compare ( const Object & rhs) const
overridevirtual

compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,

Reimplemented from vsg::Inherit< GraphicsPipelineState, MultisampleState >.

◆ read()

void vsg::MultisampleState::read ( Input & input)
overridevirtual

Reimplemented from vsg::GraphicsPipelineState.

◆ write()

void vsg::MultisampleState::write ( Output & output) const
overridevirtual

Reimplemented from vsg::GraphicsPipelineState.


The documentation for this class was generated from the following file: