reshade::api::swapchain_desc Struct Reference

Describes a swap chain and its back buffer resources. More...

#include <reshade_api_device.hpp>

Inheritance diagram for reshade::api::swapchain_desc:

Public Attributes
uint32_t	buffer_count
	Number of back buffer resources in the swap chain. More...
uint32_t	present_mode
	Defines how the back buffers should be swapped when a present occurs. More...
uint32_t	present_flags
	Swap chain creation flags. More...
Public Attributes inherited from reshade::api::resource_desc
resource_type	type
	Type of the resource. More...
union {
struct {
uint64_t   size
	Size of the buffer (in bytes). More...
uint32_t   stride
	Structure stride for structured buffers (in bytes), otherwise zero. More...
}   buffer
	Used when resource type is a buffer. More...
struct {
uint32_t   width
	Width of the texture (in texels). More...
uint32_t   height
	If this is a 2D or 3D texture, height of the texture (in texels), otherwise 1. More...
uint16_t   depth_or_layers
	If this is a 3D texture, depth of the texture (in texels), otherwise number of array layers. More...
uint16_t   levels
	Maximum number of mipmap levels in the texture, including the base level, so at least 1. Can also be zero in case the exact number of mipmap levels is unknown. More...
format   format
	Data format of each texel in the texture. More...
uint16_t   samples
	The number of samples per texel. Set to a value higher than 1 for multisampling. More...
}   texture
	Used when resource type is a texture or surface. More...
};
memory_heap	heap
	Memory heap the resource allocation is placed in. More...
resource_usage	usage
	Flags that specify how this resource may be used. More...
resource_flags	flags
	Flags that describe additional parameters. More...

Additional Inherited Members
Public Member Functions inherited from reshade::api::resource_desc
constexpr	resource_desc ()
constexpr	resource_desc (uint64_t size, memory_heap heap, resource_usage usage)
constexpr	resource_desc (uint32_t width, uint32_t height, uint16_t layers, uint16_t levels, format format, uint16_t samples, memory_heap heap, resource_usage usage, resource_flags flags=resource_flags::none)
constexpr	resource_desc (resource_type type, uint32_t width, uint32_t height, uint16_t depth_or_layers, uint16_t levels, format format, uint16_t samples, memory_heap heap, resource_usage usage, resource_flags flags=resource_flags::none)

Detailed Description

Describes a swap chain and its back buffer resources.

Member Data Documentation

buffer_count

uint32_t reshade::api::swapchain_desc::buffer_count

Number of back buffer resources in the swap chain.

present_flags

uint32_t reshade::api::swapchain_desc::present_flags

Swap chain creation flags.

present_mode

uint32_t reshade::api::swapchain_desc::present_mode

Defines how the back buffers should be swapped when a present occurs.

---

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

• include/reshade_api_device.hpp