#include <hps.h>
The HPS::OffScreenWindowOptionsKit class is a user space object. It is used to specify off-screen-window-specific options. Calling HPS::OffScreenWindowOptionsKit::GetDefault() will return an options kit with values found in this table.
HPS::OffScreenWindowOptionsKit::OffScreenWindowOptionsKit |
( |
| ) |
|
bool HPS::OffScreenWindowOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
Creates an OffScreenWindowOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- An OffScreenWindowOptionsKit with the default settings.
HPS::Type HPS::OffScreenWindowOptionsKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::SetAntiAliasCapable |
( |
bool |
in_state, |
|
|
unsigned int |
in_samples = 4 |
|
) |
| |
Sets the anti-alias options for this OffScreenWindowOptionsKit.
- Parameters
-
in_state | Whether the associated application window should be anti-alias capable. |
in_samples | The number of anti-alias samples to use for the associated application window. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
Sets whether the image data for this offscreen window should be stored exclusively in video memory. Storing the image in video memory improves the update time but may make the image data inaccessible directly.
- Parameters
-
in_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
Sets the native image format to store data in.
- Parameters
-
in_format | Format image data will be stored in. |
in_quality | The compression quality for the image data (when applicable). |
- Returns
- A reference to this OffScreenWindowOptionsKit.
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.
- Parameters
-
in_state | Whether this offscreen window should support opacity in the window background. |
in_opacity | The opacity value that will be applied when rendering the window background. The value is clamped if the opacity is outside the range 0 to 1. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
Enables support for opacity in the window background and applies the specified opacity value when rendering the window background.
- Parameters
-
in_opacity | The opacity value that will be applied when rendering the window background. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
bool HPS::OffScreenWindowOptionsKit::ShowAntiAliasCapable |
( |
bool & |
out_state, |
|
|
unsigned int & |
out_samples |
|
) |
| const |
Shows the anti-alias options for this OffScreenWindowOptionsKit.
- Parameters
-
out_state | Whether the associated application window should be anti-alias capable. |
out_samples | The number of anti-alias samples to use for the associated application window. |
- Returns
- true if anti-alias options were set, false otherwise.
bool HPS::OffScreenWindowOptionsKit::ShowDriver |
( |
Window::Driver & |
out_driver | ) |
const |
bool HPS::OffScreenWindowOptionsKit::ShowHardwareResident |
( |
bool & |
out_state | ) |
const |
Shows the hardware resident option for this OffScreenWindowOptionsKit.
- Parameters
-
out_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
- Returns
- true if a hardware resident option was set, false otherwise.
bool HPS::OffScreenWindowOptionsKit::ShowNativeFormat |
( |
Window::ImageFormat & |
out_format, |
|
|
float & |
out_quality |
|
) |
| const |
Shows the native format option for this OffScreenWindowOptionsKit.
- Parameters
-
out_format | Format image data will be stored in. |
out_quality | The compression quality for the image data (when applicable). |
- Returns
- true if a native format option was set, false otherwise.
bool HPS::OffScreenWindowOptionsKit::ShowOpacity |
( |
bool & |
out_state, |
|
|
float & |
out_opacity |
|
) |
| const |
Shows the opacity option for this offscreen window
- Parameters
-
out_state | Whether this offscreen window supports opacity in the window background. |
out_state | The opacity value that will be applied when rendering the window background. |
- Returns
- true if an opacity option was set, false otherwise.
The documentation for this class was generated from the following file: