sculpto
Public Member Functions | Public Attributes | List of all members
scl::frame_buffer_props Struct Reference

#include <frame_buffer.h>

Public Member Functions

 frame_buffer_props ()=default
 
 frame_buffer_props (int Width, int Height, int Samples=1, bool IsSwapChainTarget=true, int ColorAttachmentsCount=1, int DepthAttachmentsCount=1, bool IsHDR=false)
 

Public Attributes

int Width { 16 }
 
int Height { 16 }
 
int Samples { 1 }
 
bool IsSwapChainTarget {}
 
bool IsHDR {}
 
int ColorAttachmentsCount { 1 }
 
int DepthAttachmentsCount { 1 }
 

Detailed Description

Frame buffer specification structure.

Definition at line 19 of file frame_buffer.h.

Constructor & Destructor Documentation

◆ frame_buffer_props() [1/2]

scl::frame_buffer_props::frame_buffer_props ( )
default

Frame buffer depth attachments count.

Note: at least one of attachments count must be > 0.

Frame buffer default constructor.

◆ frame_buffer_props() [2/2]

scl::frame_buffer_props::frame_buffer_props ( int  Width,
int  Height,
int  Samples = 1,
bool  IsSwapChainTarget = true,
int  ColorAttachmentsCount = 1,
int  DepthAttachmentsCount = 1,
bool  IsHDR = false 
)
inline
  • Frame buffer filling constructor.
Parameters
Width,Height- frame buffer texture size.
Samples- frame buffer samples count.
IsSwapChainTarget- frame buffer creating in purpose of rendering to screen.
ColorAttachmentsCount- frame buffer color attachments count.
DepthAttachmentsCount- frame buffer depth attachments count.

Definition at line 41 of file frame_buffer.h.

Member Data Documentation

◆ ColorAttachmentsCount

int scl::frame_buffer_props::ColorAttachmentsCount { 1 }

Flag, showing wheather frame buffer uses high dynamic range or default [0; 1] range.

Definition at line 25 of file frame_buffer.h.

◆ DepthAttachmentsCount

int scl::frame_buffer_props::DepthAttachmentsCount { 1 }

Frame buffer color attachments count.

Definition at line 26 of file frame_buffer.h.

◆ Height

int scl::frame_buffer_props::Height { 16 }

Definition at line 21 of file frame_buffer.h.

◆ IsHDR

bool scl::frame_buffer_props::IsHDR {}

Flag, showing wheather frame buffer creating in purpose of rendering to screen or not.

Definition at line 24 of file frame_buffer.h.

◆ IsSwapChainTarget

bool scl::frame_buffer_props::IsSwapChainTarget {}

Frame buffer samples count.

Definition at line 23 of file frame_buffer.h.

◆ Samples

int scl::frame_buffer_props::Samples { 1 }

Frame buffer texture size

Definition at line 22 of file frame_buffer.h.

◆ Width

int scl::frame_buffer_props::Width { 16 }

Definition at line 21 of file frame_buffer.h.


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