Describes a factory that creates objects for a IGraphicsDevice. More...

#include <GraphicsFactory.h>

Inheritance diagram for spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >:

Public Types
using	descriptor_layout_type = DescriptorLayoutType

using	vertex_buffer_type = VertexBufferType

using	vertex_buffer_layout_type = typename vertex_buffer_type::vertex_buffer_layout_type

using	index_buffer_type = IndexBufferType

using	index_buffer_layout_type = typename index_buffer_type::index_buffer_layout_type

using	buffer_type = RawBufferType

using	image_type = ImageType

using	sampler_type = SamplerType

Public Member Functions
virtual std::unique_ptr< buffer_type >	createBuffer (BufferType type, BufferUsage usage, std::size_t element_size, unsigned elements, bool allow_write=false) const =0
	Creates a IBuffer of type `type`.

virtual std::unique_ptr< buffer_type >	createBuffer (const std::string &name, BufferType type, BufferUsage usage, std::size_t element_size, unsigned elements, bool allow_write=false) const =0
	Creates a IBuffer of type `type`.

virtual std::unique_ptr< vertex_buffer_type >	createVertexBuffer (const vertex_buffer_layout_type &layout, BufferUsage usage, unsigned elements=1) const =0
	Creates a IVertexBuffer based on `layout`.

virtual std::unique_ptr< vertex_buffer_type >	createVertexBuffer (const std::string &name, const vertex_buffer_layout_type &layout, BufferUsage usage, unsigned elements=1) const =0
	Creates a IVertexBuffer based on `layout`.

virtual std::unique_ptr< index_buffer_type >	createIndexBuffer (const index_buffer_layout_type &layout, BufferUsage usage, unsigned elements) const =0
	Creates a IVertexBuffer based on `layout`.

virtual std::unique_ptr< index_buffer_type >	createIndexBuffer (const std::string &name, const index_buffer_layout_type &layout, BufferUsage usage, unsigned elements) const =0
	Creates a IVertexBuffer based on `layout`.

virtual std::unique_ptr< image_type >	createAttachment (Format format, const math::Vector2< unsigned > &size, MultiSamplingLevel samples=MultiSamplingLevel::X1) const =0
	Creates an Image used as a render target attachment.

virtual std::unique_ptr< image_type >	createAttachment (const std::string &name, Format format, const math::Vector2< unsigned > &size, MultiSamplingLevel samples=MultiSamplingLevel::X1) const =0
	Creates an Image used as a render target attachment.

virtual std::unique_ptr< image_type >	createTexture (Format format, const math::Vector3< unsigned > &size, ImageDimensions dimension=ImageDimensions::DIM_2, unsigned levels=1, unsigned layers=1, MultiSamplingLevel samples=MultiSamplingLevel::X1, bool allow_write=false) const =0
	Creates a texture .

virtual std::unique_ptr< image_type >	createTexture (const std::string &name, Format format, const math::Vector3< unsigned > &size, ImageDimensions dimension=ImageDimensions::DIM_2, unsigned levels=1, unsigned layers=1, MultiSamplingLevel samples=MultiSamplingLevel::X1, bool allow_write=false) const =0
	Creates a texture .

virtual std::vector< std::unique_ptr< image_type > >	createTextures (std::size_t elements, Format format, const math::Vector3< unsigned > &size, ImageDimensions dimension=ImageDimensions::DIM_2, unsigned layers=1, unsigned levels=1, MultiSamplingLevel samples=MultiSamplingLevel::X1, bool allow_write=false) const =0
	Creates an array of textures .

virtual std::unique_ptr< sampler_type >	createSampler (FilterMode mag_filter=FilterMode::Nearest, FilterMode min_filter=FilterMode::Nearest, BorderMode border_u=BorderMode::Repeat, BorderMode border_v=BorderMode::Repeat, BorderMode border_w=BorderMode::Repeat, MipMapMode mip_map_mode=MipMapMode::Nearest, float mip_map_bias=0.f, float max_lod=std::numeric_limits< float >::max(), float min_lod=0.f, float anisotropy=0.f) const =0
	Creates a texture sampler .

