REFERENCE MANUAL
#include <hps.h>
Static Public Member Functions | |
static StandAloneWindowOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The StandAloneWindowOptionsKit class is a user space object. It is used to specify stand-alone-window-specific options Calling StandAloneWindowOptionsKit::GetDefault() will return an options kit with values found in this table.
StandAloneWindowOptionsKit::StandAloneWindowOptionsKit | ( | ) |
The default constructor creates an empty StandAloneWindowOptionsKit object.
StandAloneWindowOptionsKit::StandAloneWindowOptionsKit | ( | StandAloneWindowOptionsKit const & | in_kit | ) |
The copy constructor creates a new StandAloneWindowOptionsKit object that contains the same settings as the source StandAloneWindowOptionsKit.
in_kit | The source StandAloneWindowOptionsKit to copy. |
StandAloneWindowOptionsKit::StandAloneWindowOptionsKit | ( | StandAloneWindowOptionsKit && | in_that | ) |
The move constructor creates a StandAloneWindowOptionsKit by transferring the underlying impl of the rvalue reference to this StandAloneWindowOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a StandAloneWindowOptionsKit to take the impl from. |
|
virtual |
Indicates whether this StandAloneWindowOptionsKit has any values set on it.
Reimplemented from Object.
bool StandAloneWindowOptionsKit::Equals | ( | StandAloneWindowOptionsKit const & | in_kit | ) | const |
Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.
in_kit | The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit. |
|
static |
Creates an StandAloneWindowOptionsKit 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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool StandAloneWindowOptionsKit::operator!= | ( | StandAloneWindowOptionsKit const & | in_kit | ) | const |
Check if the source StandAloneWindowOptionsKit is not equivalent to this StandAloneWindowOptionsKit.
in_kit | The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::operator= | ( | StandAloneWindowOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this StandAloneWindowOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to a StandAloneWindowOptionsKit to take the impl from. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::operator= | ( | StandAloneWindowOptionsKit const & | in_kit | ) |
Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.
in_kit | The source StandAloneWindowOptionsKit to copy. |
bool StandAloneWindowOptionsKit::operator== | ( | StandAloneWindowOptionsKit const & | in_kit | ) | const |
Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.
in_kit | The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit. |
void StandAloneWindowOptionsKit::Set | ( | StandAloneWindowOptionsKit const & | in_kit | ) |
Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.
in_kit | The source StandAloneWindowOptionsKit to copy. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::SetAntiAliasCapable | ( | bool | in_state, |
unsigned int | in_samples = 4 |
||
) |
Sets the anti-alias options for this StandAloneWindowOptionsKit.
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. Defaults to 4. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::SetDriver | ( | Window::Driver | in_driver | ) |
Sets the driver for this StandAloneWindowOptionsKit.
in_driver | The driver for this StandAloneWindowOptionsKit. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::SetFullScreen | ( | bool | in_state | ) |
Sets whether the associated stand-alone window should fill the screen.
in_state | Whether the associated stand-alone window should fill the screen. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::SetMobility | ( | Window::Mobility | in_mobility | ) |
Sets the mobility for this StandAloneWindowOptionsKit.
in_mobility | The mobility for this StandAloneWindowOptionsKit. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::SetSubscreen | ( | Rectangle const & | in_subscreen | ) |
Sets the subscreen to render into for this StandAloneWindowOptionsKit.
in_subscreen | The subscreen to render into for this StandAloneWindowOptionsKit. 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. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::SetTitle | ( | char const * | in_window_name | ) |
Sets the title for this StandAloneWindowOptionsKit.
in_window_name | UTF8-encoded title for this StandAloneWindowOptionsKit. |
void StandAloneWindowOptionsKit::Show | ( | StandAloneWindowOptionsKit & | out_kit | ) | const |
Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.
out_kit | The StandAloneWindowOptionsKit to populate with the contents of this StandAloneWindowOptionsKit. |
bool StandAloneWindowOptionsKit::ShowAntiAliasCapable | ( | bool & | out_state, |
unsigned int & | out_samples | ||
) | const |
Shows the anti-alias options for this StandAloneWindowOptionsKit.
out_state | Whether the associated stand-alone window should be anti-alias capable. |
out_samples | The number of anti-alias samples to use for the stand-alone application window. |
bool StandAloneWindowOptionsKit::ShowDriver | ( | Window::Driver & | out_driver | ) | const |
Shows the driver for this StandAloneWindowOptionsKit.
out_driver | The driver for this StandAloneWindowOptionsKit. |
bool StandAloneWindowOptionsKit::ShowFullScreen | ( | bool & | out_state | ) | const |
Shows whether the associated stand-alone window should fill the screen.
out_state | Whether the associated stand-alone window should fill the screen. |
bool StandAloneWindowOptionsKit::ShowMobility | ( | Window::Mobility & | out_mobility | ) | const |
Shows the mobility for this StandAloneWindowOptionsKit.
out_mobility | The mobility for this StandAloneWindowOptionsKit. |
bool StandAloneWindowOptionsKit::ShowSubscreen | ( | Rectangle & | out_subscreen | ) | const |
Shows the subscreen for this StandAloneWindowOptionsKit.
out_subscreen | The subscreen for this StandAloneWindowOptionsKit. |
bool StandAloneWindowOptionsKit::ShowTitle | ( | UTF8 & | out_window_name | ) | const |
Shows the title for this StandAloneWindowOptionsKit.
out_window_name | UTF8-encoded title for this StandAloneWindowOptionsKit. |
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::UnsetAntiAliasCapable | ( | ) |
Removes the anti-alias options for this StandAloneWindowOptionsKit.
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::UnsetDriver | ( | ) |
Removes the driver for this StandAloneWindowOptionsKit.
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this StandAloneWindowOptionsKit.
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::UnsetFullScreen | ( | ) |
Removes whether the associated stand-alone window should fill the screen.
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::UnsetMobility | ( | ) |
Removes the mobility for this StandAloneWindowOptionsKit.
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::UnsetSubscreen | ( | ) |
Removes the subscreen for this StandAloneWindowOptionsKit.
StandAloneWindowOptionsKit& StandAloneWindowOptionsKit::UnsetTitle | ( | ) |
Removes the title for this StandAloneWindowOptionsKit.