vsg 1.1.13
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::Profiler Class Reference
Inheritance diagram for vsg::Profiler:
Collaboration diagram for vsg::Profiler:

Classes

struct  Settings
struct  FrameStatsCollection
 resources for collecting GPU stats for all devices for a single frame More...

Public Member Functions

 Profiler (ref_ptr< Settings > in_settings={})
VkResult getGpuResults (FrameStatsCollection &frameStats) const
void setThreadName (const std::string &) const override
void enterFrame (const SourceLocation *, uint64_t &, FrameStamp &) const override
void leaveFrame (const SourceLocation *, uint64_t &, FrameStamp &) const override
void enter (const SourceLocation *, uint64_t &, const Object *=nullptr) const override
void leave (const SourceLocation *, uint64_t &, const Object *=nullptr) const override
void enterCommandBuffer (const SourceLocation *, uint64_t &, CommandBuffer &) const override
void leaveCommandBuffer (const SourceLocation *, uint64_t &, CommandBuffer &) const override
void enter (const SourceLocation *, uint64_t &, CommandBuffer &, const Object *=nullptr) const override
void leave (const SourceLocation *, uint64_t &, CommandBuffer &, const Object *=nullptr) const override
void finish () const override
Public Member Functions inherited from vsg::Inherit< Instrumentation, Profiler >
 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::Instrumentation
virtual ref_ptr< Instrumentation > shareOrDuplicateForThreadSafety ()
Public Member Functions inherited from vsg::Inherit< Object, Instrumentation >
 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={})
Object & operator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual ref_ptr< Object > clone (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
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

ref_ptr< Settingssettings
ref_ptr< ProfileLoglog
size_t frameIndex = 0
std::vector< FrameStatsCollectionperFrameGPUStats

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Instrumentation, Profiler >
static ref_ptr< Profilercreate (Args &&... args)
static ref_ptr< Profilercreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Object, Instrumentation >
static ref_ptr< Instrumentationcreate (Args &&... args)
static ref_ptr< Instrumentationcreate_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)

Member Function Documentation

◆ enter() [1/2]

void vsg::Profiler::enter ( const SourceLocation * ,
uint64_t & ,
CommandBuffer & ,
const Object * = nullptr ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ enter() [2/2]

void vsg::Profiler::enter ( const SourceLocation * ,
uint64_t & ,
const Object * = nullptr ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ enterCommandBuffer()

void vsg::Profiler::enterCommandBuffer ( const SourceLocation * ,
uint64_t & ,
CommandBuffer &  ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ enterFrame()

void vsg::Profiler::enterFrame ( const SourceLocation * ,
uint64_t & ,
FrameStamp &  ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ finish()

void vsg::Profiler::finish ( ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ leave() [1/2]

void vsg::Profiler::leave ( const SourceLocation * ,
uint64_t & ,
CommandBuffer & ,
const Object * = nullptr ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ leave() [2/2]

void vsg::Profiler::leave ( const SourceLocation * ,
uint64_t & ,
const Object * = nullptr ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ leaveCommandBuffer()

void vsg::Profiler::leaveCommandBuffer ( const SourceLocation * ,
uint64_t & ,
CommandBuffer &  ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ leaveFrame()

void vsg::Profiler::leaveFrame ( const SourceLocation * ,
uint64_t & ,
FrameStamp &  ) const
overridevirtual

Reimplemented from vsg::Instrumentation.

◆ setThreadName()

void vsg::Profiler::setThreadName ( const std::string & ) const
overridevirtual

Reimplemented from vsg::Instrumentation.


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