vsg 1.1.3
VulkanSceneGraph library
|
Image class encapsulates VkImage and VkImageCreateInfo settings used to set it up. More...
#include <Image.h>
Classes | |
struct | VulkanData |
Public Member Functions | |
Image (ref_ptr< Data > in_data={}) | |
create a vsg::Image, optional Data is used to initialize createInfo, delay VkImage creation to compile | |
Image (VkImage image, Device *device) | |
create a vsg::Image wrapper for specified VkImage | |
VkImage | vk (uint32_t deviceID) const |
Vulkan VkImage handle. | |
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, | |
DeviceMemory * | getDeviceMemory (uint32_t deviceID) |
const DeviceMemory * | getDeviceMemory (uint32_t deviceID) const |
VkDeviceSize | getMemoryOffset (uint32_t deviceID) const |
VkMemoryRequirements | getMemoryRequirements (uint32_t deviceID) const |
VkResult | allocateAndBindMemory (Device *device, VkMemoryPropertyFlags memoryProperties=VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT, void *pNextAllocInfo=nullptr) |
VkResult | bind (DeviceMemory *deviceMemory, VkDeviceSize memoryOffset) |
bool | requiresCopy (uint32_t deviceID) const |
return true if the Image's data has been modified and should be copied to the buffer. | |
bool | syncModifiedCount (uint32_t deviceID) |
return true if the Image's data has been modified and should be copied to the buffer, updating the device specific ModifiedCount to the Data's ModifiedCount. | |
virtual void | compile (Device *device) |
virtual void | compile (Context &context) |
![]() | |
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 |
![]() | |
Object (const Object &object, const CopyOp ©op={}) | |
Object & | operator= (const Object &) |
template<class T > | |
T * | cast () |
template<class T > | |
const T * | cast () const |
virtual ref_ptr< Object > | clone (const CopyOp ©op={}) 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 | |
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< Data > | data |
VkImageCreateInfo settings. | |
VkImageCreateFlags | flags = 0 |
VkImageType | imageType = VK_IMAGE_TYPE_2D |
VkFormat | format = VK_FORMAT_UNDEFINED |
VkExtent3D | extent = {0, 0, 0} |
uint32_t | mipLevels = 0 |
uint32_t | arrayLayers = 0 |
VkSampleCountFlagBits | samples = VK_SAMPLE_COUNT_1_BIT |
VkImageTiling | tiling = VK_IMAGE_TILING_OPTIMAL |
VkImageUsageFlags | usage = 0 |
VkSharingMode | sharingMode = VK_SHARING_MODE_EXCLUSIVE |
std::vector< uint32_t > | queueFamilyIndices |
VkImageLayout | initialLayout = VK_IMAGE_LAYOUT_UNDEFINED |
Protected Attributes | |
vk_buffer< VulkanData > | _vulkanData |
Additional Inherited Members | |
![]() | |
static ref_ptr< Image > | create (Args &&... args) |
static ref_ptr< Image > | create_if (bool flag, Args &&... args) |
![]() | |
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) |
![]() | |
virtual void | _attemptDelete () const |
void | setAuxiliary (Auxiliary *auxiliary) |
Image class encapsulates VkImage and VkImageCreateInfo settings used to set it up.
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::Object.