Inheritance diagram for Cogs::TexturesVK:

Public Member Functions
void	initialize (class GraphicsDeviceVK *grapihcsDevice)

TextureHandle	loadTexture (const TextureDescription &desc, const TextureData *data) override
	Load a texture from the given description.

void	releaseTexture (TextureHandle textureHandle) override
	Release the texture with the given textureHandle.

SamplerStateHandle	loadSamplerState (const SamplerState &state) override
	Load a sampler state object.

void	releaseSamplerState (SamplerStateHandle handle) override
	Release the sampler state with the given handle.

TextureViewHandle	createTextureView (TextureViewDescription &viewDescription) override
	Create a texture view used to bind a limited view of the texture data to the rendering pipeline.

void	releaseTextureView (const TextureViewHandle &handle) override
	Release the given texture view.

void *	getNativeHandle (TextureHandle textureHandle) override
	Get the device-specific handle (D3D texture pointer, OpenGL texture ID etc) associated with the given texture handle.

void	generateMipmaps (TextureHandle textureHandle) override
	Use the graphics device to generate mipmaps for the texture with the given texture handle.

void	releaseResources () override
	Release all allocated texture resources.

void	updateTextureData (const TextureData *data, const uint32_t arraySize, const uint32_t numLevels, TextureVK &texture)

TextureHandle	loadTexture (const uint8_t *bytes, uint32_t width, uint32_t height, TextureFormat format, uint32_t flags) final

TextureHandle	loadTexture (const uint8_t *bytes, uint32_t width, uint32_t height, TextureFormat format, uint32_t numSamples, uint32_t flags) final

TextureHandle	loadTexture (const TextureDescription &desc, const TextureData *data)=0
	Load a texture from the given description.

virtual TextureHandle	loadTexture (const unsigned char *bytes, unsigned int width, unsigned int height, TextureFormat format, unsigned int flags=0)=0
	Load a texture using the given data to populate the texture contents.

virtual TextureHandle	loadTexture (const unsigned char *bytes, unsigned int width, unsigned int height, TextureFormat format, unsigned int numSamples, unsigned int flags)=0
	Load a texture using the given data to populate the texture contents.

virtual TextureHandle	loadTexture (const TextureDescription &desc, const TextureData *data)=0
	Load a texture from the given description.

Public Member Functions inherited from Cogs::TexturesCommon
TextureHandle	loadTexture (const uint8_t *bytes, uint32_t width, uint32_t height, TextureFormat format, uint32_t flags) final

TextureHandle	loadTexture (const uint8_t *bytes, uint32_t width, uint32_t height, TextureFormat format, uint32_t numSamples, uint32_t flags) final

TextureHandle	loadTextureMipMaps (const uint8_t *bytes, size_t numLevels, const uint32_t widths, const uint32_t *heights, TextureFormat format, uint32_t flags=0) final

TextureHandle	loadTextureArray (const uint8_t *bytes, const size_t arraySize, const size_t numLevels, const uint32_t widths, const uint32_t *heights, TextureFormat format, uint32_t flags=0) final

TextureHandle	loadCubeMap (const uint8_t *bytes, const size_t arraySize, const size_t numLevels, const uint32_t widths, const uint32_t *heights, TextureFormat format, uint32_t flags=0) final

TextureHandle	load (ResourceDimensions target, const uint8_t *bytes, const size_t arraySize, const size_t numLevels, const uint32_t widths, const uint32_t *heights, TextureFormat format, uint32_t numSamples, uint32_t flags)

TextureHandle	loadTexture (const TextureDescription &desc, const TextureData *data)=0
	Load a texture from the given description.

virtual TextureHandle	loadTexture (const unsigned char *bytes, unsigned int width, unsigned int height, TextureFormat format, unsigned int flags=0)=0
	Load a texture using the given data to populate the texture contents.

virtual TextureHandle	loadTexture (const unsigned char *bytes, unsigned int width, unsigned int height, TextureFormat format, unsigned int numSamples, unsigned int flags)=0
	Load a texture using the given data to populate the texture contents.

