- Generated on Wed Mar 6 2024 18:04:58 for C3D Toolkit by
1.9.1
|
C3D Toolkit
Kernel - 117982, Vision - 2.9.2.2
|
RenderingAreaFormat class represents RenderingArea format. More...
#include <vsn_renderingareaformat.h>
Public Member Functions | |
| RenderingAreaFormat () | |
| Default constructor. | |
| RenderingAreaFormat (uint8 formatOptions) | |
| Constructor with set format. | |
| RenderingAreaFormat (const RenderingAreaFormat &other) | |
| Copy constructor. | |
| int | GetDepthBufferSize () const |
| Returns depth buffer size. | |
| void | SetDepthBufferSize (int size) |
| Sets the minimum depth buffer size. | |
| int | GetStencilBufferSize () const |
| Returns stencil buffer size in bits. | |
| void | SetStencilBufferSize (int size) |
| Sets stencil buffer size in bits. | |
| int | GetRedBufferSize () const |
| Returns the size of red color buffer in bits. | |
| void | SetRedBufferSize (int size) |
| Sets the size of red color buffer in bits. | |
| int | GetGreenBufferSize () const |
| Returns the size of green color buffer in bits. | |
| void | SetGreenBufferSize (int size) |
| Sets the size of green color buffer in bits. | |
| int | GetBlueBufferSize () const |
| Returns the size of blue color buffer in bits. | |
| void | SetBlueBufferSize (int size) |
| Sets the size of blue color buffer in bits. | |
| int | GetAlphaBufferSize () const |
| Returns the size of alpha channel of color buffer in bits. | |
| void | SetAlphaBufferSize (int size) |
| Sets the size of alpha channel of color buffer in bits. | |
| int | GetSamples () const |
| Returns pixel count for multisampling. Multisampling is disabled by default. | |
| void | SetSamples (int numSamples) |
| Sets the preferred pixel count for multisampling. More... | |
| SwapBehavior | GetSwapBehavior () const |
| Returns the swap behavior of the surface. | |
| void | SetSwapBehavior (SwapBehavior behavior) |
| Sets the swap behavior of the surface. | |
| int | GetSwapInterval () const |
| Returns the swap interval. | |
| void | SetSwapInterval (int interval) |
| Sets the swap interval. More... | |
| bool | IsAlpha () const |
| True if alpha buffer size is not 0. It means that surface can be used with transparent effects. | |
| RenderableType | GetRenderableType () const |
| Returns visualization type. | |
| void | SetRenderableType (RenderableType type) |
| Sets visualization type. | |
| OpenGLContextProfile | GetProfile () const |
| Returns OpenGL context profile configuration. /note The parameter is ignored if requested OpenGL version is under 3.2. | |
| void | SetProfile (OpenGLContextProfile profile) |
| Sets OpenGL context profile configuration. /note The parameter is ignored if requested OpenGL version is under 3.2. | |
| int | GetMajorVersion () const |
| Returns OpenGL major version. The default version is 2.0. | |
| void | SetMajorVersion (int majorVersion) |
| Sets OpenGL major version. The default version is 2.0. | |
| int | GetMinorVersion () const |
| Returns OpenGL minor version. | |
| void | SetMinorVersion (int minorVersion) |
| Sets OpenGL minor version. | |
| void | SetOptions (uint8 formatOptions) |
| Sets new format options. | |
| void | SetOption (FormatOption option, bool on=true) |
| Sets format option. If True, turns FormatOption on. | |
| bool | CheckOption (FormatOption option) const |
| True if format option is set. | |
| uint8 | GetOptions () const |
| Returns the current format options. | |
RenderingAreaFormat class represents RenderingArea format.
Format includes color buffer size: red, green and blue; alpha buffer size; size of depth and stencil buffers, and also pixel count for multisampling. Besides, format contains such surface configuration parameters as OpenGL settings and its version. Checks if stereo mode buffer is enabled.
| void VSN::RenderingAreaFormat::SetSamples | ( | int | numSamples | ) |
Sets the preferred pixel count for multisampling.
Checks if numSamples is not 0, that is multisampling enabled. Multisampling is disabled by default.
| [in] | numSamples | - Pixel count. |
| void VSN::RenderingAreaFormat::SetSwapInterval | ( | int | interval | ) |
Sets the swap interval.
Interval defines the minimum count of video frames. It can be used for OpenGL swap buffer synchronization for rendering in window, i.e. interval is related to vertical sync of the screen. The default interval value is 1.
| [in] | interval | - Interval. |
1.9.1