Represents portions of a ll::Image to be sent as parameter to a GLSL shader. More...

#include <ImageView.h>

Inheritance diagram for ll::ImageView:

Collaboration diagram for ll::ImageView:

Public Member Functions
	ImageView ()=delete

	ImageView (const ImageView &)=delete

	ImageView (ImageView &&)=delete

	~ImageView ()

ImageView &	operator= (const ImageView &)=delete

ImageView &	operator= (ImageView &&)=delete

ll::ObjectType	getType () const noexcept override
	Gets the object type. More...

const std::shared_ptr< ll::Image > &	getImage () const noexcept
	Gets the parent ll::Image this object was created from. More...

const std::shared_ptr< ll::Memory > &	getMemory () const noexcept
	Gets the memory the underlying ll::Image was allocated from. More...

ll::MemoryAllocationInfo	getAllocationInfo () const noexcept
	Gets the allocation information of the underlying ll::Image object. More...

uint64_t	getSize () const noexcept
	Gets the memory allocation size in bytes. More...

uint64_t	getMinimumSize () const noexcept
	Gets the minimum number of bytes to store the image contiguously in memory. More...

const ll::ImageDescriptor &	getImageDescriptor () const noexcept
	Gets the image descriptor. More...

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

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

ll::ImageLayout	getLayout () const noexcept
	Gets the Vulkan image layout. More...

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

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

uint64_t	getChannelTypeSize () const noexcept
	Gets the channel type size. More...

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

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

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

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

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

const ll::ImageViewDescriptor &	getDescriptor () const noexcept
	Gets the image view descriptor. More...

void	changeImageLayout (const ll::ImageLayout newLayout)
	Immediately changes the layout of the underlying ll::Image object. More...

void	clear ()
	Immediately clears the image pixels to zero. More...

void	copyTo (ll::ImageView &dst)
	Immediately copies the content of this image view into the destination. More...

Public Member Functions inherited from ll::Object
	Object ()=default
	Default constructor. More...

	Object (const Object &)=delete
	Copy constructor. More...

	Object (Object &&)=delete
	Move constructor. More...

virtual	~Object ()=default

Object &	operator= (const Object &)=delete
	Copy assignment. More...

Object &	operator= (Object &&)=delete
	Move assignment. More...

Friends
class	Image

class	ComputeNode

Detailed Description

Represents portions of a ll::Image to be sent as parameter to a GLSL shader.

Image views are created from a ll::Image object provided a ll::ImageViewDescriptor.

auto session = ll::Session::create();
 
// device-local memory with page size of 2048 bytes
auto memory = session->createMemory(vk::MemoryPropertyFlagBits::eDeviceLocal, 2048);
 
// 8-bit unsigned, 4-channel, 640x480 image.
auto desc = ll::ImageDescriptor{}
                .setWidth(640)
                .setHeight(480)
                .setChannelType(ll::ChannelType::Uint8)
                .setChannelCount(4);
 
auto image = memory->createImage(desc);
 
// image view descriptor for a sampled image
auto imgViewDesc = ll::ImageViewDescriptor {}
                    .setNormalizedCoordinates(false)
                    .setIsSampled(true)
                    .setAddressMode(ll::ImageAddressMode::Repeat)
                    .setFilterMode(ll::ImageFilterMode::Nearest);
 
auto imageView = image->createImageView(imgViewDesc);

ImageView objects are mapped to GLSL objects as follows:

GLSL image object if the ImageView was created with a ImageViewDescriptor with setIsSampled(false). For this case, image load/store operations should be used to access pixel data. See https://www.khronos.org/opengl/wiki/Image_Load_Store for more information.

For instance, an ImageView created as
// 8-bit unsigned, 4-channel, 640x480 image.

auto desc = ll::ImageDescriptor{}

.setWidth(640)

.setHeight(480)

.setChannelType(ll::ChannelType::Uint8)

.setChannelCount(4);

auto image = memory->createImage(desc);

// image view descriptor for a sampled image