virtual TextureHandle	loadTexture (const TextureDescription &desc, const TextureData *data)=0
	Load a texture from the given description.

Public Member Functions inherited from Cogs::ITextures
virtual void	annotate (TextureHandle handle, const StringView &name)
	Associate a name with an object for use in graphics debugging.

virtual TextureHandle	loadTexture (const unsigned char *bytes, unsigned int width, unsigned int height, TextureFormat format, unsigned int flags=0)=0
	Load a texture using the given data to populate the texture contents.

virtual TextureHandle	loadTexture (const unsigned char *bytes, unsigned int width, unsigned int height, TextureFormat format, unsigned int numSamples, unsigned int flags)=0
	Load a texture using the given data to populate the texture contents.

virtual TextureHandle	loadTextureMipMaps (const unsigned char *bytes, size_t numLevels, const unsigned int widths, const unsigned int *heights, TextureFormat format, unsigned int flags=0)=0
	Load a texture with multiple mipmap levels using the given data to populate the texture contents.

virtual TextureHandle	loadTextureArray (const unsigned char *bytes, const size_t arraySize, const size_t numLevels, const unsigned int widths, const unsigned int *heights, TextureFormat format, unsigned int flags=0)=0
	Load an array texture with mipmaps using the given data to populate the texture contents.

virtual TextureHandle	loadCubeMap (const unsigned char *bytes, const size_t arraySize, const size_t numLevels, const unsigned int widths, const unsigned int *heights, TextureFormat format, unsigned int flags=0)=0
	Load a cube map texture with mipmaps using the given data to populate the texture contents.

virtual TextureHandle	loadTexture (const TextureDescription &desc, const TextureData *data)=0
	Load a texture from the given description.

virtual void	uploadTextureData (TextureHandle textureHandle, const TextureData &data, uint32_t layer_offset=0, uint32_t face_offset=0, uint32_t level_offset=0)
	Upload a texture from the given description.

virtual void	releaseTexture (TextureHandle textureHandle)=0
	Release the texture with the given textureHandle.

virtual void	releaseNativeTexture (TextureNativeHandle nativeHandle)
	Release a native texture handle.

virtual TextureViewHandle	createTextureView (TextureViewDescription &viewDescription)=0
	Create a texture view used to bind a limited view of the texture data to the rendering pipeline.

virtual void	releaseTextureView (const TextureViewHandle &handle)=0
	Release the given texture view.

virtual SamplerStateHandle	loadSamplerState (const SamplerState &state)=0
	Load a sampler state object.

virtual void	releaseSamplerState (SamplerStateHandle handle)=0
	Release the sampler state with the given handle.

virtual void	generateMipmaps (TextureHandle textureHandle)=0
	Use the graphics device to generate mipmaps for the texture with the given texture handle.

virtual void *	getNativeHandle (TextureHandle textureHandle)=0
	Get the device-specific handle (D3D texture pointer, OpenGL texture ID etc) associated with the given texture handle.

virtual void	releaseResources ()=0
	Release all allocated texture resources.

Public Attributes
ResourceMap< TextureHandle, TextureVK >	textures

ResourceMap< SamplerStateHandle, SamplerVK >	samplers

GraphicsDeviceVK *	graphicsDevice

VkDevice	device

Detailed Description

Definition at line 43 of file TexturesVK.h.

Member Function Documentation

◆ createTextureView()

Cogs::TextureViewHandle Cogs::TexturesVK::createTextureView ( TextureViewDescription & viewDescription )

overridevirtual

Create a texture view used to bind a limited view of the texture data to the rendering pipeline.

Parameters

viewDescription Description of the texture view.

Returns: Handle to the create texture view, InvalidHandle if error.

Implements Cogs::ITextures.

Definition at line 345 of file TexturesVK.cpp.

◆ generateMipmaps()

void Cogs::TexturesVK::generateMipmaps ( TextureHandle textureHandle )

overridevirtual

Use the graphics device to generate mipmaps for the texture with the given texture handle.

