vsg  1.1.0
VulkanSceneGraph library
Public Member Functions | List of all members
vsg::spirv Class Reference

ReaderWriter for reading and writing spirv shader files. More...

#include <spirv.h>

Inheritance diagram for vsg::spirv:
Inheritance graph
[legend]
Collaboration diagram for vsg::spirv:
Collaboration graph
[legend]

Public Member Functions

ref_ptr< Objectread (const Path &filename, ref_ptr< const Options > options={}) const override
 read object from file, return object on success, return null ref_ptr<> if format not supported, or return ReadError on failure.
 
ref_ptr< vsg::Objectread (std::istream &fin, ref_ptr< const Options > options={}) const override
 read object from input stream, return object on success, return null ref_ptr<> if format not supported, or return ReadError on failure.
 
ref_ptr< vsg::Objectread (const uint8_t *ptr, size_t size, ref_ptr< const Options >={}) const override
 read object from memory block, return object on success, return null ref_ptr<> if format not supported, or return ReadError on failure.
 
bool write (const Object *object, const Path &filename, ref_ptr< const Options > options={}) const override
 write object to file, return true on success, return false on failure.
 
bool getFeatures (Features &features) const override
 get the Features supported by this ReaderWriter
 
- Public Member Functions inherited from vsg::Inherit< ReaderWriter, spirv >
 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::ReaderWriter
template<class T >
vsg::ref_ptr< T > read_cast (const vsg::Path &filename, vsg::ref_ptr< const vsg::Options > options={}) const
 convenience method for casting a read object to a specified type.
 
template<class T >
vsg::ref_ptr< T > read_cast (std::istream &fin, vsg::ref_ptr< const vsg::Options > options={}) const
 convenience method for casting a read object to a specified type.
 
template<class T >
vsg::ref_ptr< T > read_cast (const uint8_t *ptr, size_t size, vsg::ref_ptr< const vsg::Options > options={}) const
 convenience method for casting a read object to a specified type.
 
virtual bool write (const vsg::Object *, std::ostream &, vsg::ref_ptr< const vsg::Options >={}) const
 write object to output stream, return true on success, return false on failure.
 
virtual bool readOptions (Options &, CommandLine &) const
 read the command line arguments for any options appropriate for this ReaderWriter
 
- Public Member Functions inherited from vsg::Inherit< Object, ReaderWriter >
 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 &)
 
Objectoperator= (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
 
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
 

Additional Inherited Members

- Public Types inherited from vsg::ReaderWriter
enum  FeatureMask {
  READ_FILENAME = (1 << 0) , READ_ISTREAM = (1 << 1) , READ_MEMORY = (1 << 2) , WRITE_FILENAME = (1 << 3) ,
  WRITE_OSTREAM = (1 << 4)
}
 
- Static Public Member Functions inherited from vsg::Inherit< ReaderWriter, spirv >
static ref_ptr< spirvcreate (Args &&... args)
 
static ref_ptr< spirvcreate_if (bool flag, Args &&... args)
 
- Static Public Member Functions inherited from vsg::Inherit< Object, ReaderWriter >
static ref_ptr< ReaderWritercreate (Args &&... args)
 
static ref_ptr< ReaderWritercreate_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

ReaderWriter for reading and writing spirv shader files.


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