Stores all relevant information for creating ll::Image objects. More...

#include <ImageDescriptor.h>

Public Member Functions
	ImageDescriptor ()=default

	ImageDescriptor (const ImageDescriptor &descriptor)=default

	ImageDescriptor (ImageDescriptor &&descriptor)=default

	ImageDescriptor (const uint32_t depth, const uint32_t height, const uint32_t width, const ll::ChannelCount channelCount, const ll::ChannelType channelType)
	Constructs the object. More...

	ImageDescriptor (const uint32_t depth, const uint32_t height, const uint32_t width, const ll::ChannelCount channelCount, const ll::ChannelType channelType, const ll::ImageUsageFlags usageFlags, const ll::ImageTiling tiling)
	Constructs the object. More...

	~ImageDescriptor ()=default

ImageDescriptor &	operator= (const ImageDescriptor &descriptor)=default

ImageDescriptor &	operator= (ImageDescriptor &&descriptor)=default

ImageDescriptor &	setChannelType (const ll::ChannelType type) noexcept
	Sets the channel type. More...

ImageDescriptor &	setChannelCount (const ll::ChannelCount count) noexcept
	Sets the channel count. More...

ImageDescriptor &	setWidth (const uint32_t width) noexcept
	Sets the width. More...

ImageDescriptor &	setHeight (const uint32_t height) noexcept
	Sets the height. More...

ImageDescriptor &	setDepth (const uint32_t depth) noexcept
	Sets the depth. More...

ImageDescriptor &	setShape (const ll::vec3ui &shape) noexcept
	Sets the image shape. More...

ImageDescriptor &	setUsageFlags (const ll::ImageUsageFlags flags) noexcept
	Sets the usage flags. More...

ImageDescriptor &	setUsageFlagsUnsafe (const uint32_t flags) noexcept
	Sets the usage flags from an integer type. More...

ImageDescriptor &	setTiling (const ll::ImageTiling tTiling) noexcept
	Sets the vulkan image tiling. More...

ll::ChannelType	getChannelType () const noexcept
	Gets the channel type. More...

template<typename T = ll::ChannelCount>
T	getChannelCount () const noexcept
	Gets the channel count. More...

uint32_t	getWidth () const noexcept
	Gets the image width in pixels. More...

uint32_t	getHeight () const noexcept
	Gets the image height in pixels. More...

uint32_t	getDepth () const noexcept
	Gets the image depth in pixels. More...

uint64_t	getSize () const noexcept
	Gets the size in bytes required to store the image. More...

ll::vec3ui	getShape () const noexcept
	Gets the shape of the image. More...

vk::ImageType	getImageType () const noexcept
	Gets the Vulkan image type. More...

vk::Format	getFormat () const noexcept
	Gets the corresponding Vulkan image format. More...

ll::ImageUsageFlags	getUsageFlags () const noexcept
	Gets the Vulkan image usage flags. More...

ll::ImageTiling	getTiling () const noexcept
	Gets the vulkan image tiling. More...

uint32_t	getUsageFlagsUnsafe () const noexcept
	Gets the usage flags casted to an integer type. More...

Detailed Description

Stores all relevant information for creating ll::Image objects.

The following code creates a descriptor for an 4-channel image with 640x480 pixel resolution and 8-bit unsigned int channel type.

auto desc = ll::ImageDescriptor{}
                .setWidth(640)
                .setHeight(480)
                .setChannelType(ll::ChannelType::Uint8)
                .setChannelCount(4);

Constructor & Destructor Documentation

◆ ImageDescriptor() [1/5]

ll::ImageDescriptor::ImageDescriptor ( )

default

◆ ImageDescriptor() [2/5]

ll::ImageDescriptor::ImageDescriptor ( const ImageDescriptor & descriptor )

default

◆ ImageDescriptor() [3/5]

ll::ImageDescriptor::ImageDescriptor ( ImageDescriptor && descriptor )

default

◆ ImageDescriptor() [4/5]

ll::ImageDescriptor::ImageDescriptor	(	const uint32_t	depth,
		const uint32_t	height,
		const uint32_t	width,
		const ll::ChannelCount	channelCount,
		const ll::ChannelType	channelType
	)

Constructs the object.

Parameters

[in]	depth	The depth. It must be greater than zero.
[in]	height	The height. It must be greater than zero.
[in]	width	The width. It must be greater than zero.
[in]	channelCount	The channel count. It must be between 1 and 4.
[in]	channelType	The channel type.

◆ ImageDescriptor() [5/5]

ll::ImageDescriptor::ImageDescriptor	(	const uint32_t	depth,
		const uint32_t	height,
		const uint32_t	width,
		const ll::ChannelCount	channelCount,
		const ll::ChannelType	channelType,
		const ll::ImageUsageFlags	usageFlags,
		const ll::ImageTiling	tiling
	)

Constructs the object.

Parameters

[in]	depth	The depth. It must be greater than zero.
[in]	height	The height. It must be greater than zero.
[in]	width	The width. It must be greater than zero.
[in]	channelCount	The channel count. It must be between 1 and 4.
[in]	channelType	The channel type.
[in]	usageFlags	The usage flags. See https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#VkImageUsageFlagBits.
[in]	tiling	The image tiling. See https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#VkImageTiling.

◆ ~ImageDescriptor()

ll::ImageDescriptor::~ImageDescriptor ( )

default

Member Function Documentation

◆ getChannelCount()

template<typename T = ll::ChannelCount>

T ll::ImageDescriptor::getChannelCount ( ) const

inlinenoexcept

Gets the channel count.

Template Parameters

T	Type of the return value. Defaults to ll::ChannelCount.

Returns: The channel count.

◆ getChannelType()

ll::ChannelType ll::ImageDescriptor::getChannelType ( ) const

noexcept

Gets the channel type.

Returns: The channel type.

◆ getDepth()

uint32_t ll::ImageDescriptor::getDepth ( ) const

noexcept

Gets the image depth in pixels.

Returns: The image depth in pixels.

◆ getFormat()

vk::Format ll::ImageDescriptor::getFormat ( ) const

noexcept

Gets the corresponding Vulkan image format.

The format is computed using the channel count and the channel type.

See https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#_vkformat_3.

Returns: The format.

◆ getHeight()

uint32_t ll::ImageDescriptor::getHeight ( ) const

noexcept

Gets the image height in pixels.

Returns: The image height in pixels.

◆ getImageType()

vk::ImageType ll::ImageDescriptor::getImageType ( ) const

noexcept

Gets the Vulkan image type.

It is implemented as:

if (getHeight() == 1) return vk::ImageType::e1D;
if (getDepth()  == 1) return vk::ImageType::e2D;
 
return vk::ImageType::e3D;

Returns: The image type.

◆ getShape()

ll::vec3ui ll::ImageDescriptor::getShape ( ) const

noexcept

Gets the shape of the image.

The vec3ui object returned must be interpreted as follows:

x : width
y : height
z : depth

Returns: The shape.

◆ getSize()

uint64_t ll::ImageDescriptor::getSize ( ) const

noexcept

Gets the size in bytes required to store the image.

This value does not include any row padding needed to align one row of data to the required size by the device.

Returns: The size of the image in bytes.

◆ getTiling()

ll::ImageTiling ll::ImageDescriptor::getTiling ( ) const

noexcept

Gets the vulkan image tiling.

Returns: The image tiling.

◆ getUsageFlags()

ll::ImageUsageFlags ll::ImageDescriptor::getUsageFlags ( ) const

noexcept

Gets the Vulkan image usage flags.

See https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#VkImageUsageFlagBits for more information.

Returns: The usage flags.

◆ getUsageFlagsUnsafe()

uint32_t ll::ImageDescriptor::getUsageFlagsUnsafe ( ) const

noexcept

Gets the usage flags casted to an integer type.

Please do not use this method. It's for internal use only.

Returns: The usage flags unsafe.

◆ getWidth()

uint32_t ll::ImageDescriptor::getWidth ( ) const

noexcept

Gets the image width in pixels.

Returns: The image width in pixels.

◆ operator=() [1/2]

ImageDescriptor& ll::ImageDescriptor::operator= ( const ImageDescriptor & descriptor )

default

◆ operator=() [2/2]

ImageDescriptor& ll::ImageDescriptor::operator= ( ImageDescriptor && descriptor )

default

◆ setChannelCount()

ImageDescriptor& ll::ImageDescriptor::setChannelCount ( const ll::ChannelCount count )

noexcept

Sets the channel count.

Parameters

[in] count The count. It must be between 1 and 4.

Returns: A reference to this object.

◆ setChannelType()

ImageDescriptor& ll::ImageDescriptor::setChannelType ( const ll::ChannelType type )

noexcept

Sets the channel type.

Parameters

[in] type The channel type.

Returns: A reference to this object.

◆ setDepth()

ImageDescriptor& ll::ImageDescriptor::setDepth ( const uint32_t depth )

noexcept

Sets the depth.

Parameters

[in] depth The depth. It must be greater than zero.

Returns: A reference to this object.

◆ setHeight()

ImageDescriptor& ll::ImageDescriptor::setHeight ( const uint32_t height )

noexcept

Sets the height.

Parameters

[in] height The height. It must be greater than zero.

Returns: A reference to this object.

◆ setShape()

ImageDescriptor& ll::ImageDescriptor::setShape ( const ll::vec3ui & shape )

noexcept

Sets the image shape.

Parameters

[in]

shape

The shape. The components of this vector must be interpreted as:

x : width
y : height
z : depth

Returns: A reference to this object.

◆ setTiling()

ImageDescriptor& ll::ImageDescriptor::setTiling ( const ll::ImageTiling tTiling )

noexcept

Sets the vulkan image tiling.

Parameters

[in] tTiling The tiling

Returns: A reference to this object.

◆ setUsageFlags()

ImageDescriptor& ll::ImageDescriptor::setUsageFlags ( const ll::ImageUsageFlags flags )

noexcept

Sets the usage flags.

Returns: A reference to this object.

◆ setUsageFlagsUnsafe()

ImageDescriptor& ll::ImageDescriptor::setUsageFlagsUnsafe ( const uint32_t flags )

noexcept

Sets the usage flags from an integer type.

Please do not use this method. It's for internal use only.

Parameters

[in] flags The flags

Returns: A reference to this object

◆ setWidth()

ImageDescriptor& ll::ImageDescriptor::setWidth ( const uint32_t width )

noexcept

Sets the width.

Parameters

[in] width The width. It must be greater than zero.

Returns: A reference to this object.

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

/root/project/lluvia/cpp/core/include/lluvia/core/image/ImageDescriptor.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ImageDescriptor() [1/5]

◆ ImageDescriptor() [2/5]

◆ ImageDescriptor() [3/5]

◆ ImageDescriptor() [4/5]

◆ ImageDescriptor() [5/5]

◆ ~ImageDescriptor()

Member Function Documentation

◆ getChannelCount()

◆ getChannelType()

◆ getDepth()

◆ getFormat()

◆ getHeight()

◆ getImageType()

◆ getShape()

◆ getSize()

◆ getTiling()

◆ getUsageFlags()

◆ getUsageFlagsUnsafe()

◆ getWidth()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setChannelCount()

◆ setChannelType()

◆ setDepth()

◆ setHeight()

◆ setShape()

◆ setTiling()

◆ setUsageFlags()

◆ setUsageFlagsUnsafe()

◆ setWidth()