Parameters

textureHandle Valid handle to a previously created texture object. The texture must have been created with the TextureFlags::GenerateMipMaps flag.

Implements Cogs::ITextures.

Definition at line 105 of file TexturesVK.cpp.

◆ getNativeHandle()

void * Cogs::TexturesVK::getNativeHandle ( TextureHandle textureHandle )

overridevirtual

Get the device-specific handle (D3D texture pointer, OpenGL texture ID etc) associated with the given texture handle.

Parameters

textureHandle Valid handle to a previously created texture object.

Returns: Native handle

Implements Cogs::ITextures.

Definition at line 354 of file TexturesVK.cpp.

◆ initialize()

void Cogs::TexturesVK::initialize ( class GraphicsDeviceVK * grapihcsDevice )

Definition at line 12 of file TexturesVK.cpp.

◆ loadSamplerState()

Cogs::SamplerStateHandle Cogs::TexturesVK::loadSamplerState ( const SamplerState & state )

overridevirtual

Load a sampler state object.

Parameters

state Sampler state structure used to initialize the sampler state object on the graphics device.

Returns: Handle to the newly created sampler state object, InvalidHandle if the operation failed.

Implements Cogs::ITextures.

Definition at line 29 of file TexturesVK.cpp.

References Cogs::SamplerState::addressModeS, Cogs::SamplerState::addressModeT, Cogs::SamplerState::addressModeW, Cogs::SamplerState::borderColor, Cogs::SamplerState::comparisonFunction, Cogs::SamplerState::filter, Cogs::Handle_t< SamplerTag >::InvalidHandle, and Cogs::SamplerState::maxAnisotropy.

◆ loadTexture() [1/7]

Cogs::TextureHandle Cogs::TexturesVK::loadTexture	(	const TextureDescription &	desc,
		const TextureData *	data
	)

overridevirtual

Load a texture from the given description.

Parameters

desc	Texture description.
data	Optional texture content.

Implements Cogs::TexturesCommon.

Definition at line 113 of file TexturesVK.cpp.

References Cogs::TextureFlags::DepthBuffer, Cogs::TextureFlags::ExternalTexture, Cogs::Handle_t< TextureTag >::InvalidHandle, Cogs::TextureFlags::RenderTarget, and Cogs::TextureFlags::Texture.

◆ loadTexture() [2/7]

TextureHandle Cogs::TexturesCommon::loadTexture	(	const TextureDescription &	desc,
		const TextureData *	data
	)

virtual

Load a texture from the given description.

Parameters

desc	Texture description.
data	Optional texture content.

Implements Cogs::TexturesCommon.

◆ loadTexture() [3/7]

virtual TextureHandle Cogs::ITextures::loadTexture	(	const TextureDescription &	desc,
		const TextureData *	data
	)

virtual

Load a texture from the given description.

Parameters

desc	Texture description.
data	Optional texture content.

Implements Cogs::TexturesCommon.

◆ loadTexture() [4/7]

Cogs::TextureHandle Cogs::TexturesCommon::loadTexture	(	const uint8_t *	bytes,
		uint32_t	width,
		uint32_t	height,
		TextureFormat	format,
		uint32_t	flags
	)

final

Definition at line 10 of file TexturesCommon.cpp.

◆ loadTexture() [5/7]

Cogs::TextureHandle Cogs::TexturesCommon::loadTexture	(	const uint8_t *	bytes,
		uint32_t	width,
		uint32_t	height,
		TextureFormat	format,
		uint32_t	numSamples,
		uint32_t	flags
	)

final

Definition at line 11 of file TexturesCommon.cpp.

◆ loadTexture() [6/7]

virtual TextureHandle Cogs::ITextures::loadTexture	(	const unsigned char *	bytes,
		unsigned int	width,
		unsigned int	height,
		TextureFormat	format,
		unsigned int	flags = `0`
	)

virtual

Load a texture using the given data to populate the texture contents.

Parameters

