From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_video_settings.html | 746 +++++++++++++++++++++++++++++ 1 file changed, 746 insertions(+) create mode 100644 Doc/doxygen/html/class_video_settings.html (limited to 'Doc/doxygen/html/class_video_settings.html') diff --git a/Doc/doxygen/html/class_video_settings.html b/Doc/doxygen/html/class_video_settings.html new file mode 100644 index 0000000..4b0b925 --- /dev/null +++ b/Doc/doxygen/html/class_video_settings.html @@ -0,0 +1,746 @@ + + + + + +Starshatter_Open: VideoSettings Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Public Attributes
+
+
VideoSettings Class Reference
+
+
+ +

#include <VideoSettings.h>

+ +

List of all members.

+ + + +

+Public Types

enum  VertexProcessing { VTX_SOFTWARE, +VTX_MIXED, +VTX_HARDWARE, +VTX_PURE + }
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 VideoSettings ()
 ~VideoSettings ()
bool IsWindowed () const
bool UseEffects () const
int GetWidth () const
int GetHeight () const
int GetDepth () const
int GetPixSize () const
int GetRefreshRate () const
const char * GetModeDescription () const
int GetVertexProcessing () const
int GetDepthBufferBits () const
int GetAdapterIndex () const
int GetDeviceIndex () const
DWORD GetDeviceType () const
DWORD GetDepthStencilFormat () const
DWORD GetBackBufferFormat () const
const char * GetAdapterDesc () const
const char * GetDeviceDesc () const
+ + + + + + + + + + + + + + + + +

+Public Attributes

bool is_windowed
bool use_effects
VideoMode fullscreen_mode
VideoMode windowed_mode
int window_width
int window_height
VideoDeviceInfo fullscreen_device
VideoDeviceInfo windowed_device
bool shadows
bool bumpmaps
bool specmaps
int max_detail
DWORD enable_vs
DWORD enable_ps
float depth_bias
+

Detailed Description

+
+

Definition at line 73 of file VideoSettings.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum VideoSettings::VertexProcessing
+
+
Enumerator:
+ + + + +
VTX_SOFTWARE  +
VTX_MIXED  +
VTX_HARDWARE  +
VTX_PURE  +
+
+
+ +

Definition at line 76 of file VideoSettings.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
VideoSettings::VideoSettings ()
+
+ +

Definition at line 20 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
VideoSettings::~VideoSettings ()
+
+ +

Definition at line 46 of file VideoSettings.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
const char * VideoSettings::GetAdapterDesc () const
+
+ +

Definition at line 213 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetAdapterIndex () const
+
+ +

Definition at line 168 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
DWORD VideoSettings::GetBackBufferFormat () const
+
+ +

Definition at line 204 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetDepth () const
+
+ +

Definition at line 82 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetDepthBufferBits () const
+
+ +

Definition at line 159 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
DWORD VideoSettings::GetDepthStencilFormat () const
+
+ +

Definition at line 195 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
const char * VideoSettings::GetDeviceDesc () const
+
+ +

Definition at line 222 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetDeviceIndex () const
+
+ +

Definition at line 177 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
DWORD VideoSettings::GetDeviceType () const
+
+ +

Definition at line 186 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetHeight () const
+
+ +

Definition at line 73 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
const char * VideoSettings::GetModeDescription () const
+
+ +

Definition at line 139 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetPixSize () const
+
+ +

Definition at line 105 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetRefreshRate () const
+
+ +

Definition at line 128 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetVertexProcessing () const
+
+ +

Definition at line 150 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
int VideoSettings::GetWidth () const
+
+ +

Definition at line 64 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
bool VideoSettings::IsWindowed () const
+
+ +

Definition at line 52 of file VideoSettings.cpp.

+ +
+
+ +
+
+ + + + + + + +
bool VideoSettings::UseEffects () const
+
+ +

Definition at line 58 of file VideoSettings.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
bool VideoSettings::bumpmaps
+
+ +

Definition at line 122 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
float VideoSettings::depth_bias
+
+ +

Definition at line 127 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
DWORD VideoSettings::enable_ps
+
+ +

Definition at line 126 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
DWORD VideoSettings::enable_vs
+
+ +

Definition at line 125 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
VideoDeviceInfo VideoSettings::fullscreen_device
+
+ +

Definition at line 116 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
VideoMode VideoSettings::fullscreen_mode
+
+ +

Definition at line 112 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
bool VideoSettings::is_windowed
+
+ +

Definition at line 110 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
int VideoSettings::max_detail
+
+ +

Definition at line 124 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
bool VideoSettings::shadows
+
+ +

Definition at line 121 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
bool VideoSettings::specmaps
+
+ +

Definition at line 123 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
bool VideoSettings::use_effects
+
+ +

Definition at line 111 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
int VideoSettings::window_height
+
+ +

Definition at line 115 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
int VideoSettings::window_width
+
+ +

Definition at line 114 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
VideoDeviceInfo VideoSettings::windowed_device
+
+ +

Definition at line 117 of file VideoSettings.h.

+ +
+
+ +
+
+ + + + +
VideoMode VideoSettings::windowed_mode
+
+ +

Definition at line 113 of file VideoSettings.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1