Dusk Audio Framework
Loading...
Searching...
No Matches
VulkanImage Class Reference

#include <Vulkan.hpp>

Inheritance diagram for VulkanImage:
ImageBase

Public Member Functions

 VulkanImage ()
 VulkanImage (const char *rawData, uint width, uint height, ImageFormat format)
 VulkanImage (const char *rawData, const Size< uint > &size, ImageFormat format)
 VulkanImage (const VulkanImage &image)
 ~VulkanImage () override
void loadFromMemory (const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept override
void drawAt (const GraphicsContext &context, const Point< int > &pos) override
VulkanImage & operator= (const VulkanImage &image) noexcept
void loadFromMemory (const char *rdata, uint w, uint h, ImageFormat fmt=kImageFormatBGRA)
void draw (const GraphicsContext &context)
void drawAt (const GraphicsContext &context, int x, int y)
Public Member Functions inherited from ImageBase
virtual ~ImageBase ()
bool isValid () const noexcept
bool isInvalid () const noexcept
uint getWidth () const noexcept
uint getHeight () const noexcept
const Size< uint > & getSize () const noexcept
const char * getRawData () const noexcept
ImageFormat getFormat () const noexcept
void loadFromMemory (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA) noexcept
void draw (const GraphicsContext &context)
void drawAt (const GraphicsContext &context, int x, int y)
ImageBase & operator= (const ImageBase &image) noexcept
bool operator== (const ImageBase &image) const noexcept
bool operator!= (const ImageBase &image) const noexcept

Additional Inherited Members

Protected Member Functions inherited from ImageBase
 ImageBase ()
 ImageBase (const char *rawData, uint width, uint height, ImageFormat format)
 ImageBase (const char *rawData, const Size< uint > &size, ImageFormat format)
 ImageBase (const ImageBase &image)
Protected Attributes inherited from ImageBase
const char * rawData
Size< uint > size
ImageFormat format

Detailed Description

Vulkan Image class.

TODO ...

Constructor & Destructor Documentation

◆ VulkanImage() [1/4]

VulkanImage::VulkanImage ( )

Constructor for a null Image.

◆ VulkanImage() [2/4]

VulkanImage::VulkanImage ( const char * rawData,
uint width,
uint height,
ImageFormat format )

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.

◆ VulkanImage() [3/4]

VulkanImage::VulkanImage ( const char * rawData,
const Size< uint > & size,
ImageFormat format )

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.

◆ VulkanImage() [4/4]

VulkanImage::VulkanImage ( const VulkanImage & image)

Constructor using another image data.

◆ ~VulkanImage()

VulkanImage::~VulkanImage ( )
override

Destructor.

Member Function Documentation

◆ loadFromMemory()

void VulkanImage::loadFromMemory ( const char * rawData,
const Size< uint > & size,
ImageFormat format = kImageFormatBGRA )
overridevirtualnoexcept

Load image data from memory.

Note
rawData must remain valid for the lifetime of this Image.

Reimplemented from ImageBase.

◆ drawAt()

void VulkanImage::drawAt ( const GraphicsContext & context,
const Point< int > & pos )
overridevirtual

Draw this image at position pos using the graphics context context.

Implements ImageBase.

◆ operator=()

VulkanImage & VulkanImage::operator= ( const VulkanImage & image)
noexcept

TODO document this.


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