bytes	Pointer to texture data. If nullptr is given an empty texture with the given dimensions and format is created.
width	Width of the texture in pixels.
height	Height of the texture in pixels.
format	Format of the texture data.
flags	Texture flags used to determine which operations are supported by the created texture.

Returns: Handle to the newly created texture object, InvalidHandle if the operation failed.

Reimplemented from Cogs::TexturesCommon.

◆ loadTexture() [7/7]

virtual TextureHandle Cogs::ITextures::loadTexture	(	const unsigned char *	bytes,
		unsigned int	width,
		unsigned int	height,
		TextureFormat	format,
		unsigned int	numSamples,
		unsigned int	flags
	)

virtual

Load a texture using the given data to populate the texture contents.

Parameters

bytes	Pointer to texture data. If nullptr is given an empty texture with the given dimensions and format is created.
width	Width of the texture in pixels.
height	Height of the texture in pixels.
format	Format of the texture data.
numSamples	Number of samples to use per pixel in the texture.
flags	Texture flags used to determine which operations are supported by the created texture.

Returns: Handle to the newly created texture object, InvalidHandle if the operation failed.

Reimplemented from Cogs::TexturesCommon.

◆ releaseResources()

void Cogs::TexturesVK::releaseResources ( )

overridevirtual

Release all allocated texture resources.

Implements Cogs::ITextures.

Definition at line 109 of file TexturesVK.cpp.

◆ releaseSamplerState()

void Cogs::TexturesVK::releaseSamplerState ( SamplerStateHandle handle )

overridevirtual

Release the sampler state with the given handle.

Parameters

handle Valid handle to a previously created sampler state.

Implements Cogs::ITextures.

Definition at line 101 of file TexturesVK.cpp.

◆ releaseTexture()

void Cogs::TexturesVK::releaseTexture ( TextureHandle textureHandle )

overridevirtual

Release the texture with the given textureHandle.

Parameters

textureHandle Valid handle to a previously created texture object.

Implements Cogs::ITextures.

Definition at line 18 of file TexturesVK.cpp.

◆ releaseTextureView()

void Cogs::TexturesVK::releaseTextureView ( const TextureViewHandle & handle )

overridevirtual

Release the given texture view.

Parameters

handle Valid handle to a previously created texture view.

Implements Cogs::ITextures.

Definition at line 350 of file TexturesVK.cpp.

◆ updateTextureData()

void Cogs::TexturesVK::updateTextureData	(	const TextureData *	data,
		const uint32_t	arraySize,
		const uint32_t	numLevels,
		TextureVK &	texture
	)

Definition at line 247 of file TexturesVK.cpp.

Member Data Documentation

◆ device

VkDevice Cogs::TexturesVK::device

Definition at line 67 of file TexturesVK.h.

◆ graphicsDevice

GraphicsDeviceVK* Cogs::TexturesVK::graphicsDevice

Definition at line 66 of file TexturesVK.h.

◆ samplers

ResourceMap<SamplerStateHandle, SamplerVK> Cogs::TexturesVK::samplers

Definition at line 64 of file TexturesVK.h.

◆ textures

ResourceMap<TextureHandle, TextureVK> Cogs::TexturesVK::textures

Definition at line 63 of file TexturesVK.h.

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

D:/a/1/s/Cogs/Cogs.Rendering/Source/Vulkan/TexturesVK.h
D:/a/1/s/Cogs/Cogs.Rendering/Source/Vulkan/TexturesVK.cpp

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ createTextureView()

◆ generateMipmaps()

◆ getNativeHandle()

◆ initialize()

◆ loadSamplerState()

◆ loadTexture() [1/7]

◆ loadTexture() [2/7]

◆ loadTexture() [3/7]

◆ loadTexture() [4/7]

◆ loadTexture() [5/7]

◆ loadTexture() [6/7]

◆ loadTexture() [7/7]

◆ releaseResources()

◆ releaseSamplerState()

◆ releaseTexture()

◆ releaseTextureView()

◆ updateTextureData()

Member Data Documentation

◆ device

◆ graphicsDevice

◆ samplers

◆ textures