TextureCube Class Reference

#include <texture.h>

Public Member Functions
	TextureCube (Core &core)
virtual	~TextureCube () override
bool	init (const SurfaceDescriptor &descriptor, bool generateMipMaps, const glm::vec4 &clearColor, VkImageUsageFlags requiredFlags, utility::ErrorState &errorState)
const glm::vec2	getSize () const
int	getWidth () const
int	getHeight () const
VkImageUsageFlags	getImageUsageFlags () const
virtual uint	getLayerCount () const override
virtual uint	getMipLevels () const override
virtual const ImageData &	getHandle () const override
virtual ImageData &	getHandle () override
Public Member Functions inherited from Texture
	Texture (Core &core)
virtual	~Texture ()
virtual VkImageLayout	getTargetLayout () const
VkFormat	getFormat () const
const SurfaceDescriptor &	getDescriptor () const
RenderService &	getRenderService ()
const RenderService &	getRenderService () const
virtual void	onDestroy () override
Public Member Functions inherited from Resource
	Resource ()
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
virtual bool	init (utility::ErrorState &errorState)
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
const EUsage	mUsage = EUsage::Static
	Texture usage (cube maps are currently always static) More...
Public Attributes inherited from Texture
nap::Signal	textureDestroyed
	Signal that is triggered before texture is destroyed. More...
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Static Public Attributes
static constexpr const uint	layerCount = 6

Protected Attributes
ImageData	mImageData = { TextureCube::layerCount }
	Cube Texture vulkan image buffers. More...
uint32	mMipLevels = 1
	Total number of generated mip-maps. More...
Protected Attributes inherited from Texture
RenderService &	mRenderService
	Reference to the render service. More...
SurfaceDescriptor	mDescriptor
	Texture description. More...
VkFormat	mFormat = VK_FORMAT_UNDEFINED
	Vulkan texture format. More...
VkClearColorValue	mClearColor = { 0.0f, 0.0f, 0.0f, 0.0f }
	Color used for clearing the texture. More...

Additional Inherited Members
Public Types inherited from Texture
enum	EUsage { Static, DynamicRead, DynamicWrite }
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)
Protected Member Functions inherited from Texture
virtual void	clear (VkCommandBuffer commandBuffer)
void	requestClear ()

Description

Cube texture base class. A cube texture is a six-layer image, where each layer represents one side

Cube image layers are addressed and oriented as follows:

• Layer 0: right (+X)
• Layer 1: left (-X)
• Layer 2: up (+Y)
• Layer 3: down (-Y)
• Layer 4: back (+Z)
• Layer 5: forward (-Z)

Inheritance diagram for TextureCube:

Collaboration diagram for TextureCube:

Constructor & Destructor Documentation

TextureCube()

TextureCube

(

Core &

core

)

~TextureCube()

virtual ~TextureCube ( )

overridevirtual

Member Function Documentation

getHandle() [1/2]

virtual const ImageData& getHandle ( ) const

overridevirtual

Returns

Vulkan GPU data handle, including image and view.

Implements Texture.

getHandle() [2/2]

virtual ImageData& getHandle ( )

overridevirtual

Note: This function should actually be protected but is required by nap::CubeRenderTarget in the naprenderadvanced module.

Returns

Vulkan GPU data handle, including image and view.

Implements Texture.

getHeight()

int getHeight

(

)

const

Returns

height of the texture in texels

getImageUsageFlags()

VkImageUsageFlags getImageUsageFlags

(

)

const

Returns

the vulkan image usage flags

getLayerCount()

virtual uint getLayerCount ( ) const

overridevirtual

Returns

the number of texture layers

Implements Texture.

getMipLevels()

virtual uint getMipLevels ( ) const

overridevirtual

Returns

the number of texture mip-map levels

Implements Texture.

getSize()

const glm::vec2 getSize

(

)

const

Returns

size of the texture in texels.

getWidth()

int getWidth

(

)

const

Returns

width of the texture in texels

init()

bool init	(	const SurfaceDescriptor &	descriptor,
		bool	generateMipMaps,
		const glm::vec4 &	clearColor,
		VkImageUsageFlags	requiredFlags,
		utility::ErrorState &	errorState
	)

Creates the texture on the GPU using the provided settings. The texture is cleared to 'ClearColor'. The Vulkan image usage flags are derived from texture usage.

Parameters

descriptor	texture description.
generateMipMaps	if mip-maps are auto generated
clearColor	the color to clear the texture with.
requiredFlags	image usage flags that are required, 0 = no additional usage flags.
errorState	contains the error if the texture can't be initialized.

Returns

if the texture initialized successfully.

Member Data Documentation

layerCount

constexpr const uint layerCount = 6

staticconstexpr

mImageData

ImageData mImageData = { TextureCube::layerCount }

protected

Cube Texture vulkan image buffers.

mMipLevels

uint32 mMipLevels = 1

protected

Total number of generated mip-maps.

mUsage

const EUsage mUsage = EUsage::Static

Texture usage (cube maps are currently always static)