Saga3D API Documentation  1.0-RC4
SDeviceCreationParameters.h
Go to the documentation of this file.
1 #ifndef __SDEVICE_CREATION_PARAMETERS_H_INCLUDED__
2 #define __SDEVICE_CREATION_PARAMETERS_H_INCLUDED__
3 
4 #include "EDriverTypes.h"
5 #include "EDeviceTypes.h"
6 #include <glm/vec2.hpp>
7 
8 namespace saga
9 {
10  class IEventReceiver;
11 
13 
15  {
19  DriverType(video::E_DRIVER_TYPE::VULKAN),
20  WindowSize({800, 600}),
21  WindowPosition(glm::uvec2(-1,-1)),
22  Bits(32),
23  ZBufferBits(24),
24  Fullscreen(false),
25  Stencilbuffer(true),
26  Vsync(false),
27  AntiAlias(0),
28  HandleSRGB(false),
29  WithAlphaChannel(false),
30  Doublebuffer(true),
31  IgnoreInput(false),
32  Stereobuffer(false),
33  HighPrecisionFPU(false),
34  EventReceiver(0),
35  DisplayId(0),
36  WindowId(0),
37  DisplayAdapter(0),
38  DriverMultithreaded(false),
40  {
41  }
42 
44  { *this = other; }
45 
47  {
48  DeviceType = other.DeviceType;
49  DriverType = other.DriverType;
50  WindowSize = other.WindowSize;
52  Bits = other.Bits;
53  ZBufferBits = other.ZBufferBits;
54  Fullscreen = other.Fullscreen;
56  Vsync = other.Vsync;
57  AntiAlias = other.AntiAlias;
58  HandleSRGB = other.HandleSRGB;
60  Doublebuffer = other.Doublebuffer;
61  IgnoreInput = other.IgnoreInput;
62  Stereobuffer = other.Stereobuffer;
65  DisplayId = other.DisplayId;
66  WindowId = other.WindowId;
70  return *this;
71  }
72 
74 
85 
87 
91 
93  glm::uvec2 WindowSize;
94 
96  glm::uvec2 WindowPosition;
97 
99  std::uint8_t Bits;
100 
102  std::uint8_t ZBufferBits;
103 
105 
107 
109 
115 
117 
120  bool Vsync;
121 
123 
138  std::uint8_t AntiAlias;
139 
141 
154 
156 
165 
167 
173 
175 
180 
182 
188 
190 
197 
200 
202 
253  void* DisplayId;
254  void* WindowId;
255 
257 
258  std::uint32_t DisplayAdapter;
259 
261 
265 
267 
272 };
273 
274 
275 } // namespace saga
276 
277 #endif
278 
saga::SDeviceCreationParameters::WindowSize
glm::uvec2 WindowSize
Size of the window or the video mode in fullscreen mode. Default: 800x600.
Definition: SDeviceCreationParameters.h:93
saga::SDeviceCreationParameters::Vsync
bool Vsync
Specifies vertical synchronization.
Definition: SDeviceCreationParameters.h:120
saga::video::E_DRIVER_TYPE
E_DRIVER_TYPE
An enum class for all types of drivers Saga3D supports.
Definition: EDriverTypes.h:9
saga::SDeviceCreationParameters::operator=
SDeviceCreationParameters & operator=(const SDeviceCreationParameters &other)
Definition: SDeviceCreationParameters.h:46
saga::SDeviceCreationParameters::Stencilbuffer
bool Stencilbuffer
Specifies if the stencil buffer should be enabled.
Definition: SDeviceCreationParameters.h:114
saga::SDeviceCreationParameters::SDeviceCreationParameters
SDeviceCreationParameters(const SDeviceCreationParameters &other)
Definition: SDeviceCreationParameters.h:43
saga::SDeviceCreationParameters::EventReceiver
IEventReceiver * EventReceiver
A user created event receiver.
Definition: SDeviceCreationParameters.h:199
EDeviceTypes.h
saga::SDeviceCreationParameters::WindowPosition
glm::uvec2 WindowPosition
Position of the window on-screen. Default: (-1, -1) or centered.
Definition: SDeviceCreationParameters.h:96
saga::SDeviceCreationParameters::DisplayAdapter
std::uint32_t DisplayAdapter
Allows to select which graphic card is used for rendering when more than one card is in the system.
Definition: SDeviceCreationParameters.h:258
saga::SDeviceCreationParameters::DriverType
video::E_DRIVER_TYPE DriverType
Type of video driver used to render graphics.
Definition: SDeviceCreationParameters.h:90
saga::SDeviceCreationParameters::SDeviceCreationParameters
SDeviceCreationParameters()
Constructs a SDeviceCreationParameters structure with default values.
Definition: SDeviceCreationParameters.h:17
saga::SDeviceCreationParameters::DisplayId
void * DisplayId
Window Id.
Definition: SDeviceCreationParameters.h:253
saga::IEventReceiver
Interface of an object which can receive events (SDL_Event*)
Definition: IEventReceiver.h:17
saga::SDeviceCreationParameters::Fullscreen
bool Fullscreen
Should be set to true if the device should run in fullscreen.
Definition: SDeviceCreationParameters.h:106
saga::SDeviceCreationParameters::WindowId
void * WindowId
Definition: SDeviceCreationParameters.h:254
saga::E_DEVICE_TYPE
E_DEVICE_TYPE
An enum class for the different device types supported by the engine.
Definition: EDeviceTypes.h:8
saga::SDeviceCreationParameters::WithAlphaChannel
bool WithAlphaChannel
Whether the main framebuffer uses an alpha channel.
Definition: SDeviceCreationParameters.h:164
saga::SDeviceCreationParameters::DriverMultithreaded
bool DriverMultithreaded
Create the driver multithreaded.
Definition: SDeviceCreationParameters.h:264
saga::SDeviceCreationParameters::HandleSRGB
bool HandleSRGB
Flag to enable proper sRGB and linear color handling.
Definition: SDeviceCreationParameters.h:153
saga::SDeviceCreationParameters
Structure for holding device creation parameters.
Definition: SDeviceCreationParameters.h:14
saga::SDeviceCreationParameters::DeviceType
E_DEVICE_TYPE DeviceType
Type of the device.
Definition: SDeviceCreationParameters.h:84
saga::SDeviceCreationParameters::UsePerformanceTimer
bool UsePerformanceTimer
Enables use of high performance timers on Windows platform.
Definition: SDeviceCreationParameters.h:271
saga::SDeviceCreationParameters::Stereobuffer
bool Stereobuffer
Specifies if the device should use stereo buffers.
Definition: SDeviceCreationParameters.h:187
saga::E_DEVICE_TYPE::SDL
@ SDL
saga::SDeviceCreationParameters::Bits
std::uint8_t Bits
Minimum Bits per pixel of the color buffer in fullscreen mode. Ignored if windowed mode....
Definition: SDeviceCreationParameters.h:99
saga::SDeviceCreationParameters::HighPrecisionFPU
bool HighPrecisionFPU
Specifies if the device should use high precision FPU setting.
Definition: SDeviceCreationParameters.h:196
saga::SDeviceCreationParameters::AntiAlias
std::uint8_t AntiAlias
Specifies if the device should use fullscreen anti aliasing.
Definition: SDeviceCreationParameters.h:138
saga::SDeviceCreationParameters::Doublebuffer
bool Doublebuffer
Whether the main framebuffer uses doublebuffering.
Definition: SDeviceCreationParameters.h:172
saga::SDeviceCreationParameters::IgnoreInput
bool IgnoreInput
Specifies if the device should ignore input events.
Definition: SDeviceCreationParameters.h:179
saga
Definition: aabbox3d.h:11
saga::SDeviceCreationParameters::ZBufferBits
std::uint8_t ZBufferBits
Minimum Bits per pixel of the depth buffer. Default: 24.
Definition: SDeviceCreationParameters.h:102
EDriverTypes.h