auto imgViewDesc = ll::ImageViewDescriptor {}

.setNormalizedCoordinates(false)

.setIsSampled(false);

auto imageView = image->createImageView(imgViewDesc);

is accessed in a GLSL compute shader as
#version 450

#include "lluvia/core.glsl"

layout(binding = 0, rgba8ui) uniform uimage2D inputImage;

const uint OUTPUT_WIDTH = 32;

void main() {

const ivec2 coord = LL_GLOBAL_COORDS_2D;

uvec4 texValue = imageLoad(inputImage, coord);

}
GLSL sampler object if the ImageView was created with a ImageDescriptor with setIsSampled(true). In this case texture lookup and write operations should be used. See https://www.khronos.org/opengl/wiki/Sampler_(GLSL) for more information.

For instance, an ImageView created as
// 8-bit unsigned, 4-channel, 640x480 image.

auto desc = ll::ImageDescriptor{}

.setWidth(640)

.setHeight(480)

.setChannelType(ll::ChannelType::Uint8)

.setChannelCount(4);

auto image = memory->createImage(desc);

// image view descriptor for a sampled image

auto imgViewDesc = ll::ImageViewDescriptor {}

.setNormalizedCoordinates(false)

.setIsSampled(true)

.setAddressMode(ll::ImageAddressMode::Repeat)

.setFilterMode(ll::ImageFilterMode::Nearest);

auto imageView = image->createImageView(imgViewDesc);

is accessed in a GLSL compute shader as
#version 450

#include "lluvia/core.glsl"

layout(binding = 0) uniform usampler2D img;

void main() {

const ivec2 coord = LL_GLOBAL_COORDS_2D;

uvec4 texValue = texture(img, coord);

}

Constructor & Destructor Documentation

◆ ImageView() [1/3]

ll::ImageView::ImageView ( )

delete

◆ ImageView() [2/3]

ll::ImageView::ImageView ( const ImageView & )

delete

◆ ImageView() [3/3]

ll::ImageView::ImageView ( ImageView && )

delete

◆ ~ImageView()

ll::ImageView::~ImageView ( )

Member Function Documentation

◆ changeImageLayout()

void ll::ImageView::changeImageLayout ( const ll::ImageLayout newLayout )

Immediately changes the layout of the underlying ll::Image object.

This method creates a command buffer and submits it to change the layout of the image. Execution is blocked until the layout change is completed.

Parameters

[in] newLayout The new layout

◆ clear()

void ll::ImageView::clear ( )

Immediately clears the image pixels to zero.

This method creates a command buffer and sumbits it to clear all the pixels in the underlying image to zero. Execution is blocked until the operation is completed.

◆ copyTo()

void ll::ImageView::copyTo ( ll::ImageView & dst )

Immediately copies the content of this image view into the destination.

This method creates a command buffer and sumbits it to copy the content of this image view underlying Image object into dst Image object. No valiation of destination image shape is performed. Execution is blocked until the operation is completed.

Parameters

[in] dst The destination image view..

◆ getAllocationInfo()

ll::MemoryAllocationInfo ll::ImageView::getAllocationInfo ( ) const

noexcept

Gets the allocation information of the underlying ll::Image object.

Returns: The allocation information.

◆ getChannelCount()

template<typename T = ll::ChannelCount>

T ll::ImageView::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::ImageView::getChannelType ( ) const

noexcept

Gets the channel type.

Returns: The channel type.

◆ getChannelTypeSize()

uint64_t ll::ImageView::getChannelTypeSize ( ) const

noexcept

Gets the channel type size.

Returns: The channel type size.

◆ getDepth()

uint32_t ll::ImageView::getDepth ( ) const

noexcept

Gets the image view depth in pixels.

Returns: The image view depth in pixels.

◆ getDescriptor()

const ll::ImageViewDescriptor& ll::ImageView::getDescriptor ( ) const

noexcept

Gets the image view descriptor.

Returns: The descriptor.

◆ getHeight()

uint32_t ll::ImageView::getHeight ( ) const

noexcept

