vsg 1.1.10
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::RenderPass Class Reference

RenderPass encapsulation of VkRenderPass. More...

#include <RenderPass.h>

Inheritance diagram for vsg::RenderPass:
Collaboration diagram for vsg::RenderPass:

Public Types

using Attachments = std::vector<AttachmentDescription>
using Subpasses = std::vector<SubpassDescription>
using Dependencies = std::vector<SubpassDependency>
using CorrelatedViewMasks = std::vector<uint32_t>

Public Member Functions

 RenderPass (Device *in_device, const Attachments &in_attachments, const Subpasses &in_subpasses, const Dependencies &in_dependencies, const CorrelatedViewMasks &in_correlatedViewMasks={})
 operator VkRenderPass () const
VkRenderPass vk () const
Public Member Functions inherited from vsg::Inherit< Object, RenderPass >
 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
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Objectoperator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual ref_ptr< Objectclone (const CopyOp &copyop={}) 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
virtual void read (Input &input)
virtual void write (Output &output) 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
ObjectgetObject (const std::string &key)
 get Object pointer associated with key, return nullptr if no object associated with key has been assigned
const ObjectgetObject (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< ObjectgetRefObject (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 ObjectgetRefObject (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
AuxiliarygetOrCreateAuxiliary ()
AuxiliarygetAuxiliary ()
const AuxiliarygetAuxiliary () const

Public Attributes

const ref_ptr< Devicedevice
const Attachments attachments
const Subpasses subpasses
const Dependencies dependencies
const CorrelatedViewMasks correlatedViewMasks
const VkSampleCountFlagBits maxSamples

Protected Attributes

VkRenderPass _renderPass
 Vulkan renderPass handle, created in RenderPass constructor.

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Object, RenderPass >
static ref_ptr< RenderPasscreate (Args &&... args)
static ref_ptr< RenderPasscreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Object
static ref_ptr< Objectcreate ()
static ref_ptr< Objectcreate_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

RenderPass encapsulation of VkRenderPass.

Member Data Documentation

◆ maxSamples

const VkSampleCountFlagBits vsg::RenderPass::maxSamples

Maximum VkAttachmentDescription::samples value of the assigned attachments. Used for deciding if multisampling is required and the value to use when setting up the GraphicsPipeline's vsg::MultisampleState


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