RenderAPI

Description

Interface for interacting with the render API (DirectX, OpenGL, etc.).

Classes

class  BlendState
 Core thread version of bs::BlendState. More...
 
class  CommandBufferManager
 Handles creation of command buffers. More...
 
class  DepthStencilState
 Core thread version of bs::DepthStencilState. More...
 
class  EventQuery
 Represents a GPU query that gets triggered when GPU starts processing the query. More...
 
class  GpuBuffer
 Core thread version of a bs::GpuBuffer. More...
 
class  GpuParamBlockBuffer
 Core thread version of a bs::GpuParamBlockBuffer. More...
 
class  GpuParams
 Core thread version of bs::GpuParams. More...
 
struct  GPU_PIPELINE_PARAMS_DESC
 Helper structure used for initializing GpuPipelineParamInfo. More...
 
struct  GpuPipelineParamInfoBase::SetInfo
 Information about a single set in the param info object. More...
 
struct  GpuPipelineParamInfoBase::ResourceInfo
 Information how a resource maps to a certain set/slot. More...
 
class  GpuPipelineParamInfoBase
 Contains code common to both sim and core thread implementations of GpuPipelineParamInfo. More...
 
class  GpuPipelineParamInfo
 Holds meta-data about a set of GPU parameters used by a single pipeline state. More...
 
class  GpuPipelineParamInfo
 Core thread version of a bs::GpuPipelineParamInfo. More...
 
struct  PIPELINE_STATE_DESC
 Descriptor structure used for initializing a GPU pipeline state. More...
 
class  GraphicsPipelineState
 Core thread version of a bs::GraphicsPipelineState. More...
 
class  ComputePipelineState
 Core thread version of a bs::ComputePipelineState. More...
 
class  GpuProgram
 Core thread version of a bs::GpuProgram. More...
 
class  GpuProgramManager
 Manager responsible for creating GPU programs. More...
 
class  GpuProgramFactory
 Factory responsible for creating GPU programs of a certain type. More...
 
class  GpuProgramManager
 Manager responsible for creating GPU programs. More...
 
class  HardwareBuffer
 Abstract class defining common features of hardware buffers. More...
 
class  HardwareBufferManager::VertexDeclarationKey::HashFunction
 
class  HardwareBufferManager::VertexDeclarationKey::EqualFunction
 
struct  HardwareBufferManager::VertexDeclarationKey
 Key for use in the vertex declaration map. More...
 
class  HardwareBufferManager
 Handles creation of various hardware buffers. More...
 
class  HardwareBufferManager
 Handles creation of various hardware buffers. More...
 
class  IndexBuffer
 Core thread specific implementation of an bs::IndexBuffer. More...
 
class  MeshManager
 Manager that handles creation of Meshes. More...
 
class  QueryManager
 Handles creation and destruction of GPU queries. More...
 
class  RasterizerState
 Core thread version of bs::RasterizerState. More...
 
class  RenderAPI
 Provides low-level API access to rendering commands (internally wrapping DirectX/OpenGL/Vulkan or similar). More...
 
struct  DriverVersion
 Holds data about render system driver version. More...
 
class  RenderAPICapabilities
 Holds information about render hardware and driver capabilities and allows you to easily set and query those capabilities. More...
 
class  RenderAPIFactory
 Factory class that you may specialize in order to start up a specific render system. More...
 
class  RenderAPIManager
 Manager that handles render system start up. More...
 
class  RenderStateManager
 Handles creation of various render states. More...
 
class  RenderStateManager
 Handles creation of various render states. More...
 
class  RenderTarget
 Provides access to internal render target implementation usable only from the core thread. More...
 
struct  RENDER_TEXTURE_DESC
 
class  RenderTexture
 Provides access to internal render texture implementation usable only from the core thread. More...
 
class  RenderWindow
 Core thread counterpart of bs::RenderWindow. More...
 
class  RenderWindowManager
 Handles creation and internal updates relating to render windows. More...
 
class  RenderWindowManager
 Handles creation and internal updates relating to render windows. More...
 
class  SamplerState
 Core thread version of bs::SamplerState. More...
 
struct  TEXTURE_VIEW_DESC
 Data describing a texture view. More...
 
class  TextureView::HashFunction
 
class  TextureView::EqualFunction
 
class  TextureView
 Texture views allow you to reference only a party of a texture. More...
 
class  TimerQuery
 Represents a GPU query that measures execution time of GPU operations. More...
 
class  VertexBuffer
 Core thread specific implementation of a bs::VertexBuffer. More...
 
class  VertexDeclaration
 Core thread portion of a bs::VertexDeclaration. More...
 
class  Viewport
 Viewport provides you with a way to render to only a part of a RenderTarget. More...
 

Enumerations

enum  CapabilitiesCategory : UINT64 {
  CAPS_CATEGORY_COMMON = 0, CAPS_CATEGORY_GL = 1, CAPS_CATEGORY_D3D11 = 2, CAPS_CATEGORY_VULKAN = 3,
  CAPS_CATEGORY_COUNT = 32
}
 Categories of render API capabilities. More...
 
enum  Capabilities : UINT64 {
  RSC_TEXTURE_COMPRESSION_BC = BS_CAPS_VALUE(CAPS_CATEGORY_COMMON, 0), RSC_TEXTURE_COMPRESSION_ETC2 = BS_CAPS_VALUE(CAPS_CATEGORY_COMMON, 1), RSC_TEXTURE_COMPRESSION_ASTC = BS_CAPS_VALUE(CAPS_CATEGORY_COMMON, 2), RSC_GEOMETRY_PROGRAM = BS_CAPS_VALUE(CAPS_CATEGORY_COMMON, 3),
  RSC_TESSELLATION_PROGRAM = BS_CAPS_VALUE(CAPS_CATEGORY_COMMON, 4), RSC_COMPUTE_PROGRAM = BS_CAPS_VALUE(CAPS_CATEGORY_COMMON, 5)
}
 Enum describing the different hardware capabilities we can check for. More...
 
enum  GPUVendor {
  GPU_UNKNOWN = 0, GPU_NVIDIA = 1, GPU_AMD = 2, GPU_INTEL = 3,
  GPU_VENDOR_COUNT = 4
}
 Types of GPU vendors. More...
 

Enumeration Type Documentation

enum Capabilities : UINT64

Enum describing the different hardware capabilities we can check for.

Enumerator
RSC_TEXTURE_COMPRESSION_BC 

Supports compressed textures in the BC formats.

RSC_TEXTURE_COMPRESSION_ETC2 

Supports compressed textures in the ETC2 and EAC format.

RSC_TEXTURE_COMPRESSION_ASTC 

Supports compressed textures in the ASTC format.

RSC_GEOMETRY_PROGRAM 

Supports hardware geometry programs.

RSC_TESSELLATION_PROGRAM 

Supports hardware tessellation programs.

RSC_COMPUTE_PROGRAM 

Supports hardware compute programs.

enum CapabilitiesCategory : UINT64

Categories of render API capabilities.

Enumerator
CAPS_CATEGORY_COUNT 

Maximum number of categories.

enum GPUVendor

Types of GPU vendors.