Gets the image view height in pixels.

Returns: The image view height in pixels.

◆ getImage()

const std::shared_ptr<ll::Image>& ll::ImageView::getImage ( ) const

noexcept

Gets the parent ll::Image this object was created from.

Returns: The parent ll::Image object.

◆ getImageDescriptor()

const ll::ImageDescriptor& ll::ImageView::getImageDescriptor ( ) const

noexcept

Gets the image descriptor.

Returns: The image descriptor.

◆ getLayout()

ll::ImageLayout ll::ImageView::getLayout ( ) const

noexcept

Gets the Vulkan image layout.

The layout is changed through invocations of Session::changeImageLayout or CommandBuffer::changeImageLayout.

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

Returns: The image layout.

◆ getMemory()

const std::shared_ptr<ll::Memory>& ll::ImageView::getMemory ( ) const

noexcept

Gets the memory the underlying ll::Image was allocated from.

Returns: The memory.

◆ getMinimumSize()

uint64_t ll::ImageView::getMinimumSize ( ) const

noexcept

Gets the minimum number of bytes to store the image contiguously in memory.

This methods is equivalent to:

uint64_t minimumSize = getWidth() *
                       getHeight() *
                       getDepth() *
                       getChannelTypeSize() *
                       static_cast<uint64_t>(getChannelCount())

Returns: The minimum image size in bytes.

◆ getShape()

ll::vec3ui ll::ImageView::getShape ( ) const

noexcept

Gets the shape of the image view.

The vec3ui object returned must be interpreted as follows:

x : width
y : height
z : depth

Returns: The shape.

◆ getSize()

uint64_t ll::ImageView::getSize ( ) const

noexcept

Gets the memory allocation size in bytes.

This methods is equivalent to calling getAllocationInfo().size.

The size reported by this method includes any row stride and padding needed to store the image in memory according to the device. Use :getMinimumSize: to get the minimum amount of memory to allocate all pixels contiguously in memory without any stride.

Returns: The image size in bytes.

◆ getTiling()

ll::ImageTiling ll::ImageView::getTiling ( ) const

noexcept

Gets the vulkan image tiling.

Returns: The image tiling.

◆ getType()

ll::ObjectType ll::ImageView::getType ( ) const

overridevirtualnoexcept

Gets the object type.

This method can be used for safely down-casting pointers of ll::Object type to its children.

ll::Object* ptr = ...
 
if (ptr->getType() == ll::ObjectType::Buffer) {
    auto bufferPtr = static_cast<ll::Buffer*>(ptr);
}

Returns: The object type.

Implements ll::Object.

◆ getUsageFlags()

ll::ImageUsageFlags ll::ImageView::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::ImageView::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::ImageView::getWidth ( ) const

noexcept

Gets the image view width in pixels.

Returns: The image view width in pixels.

◆ operator=() [1/2]

ImageView& ll::ImageView::operator= ( const ImageView & )

delete

◆ operator=() [2/2]

ImageView& ll::ImageView::operator= ( ImageView && )

delete

Friends And Related Function Documentation

◆ ComputeNode

friend class ComputeNode

friend

◆ Image

friend class Image

friend

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

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

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ImageView() [1/3]

◆ ImageView() [2/3]

◆ ImageView() [3/3]

◆ ~ImageView()

Member Function Documentation

◆ changeImageLayout()

◆ clear()

◆ copyTo()

◆ getAllocationInfo()

◆ getChannelCount()

◆ getChannelType()

◆ getChannelTypeSize()

◆ getDepth()

◆ getDescriptor()

◆ getHeight()

◆ getImage()

◆ getImageDescriptor()

◆ getLayout()

◆ getMemory()

◆ getMinimumSize()

◆ getShape()

◆ getSize()

◆ getTiling()

◆ getType()

◆ getUsageFlags()

◆ getUsageFlagsUnsafe()

◆ getWidth()

◆ operator=() [1/2]

◆ operator=() [2/2]

Friends And Related Function Documentation

◆ ComputeNode

◆ Image