#include <hps.h>
The HPS::StandAloneWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to set and query stand-alone-window-specific options on a HPS::StandAloneWindowKey.
Default values for the various fields of HPS::StandAloneWindowOptionsControl can be found here.
HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl |
( |
StandAloneWindowKey & |
in_seg | ) |
|
|
explicit |
HPS::StandAloneWindowOptionsControl::~StandAloneWindowOptionsControl |
( |
| ) |
|
Releases a reference to the database object this control is tied to.
HPS::Type HPS::StandAloneWindowOptionsControl::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::Control.
Sets whether this stand-alone window should fill the screen.
- Parameters
-
in_state | Whether this stand-alone window should fill the screen. |
- Returns
- A reference to this StandAloneWindowOptionsControl.
Sets the mobility for this stand-alone window. Mobility refers to the resizing and positioning behaviors of a window.
- Parameters
-
in_mobility | The mobility for this stand-alone window. |
- Returns
- A reference to this StandAloneWindowOptionsControl.
Sets the subscreen to render into for this stand-alone window.
- Parameters
-
in_subscreen | The subscreen to render into for this stand-alone window. The units of the Rectangle are in window space, so -1.0f corresponds to the left (or bottom) of the window and 1.0f corresponds to the right (or top) of the window. |
- Returns
- A reference to this StandAloneWindowOptionsControl.
bool HPS::StandAloneWindowOptionsControl::ShowAntiAliasCapable |
( |
bool & |
out_state, |
|
|
unsigned int & |
out_samples |
|
) |
| const |
Shows the whether this stand-alone window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.
- Parameters
-
out_state | Whether this stand-alone window is anti-alias capable. |
out_samples | The number of anti-alias samples supported by this stand-alone window. |
- Returns
- true if any anti-alias options were set, false otherwise.
bool HPS::StandAloneWindowOptionsControl::ShowDriver |
( |
Window::Driver & |
out_driver | ) |
const |
Shows the driver for this stand-alone window.
- Parameters
-
out_driver | The driver for this stand-alone window. |
- Returns
- true if a driver was set, false otherwise.
bool HPS::StandAloneWindowOptionsControl::ShowFullScreen |
( |
bool & |
out_state | ) |
const |
Shows whether this stand-alone window should fill the screen.
- Parameters
-
out_state | Whether this stand-alone window should fill the screen. |
- Returns
- true if a full screen flag was set, false otherwise.
bool HPS::StandAloneWindowOptionsControl::ShowMobility |
( |
Window::Mobility & |
out_mobility | ) |
const |
Shows the mobility for this stand-alone window.
- Parameters
-
out_mobility | The mobility for this stand-alone window. |
- Returns
- true if a mobility was set, false otherwise.
bool HPS::StandAloneWindowOptionsControl::ShowSubscreen |
( |
Rectangle & |
out_subscreen | ) |
const |
Shows the subscreen for this stand-alone window.
- Parameters
-
out_subscreen | The subscreen for this stand-alone window. |
- Returns
- true if a subscreen was set, false otherwise.
bool HPS::StandAloneWindowOptionsControl::ShowTitle |
( |
UTF8 & |
out_window_name | ) |
const |
Shows the title for this stand-alone window.
- Parameters
-
out_window_name | UTF8-encoded title for this stand-alone window. |
- Returns
- true if a title was set, false otherwise.
The documentation for this class was generated from the following file: