Resource that represents a cubemap image. More...

#include <ImageCube.hpp>

Inheritance diagram for PixelBullet::ImageCube:

Public Member Functions
	ImageCube (const VirtualPath &assetPath, std::string fileSuffix=".png", VkFilter filter=VK_FILTER_LINEAR, VkSamplerAddressMode addressMode=VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, bool anisotropic=true, bool mipmap=true, bool load=true)

	ImageCube (const glm::uvec2 &extent, VkFormat format=VK_FORMAT_R8G8B8A8_UNORM, VkImageLayout layout=VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VkImageUsageFlags usage=VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT\|VK_IMAGE_USAGE_STORAGE_BIT, VkFilter filter=VK_FILTER_LINEAR, VkSamplerAddressMode addressMode=VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, VkSampleCountFlagBits samples=VK_SAMPLE_COUNT_1_BIT, bool anisotropic=false, bool mipmap=false)

	ImageCube (std::unique_ptr< Bitmap > &&bitmap, VkFormat format=VK_FORMAT_R8G8B8A8_UNORM, VkImageLayout layout=VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VkImageUsageFlags usage=VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT\|VK_IMAGE_USAGE_STORAGE_BIT, VkFilter filter=VK_FILTER_LINEAR, VkSamplerAddressMode addressMode=VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, VkSampleCountFlagBits samples=VK_SAMPLE_COUNT_1_BIT, bool anisotropic=false, bool mipmap=false)

std::unique_ptr< Bitmap >	GetBitmap (uint32_t mipLevel=0) const

void	SetPixels (const uint8_t *pixels, uint32_t layerCount, uint32_t baseArrayLayer)

std::type_index	GetTypeIndex () const override
	Returns the type index of the resource.

const VirtualPath &	GetAssetPath () const

const std::string &	GetFileSuffix () const

const std::vector< std::string > &	GetFileSides () const

bool	IsAnisotropic () const

bool	IsMipmap () const

uint32_t	GetComponents () const

Public Member Functions inherited from PixelBullet::Image
	Image (VkFilter filter, VkSamplerAddressMode addressMode, VkSampleCountFlagBits samples, VkImageLayout layout, VkImageUsageFlags usage, VkFormat format, uint32_t mipLevels, uint32_t arrayLayers, const VkExtent3D &extent)

WriteDescriptorSet	GetWriteDescriptor (uint32_t binding, VkDescriptorType descriptorType, const std::optional< OffsetSize > &offsetSize) const override

std::unique_ptr< Bitmap >	GetBitmap (uint32_t mipLevel=0, uint32_t arrayLayer=0) const

const VkExtent3D &	GetExtent () const

glm::uvec2	GetSize () const

VkFormat	GetFormat () const

VkSampleCountFlagBits	GetSamples () const

VkImageUsageFlags	GetUsage () const

uint32_t	GetMipLevels () const

uint32_t	GetArrayLevels () const

VkFilter	GetFilter () const

VkSamplerAddressMode	GetAddressMode () const

VkImageLayout	GetLayout () const

const VkImage &	GetImage ()

const VkDeviceMemory &	GetMemory ()

const VkSampler &	GetSampler () const

const VkImageView &	GetView () const

Public Member Functions inherited from PixelBullet::Descriptor
Public Member Functions inherited from PixelBullet::Resource

Static Public Member Functions
static std::shared_ptr< ImageCube >	Create (const Node &node)

static std::shared_ptr< ImageCube >	Create (const VirtualPath &assetPath, const std::string &fileSuffix, VkFilter filter=VK_FILTER_LINEAR, VkSamplerAddressMode addressMode=VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, bool anisotropic=true, bool mipmap=true)

Static Public Member Functions inherited from PixelBullet::Image
static VkDescriptorSetLayoutBinding	GetDescriptorSetLayout (uint32_t binding, VkDescriptorType descriptorType, VkShaderStageFlags stage, uint32_t count)

static uint32_t	GetMipLevels (const VkExtent3D &extent)

static VkFormat	FindSupportedFormat (const std::vector< VkFormat > &candidates, VkImageTiling tiling, VkFormatFeatureFlags features)

static bool	HasDepth (VkFormat format)

static bool	HasStencil (VkFormat format)

static void	CreateImage (VkImage &image, VkDeviceMemory &memory, const VkExtent3D &extent, VkFormat format, VkSampleCountFlagBits samples, VkImageTiling tiling, VkImageUsageFlags usage, VkMemoryPropertyFlags properties, uint32_t mipLevels, uint32_t arrayLayers, VkImageType type)

static void	CreateImageSampler (VkSampler &sampler, VkFilter filter, VkSamplerAddressMode addressMode, bool anisotropic, uint32_t mipLevels)

static void	CreateImageView (const VkImage &image, VkImageView &imageView, VkImageViewType type, VkFormat format, VkImageAspectFlags imageAspect, uint32_t mipLevels, uint32_t baseMipLevel, uint32_t layerCount, uint32_t baseArrayLayer)

static void	CreateMipmaps (const VkImage &image, const VkExtent3D &extent, VkFormat format, VkImageLayout dstImageLayout, uint32_t mipLevels, uint32_t baseArrayLayer, uint32_t layerCount)

static void	TransitionImageLayout (const VkImage &image, VkFormat format, VkImageLayout srcImageLayout, VkImageLayout dstImageLayout, VkImageAspectFlags imageAspect, uint32_t mipLevels, uint32_t baseMipLevel, uint32_t layerCount, uint32_t baseArrayLayer)

static void	InsertImageMemoryBarrier (const CommandBuffer &commandBuffer, const VkImage &image, VkAccessFlags srcAccessMask, VkAccessFlags dstAccessMask, VkImageLayout oldImageLayout, VkImageLayout newImageLayout, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask, VkImageAspectFlags imageAspect, uint32_t mipLevels, uint32_t baseMipLevel, uint32_t layerCount, uint32_t baseArrayLayer)

static void	CopyBufferToImage (const VkBuffer &buffer, const VkImage &image, const VkExtent3D &extent, uint32_t layerCount, uint32_t baseArrayLayer)

static bool	CopyImage (const VkImage &srcImage, VkImage &dstImage, VkDeviceMemory &dstImageMemory, VkFormat srcFormat, const VkExtent3D &extent, VkImageLayout srcImageLayout, uint32_t mipLevel, uint32_t arrayLayer)

Friends
const Node &	operator>> (const Node &node, ImageCube &image)

Node &	operator<< (Node &node, const ImageCube &image)

Additional Inherited Members
Protected Attributes inherited from PixelBullet::Image
VkExtent3D	m_Extent

VkSampleCountFlagBits	m_Samples

VkImageUsageFlags	m_Usage

VkFormat	m_Format = VK_FORMAT_UNDEFINED

uint32_t	m_MIPLevels = 0

uint32_t	m_ArrayLayers

VkFilter	m_Filter

VkSamplerAddressMode	m_AddressMode

VkImageLayout	m_Layout

VkImage	m_Image = VK_NULL_HANDLE

VkDeviceMemory	m_Memory = VK_NULL_HANDLE

VkSampler	m_Sampler = VK_NULL_HANDLE

VkImageView	m_View = VK_NULL_HANDLE

Detailed Description

Resource that represents a cubemap image.

Constructor & Destructor Documentation

◆ ImageCube() [1/3]

PixelBullet::ImageCube::ImageCube	(	const VirtualPath &	assetPath,
		std::string	fileSuffix = ".png",
		VkFilter	filter = VK_FILTER_LINEAR,
		VkSamplerAddressMode	addressMode = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
		bool	anisotropic = true,
		bool	mipmap = true,
		bool	load = true )

explicit

Creates a new cubemap image.

Parameters

assetPath	The asset path to load the image from.
fileSuffix	The file's extension type (ex .png).
filter	The magnification/minification filter to apply to lookups.
addressMode	The addressing mode for outside [0..1] range.
anisotropic	If anisotropic filtering is enabled.
mipmap	If mipmaps will be generated.
load	If this resource will be loaded immediately; otherwise, Load() can be called later.

◆ ImageCube() [2/3]

PixelBullet::ImageCube::ImageCube	(	const glm::uvec2 &	extent,
		VkFormat	format = VK_FORMAT_R8G8B8A8_UNORM,
		VkImageLayout	layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
		VkImageUsageFlags	usage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT \| VK_IMAGE_USAGE_STORAGE_BIT,
		VkFilter	filter = VK_FILTER_LINEAR,
		VkSamplerAddressMode	addressMode = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
		VkSampleCountFlagBits	samples = VK_SAMPLE_COUNT_1_BIT,
		bool	anisotropic = false,
		bool	mipmap = false )

explicit

Creates a new cubemap image.

Parameters

extent	The image's extent in pixels.
format	The format and type of the texel blocks that will be contained in the image.
layout	The layout that the image subresources are accessible from.
usage	The intended usage of the image.
filter	The magnification/minification filter to apply to lookups.
addressMode	The addressing mode for outside [0..1] range.
samples	The number of samples per texel.
anisotropic	If anisotropic filtering is enabled.
mipmap	If mipmaps will be generated.

◆ ImageCube() [3/3]

PixelBullet::ImageCube::ImageCube	(	std::unique_ptr< Bitmap > &&	bitmap,
		VkFormat	format = VK_FORMAT_R8G8B8A8_UNORM,
		VkImageLayout	layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
		VkImageUsageFlags	usage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT \| VK_IMAGE_USAGE_STORAGE_BIT,
		VkFilter	filter = VK_FILTER_LINEAR,
		VkSamplerAddressMode	addressMode = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
		VkSampleCountFlagBits	samples = VK_SAMPLE_COUNT_1_BIT,
		bool	anisotropic = false,
		bool	mipmap = false )

explicit

Creates a new cubemap image.

Parameters

bitmap	The bitmap to load from.
format	The format and type of the texel blocks that will be contained in the image.
layout	The layout that the image subresources are accessible from.
usage	The intended usage of the image.
filter	The magnification/minification filter to apply to lookups.
addressMode	The addressing mode for outside [0..1] range.
samples	The number of samples per texel.
anisotropic	If anisotropic filtering is enabled.
mipmap	If mipmaps will be generated.

Member Function Documentation

◆ Create() [1/2]

std::shared_ptr< ImageCube > PixelBullet::ImageCube::Create ( const Node & node )

static

Creates a new cubemap image, or finds one with the same values.

Parameters

node	The node to decode values from.

Returns: The cubemap image with the requested values.

◆ Create() [2/2]

std::shared_ptr< ImageCube > PixelBullet::ImageCube::Create	(	const VirtualPath &	assetPath,
		const std::string &	fileSuffix,
		VkFilter	filter = VK_FILTER_LINEAR,
		VkSamplerAddressMode	addressMode = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
		bool	anisotropic = true,
		bool	mipmap = true )

static

Creates a new cubemap image.

Parameters

assetPath	The asset path to load the image from.
fileSuffix	The file's extension type (ex .png).
filter	The magnification/minification filter to apply to lookups.
addressMode	The addressing mode for outside [0..1] range.
anisotropic	If anisotropic filtering is enabled.
mipmap	If mipmaps will be generated.

Returns: The cubemap image with the requested values.

◆ GetBitmap()

std::unique_ptr< Bitmap > PixelBullet::ImageCube::GetBitmap ( uint32_t mipLevel = 0 ) const

Copies the image's pixels from memory to a bitmap. The bitmap height will be scaled by the number of layers.

Parameters

mipLevel The mipmap level index to sample.

Returns: A copy of the image's pixels.

◆ GetTypeIndex()

std::type_index PixelBullet::ImageCube::GetTypeIndex ( ) const

inlineoverridevirtual

Returns the type index of the resource.

Implements PixelBullet::Resource.

◆ SetPixels()

void PixelBullet::ImageCube::SetPixels	(	const uint8_t *	pixels,
		uint32_t	layerCount,
		uint32_t	baseArrayLayer )

Sets the pixels of this image.

Parameters

pixels	The pixels to copy from.
layerCount	The number of layers contained in the pixels.
baseArrayLayer	The first layer to copy into.

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

engine/src/PixelBullet/Graphics/Images/ImageCube.hpp
engine/src/PixelBullet/Graphics/Images/ImageCube.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageCube() [1/3]

◆ ImageCube() [2/3]

◆ ImageCube() [3/3]

Member Function Documentation

◆ Create() [1/2]

◆ Create() [2/2]

◆ GetBitmap()

◆ GetTypeIndex()

◆ SetPixels()