#include <hps.h>
The HPS::ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query and manipulate options pertaining to an HPS::ApplicationWindowKey. Default values for the various fields of HPS::ApplicationWindowOptionsControl can be found here.
HPS::ApplicationWindowOptionsControl::ApplicationWindowOptionsControl |
( |
ApplicationWindowKey & |
in_seg | ) |
|
|
explicit |
HPS::ApplicationWindowOptionsControl::~ApplicationWindowOptionsControl |
( |
| ) |
|
Releases a reference to the database object this control is tied to.
HPS::Type HPS::ApplicationWindowOptionsControl::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 the platform specific data for the associated application window.
- Parameters
-
in_platform_data | Platform specific data for the associated application window. |
- Returns
- A reference to this ApplicationWindowOptionsControl.
Sets the window handle for the associated application window. Used to rebind the application window to a new window handle.
- Parameters
-
in_window_handle | Handle to the new WindowHandle that Visualize will draw into. |
- Returns
- A reference to this ApplicationWindowOptionsControl.
bool HPS::ApplicationWindowOptionsControl::ShowAntiAliasCapable |
( |
bool & |
out_state, |
|
|
unsigned int & |
out_samples |
|
) |
| const |
Shows the whether this application window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.
- Parameters
-
out_state | Whether this application window is anti-alias capable. |
out_samples | The number of anti-alias samples supported by this application window. |
- Returns
- true if any anti-alias options were set, false otherwise.
bool HPS::ApplicationWindowOptionsControl::ShowDriver |
( |
Window::Driver & |
out_driver | ) |
const |
Shows the driver for the associated application window.
- Parameters
-
out_driver | The driver for the associated application window. |
- Returns
- true if a driver was set, false otherwise.
bool HPS::ApplicationWindowOptionsControl::ShowFramebufferRetention |
( |
bool & |
out_retain | ) |
const |
Shows the framebuffer retention setting for the associated application window.
- Parameters
-
out_retain | The framebuffer retention setting for the associated application window. |
- Returns
- true if framebuffer retention option was set, false otherwise.
bool HPS::ApplicationWindowOptionsControl::ShowPlatformData |
( |
PlatformData & |
out_platform_data | ) |
const |
Shows the platform specific data for the associated application window.
- Parameters
-
out_platform_data | The platform specific data for the associated application window. |
- Returns
- true if platform specific data was set, false otherwise.
bool HPS::ApplicationWindowOptionsControl::ShowWindowHandle |
( |
WindowHandle & |
out_window_handle | ) |
const |
Shows the window handle for the associated application window.
- Parameters
-
out_window_handle | The window handle for the associated application window. |
- Returns
- true if a window handle was set, false otherwise.
The documentation for this class was generated from the following file:
- C:/git/visualize/hps/include/hps.h