virtual std::unique_ptr< sampler_type >	createSampler (const std::string &name, FilterMode mag_filter=FilterMode::Nearest, FilterMode min_filter=FilterMode::Nearest, BorderMode border_u=BorderMode::Repeat, BorderMode border_v=BorderMode::Repeat, BorderMode border_w=BorderMode::Repeat, MipMapMode mip_map_mode=MipMapMode::Nearest, float mip_map_bias=0.f, float max_lod=std::numeric_limits< float >::max(), float min_lod=0.f, float anisotropy=0.f) const =0
	Creates a texture sampler .

virtual std::vector< std::unique_ptr< sampler_type > >	createSamplers (std::size_t elements, FilterMode mag_filter=FilterMode::Nearest, FilterMode min_filter=FilterMode::Nearest, BorderMode border_u=BorderMode::Repeat, BorderMode border_v=BorderMode::Repeat, BorderMode border_w=BorderMode::Repeat, MipMapMode mip_map_mode=MipMapMode::Nearest, float mip_map_bias=0.f, float max_lod=std::numeric_limits< float >::max(), float min_lod=0.f, float anisotropy=0.f) const =0
	Creates an array of texture samplers .

Public Member Functions inherited from spark::render::IGraphicsFactory
std::unique_ptr< IBuffer >	createBuffer (BufferType type, BufferUsage usage, std::size_t element_size, unsigned elements=1, bool allow_write=false) const
	Creates a IBuffer of type `type`.

std::unique_ptr< IBuffer >	createBuffer (const std::string &name, BufferType type, BufferUsage usage, std::size_t element_size, unsigned elements, bool allow_write=false) const
	Creates a IBuffer of type `type`.

std::unique_ptr< IBuffer >	createBuffer (const IDescriptorSetLayout &descriptor_set, unsigned binding, BufferUsage usage, unsigned elements=1, bool allow_write=false) const
	Creates a IBuffer that can be bound to the specified `descriptor_set` and `binding`.

std::unique_ptr< IBuffer >	createBuffer (const std::string &name, const IDescriptorSetLayout &descriptor_set, unsigned binding, BufferUsage usage, unsigned elements=1, bool allow_write=false) const
	Creates a IBuffer that can be bound to the specified `descriptor_set` and `binding`.

std::unique_ptr< IBuffer >	createBuffer (const IDescriptorSetLayout &descriptor_set, unsigned binding, BufferUsage usage, std::size_t element_size, unsigned elements, bool allow_write=false) const
	Creates a IBuffer that can be bound to the specified `descriptor_set` and `binding`.

std::unique_ptr< IBuffer >	createBuffer (const std::string &name, const IDescriptorSetLayout &descriptor_set, unsigned binding, BufferUsage usage, std::size_t element_size, unsigned elements, bool allow_write=false) const
	Creates a IBuffer that can be bound to a descriptor set of the specified `pipeline`, `space` and `binding`.

std::unique_ptr< IBuffer >	createBuffer (const IPipeline &pipeline, unsigned space, unsigned binding, BufferUsage usage, unsigned elements=1, bool allow_write=false) const
	Creates a IBuffer that can be bound to a descriptor set of the specified `pipeline`, `space` and `binding`.

std::unique_ptr< IBuffer >	createBuffer (const std::string &name, const IPipeline &pipeline, unsigned space, unsigned binding, BufferUsage usage, unsigned elements=1, bool allow_write=false) const
	Creates a IBuffer that can be bound to the specified `descriptor_set` and `binding`.

std::unique_ptr< IBuffer >	createBuffer (const IPipeline &pipeline, unsigned space, unsigned binding, BufferUsage usage, std::size_t element_size, unsigned elements, bool allow_write=false) const
	Creates a IBuffer that can be bound to a descriptor set of the specified `pipeline`, `space` and `binding`.

std::unique_ptr< IBuffer >	createBuffer (const std::string &name, const IPipeline &pipeline, unsigned space, unsigned binding, BufferUsage usage, std::size_t element_size, unsigned elements=1, bool allow_write=false) const
	Creates a IBuffer that can be bound to a descriptor set of the specified `pipeline`, `space` and `binding`.

std::unique_ptr< IVertexBuffer >	createVertexBuffer (const IVertexBufferLayout &layout, BufferUsage usage, unsigned elements=1) const
	Creates a IVertexBuffer based on `layout`.

std::unique_ptr< IVertexBuffer >	createVertexBuffer (const std::string &name, const IVertexBufferLayout &layout, BufferUsage usage, unsigned elements=1) const
	Creates a IVertexBuffer based on `layout`.

std::unique_ptr< IIndexBuffer >	createIndexBuffer (const IIndexBufferLayout &layout, BufferUsage usage, unsigned elements) const
	Creates a IVertexBuffer based on `layout`.

std::unique_ptr< IIndexBuffer >	createIndexBuffer (const std::string &name, const IIndexBufferLayout &layout, BufferUsage usage, unsigned elements) const
	Creates a IVertexBuffer based on `layout`.

std::unique_ptr< IImage >	createAttachment (Format format, const math::Vector2< unsigned > &size, MultiSamplingLevel samples=MultiSamplingLevel::X1) const
	Creates an Image used as a render target attachment.

std::unique_ptr< IImage >	createAttachment (const std::string &name, Format format, const math::Vector2< unsigned > &size, MultiSamplingLevel samples=MultiSamplingLevel::X1) const
	Creates an Image used as a render target attachment.

std::unique_ptr< IImage >	createTexture (Format format, const math::Vector3< unsigned > &size, ImageDimensions dimension=ImageDimensions::DIM_2, unsigned levels=1, unsigned layers=1, MultiSamplingLevel samples=MultiSamplingLevel::X1, bool allow_write=false) const
	Creates a texture .

std::unique_ptr< IImage >	createTexture (const std::string &name, Format format, const math::Vector3< unsigned > &size, ImageDimensions dimension=ImageDimensions::DIM_2, unsigned levels=1, unsigned layers=1, MultiSamplingLevel samples=MultiSamplingLevel::X1, bool allow_write=false) const
	Creates a texture .

std::vector< std::unique_ptr< IImage > >	createTextures (std::size_t elements, Format format, const math::Vector3< unsigned > &size, ImageDimensions dimension=ImageDimensions::DIM_2, unsigned layers=1, unsigned levels=1, MultiSamplingLevel samples=MultiSamplingLevel::X1, bool allow_write=false) const
	Creates an array of textures .

std::unique_ptr< ISampler >	createSampler (FilterMode mag_filter=FilterMode::Nearest, FilterMode min_filter=FilterMode::Nearest, BorderMode border_u=BorderMode::Repeat, BorderMode border_v=BorderMode::Repeat, BorderMode border_w=BorderMode::Repeat, MipMapMode mip_map_mode=MipMapMode::Nearest, float mip_map_bias=0.f, float max_lod=std::numeric_limits< float >::max(), float min_lod=0.f, float anisotropy=0.f) const
	Creates a texture sampler .

std::unique_ptr< ISampler >	createSampler (const std::string &name, FilterMode mag_filter=FilterMode::Nearest, FilterMode min_filter=FilterMode::Nearest, BorderMode border_u=BorderMode::Repeat, BorderMode border_v=BorderMode::Repeat, BorderMode border_w=BorderMode::Repeat, MipMapMode mip_map_mode=MipMapMode::Nearest, float mip_map_bias=0.f, float max_lod=std::numeric_limits< float >::max(), float min_lod=0.f, float anisotropy=0.f) const
	Creates a texture sampler .

std::vector< std::unique_ptr< ISampler > >	createSamplers (std::size_t elements, FilterMode mag_filter=FilterMode::Nearest, FilterMode min_filter=FilterMode::Nearest, BorderMode border_u=BorderMode::Repeat, BorderMode border_v=BorderMode::Repeat, BorderMode border_w=BorderMode::Repeat, MipMapMode mip_map_mode=MipMapMode::Nearest, float mip_map_bias=0.f, float max_lod=std::numeric_limits< float >::max(), float min_lod=0.f, float anisotropy=0.f) const
	Creates an array of texture samplers .

Detailed Description

template<typename DescriptorLayoutType, typename RawBufferType, typename VertexBufferType, typename IndexBufferType, typename ImageType, typename SamplerType>
class spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >

Describes a factory that creates objects for a IGraphicsDevice.

Template Parameters

DescriptorLayoutType	Type of the descriptor layout. (inherits from IDescriptorSetLayout)
RawBufferType	Type of the raw buffer. (inherits from IBuffer)
VertexBufferType	Type of the vertex buffer. (inherits from IVertexBuffer)
IndexBufferType	Type of the index buffer. (inherits from IIndexBuffer)
ImageType	Type of the image. (inherits from IImage)
SamplerType	Type of the sampler. (inherits from ISampler)

Member Function Documentation

◆ createAttachment() [1/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< image_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createAttachment	(	const std::string &	name,
		Format	format,
		const math::Vector2< unsigned > &	size,
		MultiSamplingLevel	samples = MultiSamplingLevel::X1 ) const

nodiscardpure virtual

Creates an Image used as a render target attachment.

Parameters

format	The image format.
size	The extent of the image.
samples	The number of samples the image should be sampled with.

Returns: The created IImage.

Implemented in spark::render::vk::VulkanFactory.

◆ createAttachment() [2/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< image_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createAttachment	(	Format	format,
		const math::Vector2< unsigned > &	size,
		MultiSamplingLevel	samples = MultiSamplingLevel::X1 ) const

nodiscardpure virtual

Creates an Image used as a render target attachment.

Parameters

format	The image format.
size	The extent of the image.
samples	The number of samples the image should be sampled with.

Returns: The created IImage.

Implemented in spark::render::vk::VulkanFactory.

◆ createBuffer() [1/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< buffer_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createBuffer	(	BufferType	type,
		BufferUsage	usage,
		std::size_t	element_size,
		unsigned	elements,
		bool	allow_write = false ) const

nodiscardpure virtual

Creates a IBuffer of type type.

Parameters

type	The type of buffer to create.
usage	The buffer usage.
element_size	The size of each element in the buffer. (in bytes)
elements	The number of elements in the buffer. (if the buffer is an array).
allow_write	`true` to allow the resource to be bound to a read/write descriptor.

Returns: The created IBuffer.

Implemented in spark::render::vk::VulkanFactory.

◆ createBuffer() [2/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< buffer_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createBuffer	(	const std::string &	name,
		BufferType	type,
		BufferUsage	usage,
		std::size_t	element_size,
		unsigned	elements,
		bool	allow_write = false ) const

nodiscardpure virtual

Creates a IBuffer of type type.

Parameters

type	The type of buffer to create.
usage	The buffer usage.
element_size	The size of each element in the buffer. (in bytes)
elements	The number of elements in the buffer. (if the buffer is an array).
allow_write	`true` to allow the resource to be bound to a read/write descriptor.

Returns: The created IBuffer.

Implemented in spark::render::vk::VulkanFactory.

◆ createIndexBuffer() [1/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< index_buffer_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createIndexBuffer	(	const index_buffer_layout_type &	layout,
		BufferUsage	usage,
		unsigned	elements ) const

nodiscardpure virtual

Creates a IVertexBuffer based on layout.

Parameters

layout	The vertex buffer layout.
usage	The buffer usage.
elements	The number of elements in the buffer. (if the buffer is an array).

Returns: The created IVertexBuffer.

A vertex buffer can be used by different render pipelines as long as they share a common input assembler state. The size of the buffer is computed from the element size vertex buffer layout, times the number of elements given by the elements parameter.

◆ createIndexBuffer() [2/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< index_buffer_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createIndexBuffer	(	const std::string &	name,
		const index_buffer_layout_type &	layout,
		BufferUsage	usage,
		unsigned	elements ) const

nodiscardpure virtual

Creates a IVertexBuffer based on layout.

Parameters

layout	The vertex buffer layout.
usage	The buffer usage.
elements	The number of elements in the buffer. (if the buffer is an array).

Returns: The created IVertexBuffer.

An index buffer can be used by different render pipelines as long as they share a common input assembler state. The size of the buffer is computed from the element size index buffer layout, times the number of elements given by the elements parameter.

◆ createSampler() [1/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< sampler_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createSampler	(	const std::string &	name,
		FilterMode	mag_filter = FilterMode::Nearest,
		FilterMode	min_filter = FilterMode::Nearest,
		BorderMode	border_u = BorderMode::Repeat,
		BorderMode	border_v = BorderMode::Repeat,
		BorderMode	border_w = BorderMode::Repeat,
		MipMapMode	mip_map_mode = MipMapMode::Nearest,
		float	mip_map_bias = 0.f,
		float	max_lod = std::numeric_limits< float >::max(),
		float	min_lod = 0.f,
		float	anisotropy = 0.f ) const

nodiscardpure virtual

Creates a texture sampler .

Parameters

mag_filter	The filter mode to use for magnification.
min_filter	The filter mode to use for minification.
border_u	The border mode to use along the u-axis.
border_v	The border mode to use along the v-axis.
border_w	The border mode to use along the w-axis.
mip_map_mode	The mip map mode to use.
mip_map_bias	The mip map bias to use.
max_lod	The maximum level of detail to use.
min_lod	The minimum level of detail to use.
anisotropy	The anisotropy level to use.

Returns: The created ISampler.

Implemented in spark::render::vk::VulkanFactory.

◆ createSampler() [2/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< sampler_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createSampler	(	FilterMode	mag_filter = FilterMode::Nearest,
		FilterMode	min_filter = FilterMode::Nearest,
		BorderMode	border_u = BorderMode::Repeat,
		BorderMode	border_v = BorderMode::Repeat,
		BorderMode	border_w = BorderMode::Repeat,
		MipMapMode	mip_map_mode = MipMapMode::Nearest,
		float	mip_map_bias = 0.f,
		float	max_lod = std::numeric_limits< float >::max(),
		float	min_lod = 0.f,
		float	anisotropy = 0.f ) const

nodiscardpure virtual

Creates a texture sampler .

Parameters

mag_filter	The filter mode to use for magnification.
min_filter	The filter mode to use for minification.
border_u	The border mode to use along the u-axis.
border_v	The border mode to use along the v-axis.
border_w	The border mode to use along the w-axis.
mip_map_mode	The mip map mode to use.
mip_map_bias	The mip map bias to use.
max_lod	The maximum level of detail to use.
min_lod	The minimum level of detail to use.
anisotropy	The anisotropy level to use.

Returns: The created ISampler.

Implemented in spark::render::vk::VulkanFactory.

◆ createSamplers()

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::vector< std::unique_ptr< sampler_type > > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createSamplers	(	std::size_t	elements,
		FilterMode	mag_filter = FilterMode::Nearest,
		FilterMode	min_filter = FilterMode::Nearest,
		BorderMode	border_u = BorderMode::Repeat,
		BorderMode	border_v = BorderMode::Repeat,
		BorderMode	border_w = BorderMode::Repeat,
		MipMapMode	mip_map_mode = MipMapMode::Nearest,
		float	mip_map_bias = 0.f,
		float	max_lod = std::numeric_limits< float >::max(),
		float	min_lod = 0.f,
		float	anisotropy = 0.f ) const

nodiscardpure virtual

Creates an array of texture samplers .

Parameters

elements	The number of samplers to create.
mag_filter	The filter mode to use for magnification of each sampler.
min_filter	The filter mode to use for minification of each sampler.
border_u	The border mode to use along the u-axis of each sampler.
border_v	The border mode to use along the v-axis of each sampler.
border_w	The border mode to use along the w-axis of each sampler.
mip_map_mode	The mip map mode to use of each sampler.
mip_map_bias	The mip map bias to use of each sampler.
max_lod	The maximum level of detail to use of each sampler.
min_lod	The minimum level of detail to use of each sampler.
anisotropy	The anisotropy level to use of each sampler.

Returns: The created std::vector of samplers.

Implemented in spark::render::vk::VulkanFactory.

◆ createTexture() [1/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< image_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createTexture	(	const std::string &	name,
		Format	format,
		const math::Vector3< unsigned > &	size,
		ImageDimensions	dimension = ImageDimensions::DIM_2,
		unsigned	levels = 1,
		unsigned	layers = 1,
		MultiSamplingLevel	samples = MultiSamplingLevel::X1,
		bool	allow_write = false ) const

nodiscardpure virtual

Creates a texture .

Parameters

format	The image format.
size	The extent of the image.
dimension	The image dimension.
levels	The number of mipmap levels.
layers	The number of layers.
samples	The number of samples the image should be sampled with.
allow_write	`true` to allow the resource to be bound to a read/write descriptor.

Returns: The created IImage.

A texture is always backed by GPU-only visible memory and thus can only be transferred to/from. Thus you typically have to create a buffer using IGraphicsFactory::createBuffer() first that holds the actual image bytes. You than can transfer/copy the contents into the texture.

Implemented in spark::render::vk::VulkanFactory.

◆ createTexture() [2/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< image_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createTexture	(	Format	format,
		const math::Vector3< unsigned > &	size,
		ImageDimensions	dimension = ImageDimensions::DIM_2,
		unsigned	levels = 1,
		unsigned	layers = 1,
		MultiSamplingLevel	samples = MultiSamplingLevel::X1,
		bool	allow_write = false ) const

nodiscardpure virtual

Creates a texture .

Parameters

format	The image format.
size	The extent of the image.
dimension	The image dimension.
levels	The number of mipmap levels.
layers	The number of layers.
samples	The number of samples the image should be sampled with.
allow_write	`true` to allow the resource to be bound to a read/write descriptor.

Returns: The created IImage.

A texture is always backed by GPU-only visible memory and thus can only be transferred to/from. Thus you typically have to create a buffer using IGraphicsFactory::createBuffer() first that holds the actual image bytes. You than can transfer/copy the contents into the texture.

Implemented in spark::render::vk::VulkanFactory.

◆ createTextures()

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::vector< std::unique_ptr< image_type > > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createTextures	(	std::size_t	elements,
		Format	format,
		const math::Vector3< unsigned > &	size,
		ImageDimensions	dimension = ImageDimensions::DIM_2,
		unsigned	layers = 1,
		unsigned	levels = 1,
		MultiSamplingLevel	samples = MultiSamplingLevel::X1,
		bool	allow_write = false ) const

nodiscardpure virtual

Creates an array of textures .

Parameters

elements	The number of textures to create.
format	The images format.
size	The extent of each image.
dimension	The dimension of each image.
layers	The number of layers of each image.
levels	The number of mipmap levels of each image.
samples	The number of samples of each image.
allow_write	`true` to allow the resource to be bound to a read/write descriptor.

Returns: The created std::vector of textures.

Implemented in spark::render::vk::VulkanFactory.

◆ createVertexBuffer() [1/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< vertex_buffer_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createVertexBuffer	(	const std::string &	name,
		const vertex_buffer_layout_type &	layout,
		BufferUsage	usage,
		unsigned	elements = 1 ) const

nodiscardpure virtual

Creates a IVertexBuffer based on layout.

Parameters

layout	The vertex buffer layout.
usage	The buffer usage.
elements	The number of elements in the buffer. (if the buffer is an array).

Returns: The created IVertexBuffer.

A vertex buffer can be used by different render pipelines as long as they share a common input assembler state. The size of the buffer is computed from the element size vertex buffer layout, times the number of elements given by the elements parameter.

◆ createVertexBuffer() [2/2]

template<typename DescriptorLayoutType , typename RawBufferType , typename VertexBufferType , typename IndexBufferType , typename ImageType , typename SamplerType >

virtual std::unique_ptr< vertex_buffer_type > spark::render::GraphicsFactory< DescriptorLayoutType, RawBufferType, VertexBufferType, IndexBufferType, ImageType, SamplerType >::createVertexBuffer	(	const vertex_buffer_layout_type &	layout,
		BufferUsage	usage,
		unsigned	elements = 1 ) const

nodiscardpure virtual

Creates a IVertexBuffer based on layout.

Parameters

layout	The vertex buffer layout.
usage	The buffer usage.
elements	The number of elements in the buffer. (if the buffer is an array).

Returns: The created IVertexBuffer.

A vertex buffer can be used by different render pipelines as long as they share a common input assembler state. The size of the buffer is computed from the element size vertex buffer layout, times the number of elements given by the elements parameter.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ createAttachment() [1/2]

◆ createAttachment() [2/2]

◆ createBuffer() [1/2]

◆ createBuffer() [2/2]

◆ createIndexBuffer() [1/2]

◆ createIndexBuffer() [2/2]

◆ createSampler() [1/2]

◆ createSampler() [2/2]

◆ createSamplers()

◆ createTexture() [1/2]

◆ createTexture() [2/2]

◆ createTextures()

◆ createVertexBuffer() [1/2]

◆ createVertexBuffer() [2/2]