REFERENCE MANUAL
#include <hps.h>
Static Public Member Functions | |
static ApplicationWindowOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The ApplicationWindowOptionsKit class is a user space object. It is used to specify application-window-specific options. Calling ApplicationWindowOptionsKit::GetDefault() will return a kit with values found in this table.
ApplicationWindowOptionsKit::ApplicationWindowOptionsKit | ( | ) |
The default constructor creates an empty ApplicationWindowOptionsKit object.
ApplicationWindowOptionsKit::ApplicationWindowOptionsKit | ( | ApplicationWindowOptionsKit const & | in_kit | ) |
The copy constructor creates a new ApplicationWindowOptionsKit object that contains the same settings as the source ApplicationWindowOptionsKit.
in_kit | The source ApplicationWindowOptionsKit to copy. |
ApplicationWindowOptionsKit::ApplicationWindowOptionsKit | ( | ApplicationWindowOptionsKit && | in_that | ) |
The move constructor creates an ApplicationWindowOptionsKit by transferring the underlying impl of the rvalue reference to this ApplicationWindowOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to an ApplicationWindowOptionsKit to take the impl from. |
|
virtual |
Indicates whether this ApplicationWindowOptionsKit has any values set on it.
Reimplemented from Object.
bool ApplicationWindowOptionsKit::Equals | ( | ApplicationWindowOptionsKit const & | in_kit | ) | const |
Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.
in_kit | The source ApplicationWindowOptionsKit to compare to this ApplicationWindowOptionsKit. |
|
static |
Creates an ApplicationWindowOptionsKit 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 ApplicationWindowOptionsKit::operator!= | ( | ApplicationWindowOptionsKit const & | in_kit | ) | const |
Check if the source ApplicationWindowOptionsKit is not equivalent to this ApplicationWindowOptionsKit.
in_kit | The source ApplicationWindowOptionsKit to compare to this ApplicationWindowOptionsKit. |
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::operator= | ( | ApplicationWindowOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ApplicationWindowOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to an ApplicationWindowOptionsKit to take the impl from. |
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::operator= | ( | ApplicationWindowOptionsKit const & | in_kit | ) |
Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.
in_kit | The source ApplicationWindowOptionsKit to copy. |
bool ApplicationWindowOptionsKit::operator== | ( | ApplicationWindowOptionsKit const & | in_kit | ) | const |
Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.
in_kit | The source ApplicationWindowOptionsKit to compare to this ApplicationWindowOptionsKit. |
void ApplicationWindowOptionsKit::Set | ( | ApplicationWindowOptionsKit const & | in_kit | ) |
Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.
in_kit | The source ApplicationWindowOptionsKit to copy. |
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::SetAntiAliasCapable | ( | bool | in_state, |
unsigned int | in_samples = 4 |
||
) |
Sets the anti-alias options for this ApplicationWindowOptionsKit.
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. |
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::SetDriver | ( | Window::Driver | in_driver | ) |
Sets the driver for this ApplicationWindowOptionsKit.
in_driver | The driver for this ApplicationWindowOptionsKit. |
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::SetFramebufferRetention | ( | bool | in_retain | ) |
Sets the framebuffer retention option for this ApplicationWindowOptionsKit.
in_retain | Whether the associated application window retains the image from the previous frame. |
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::SetPlatformData | ( | PlatformData | in_platform_data | ) |
Sets the platform specific data for this ApplicationWindowOptionsKit.
in_platform_data | Platform specific data for this ApplicationWindowOptionsKit. |
void ApplicationWindowOptionsKit::Show | ( | ApplicationWindowOptionsKit & | out_kit | ) | const |
Copies this ApplicationWindowOptionsKit into the given ApplicationWindowOptionsKit.
out_kit | The ApplicationWindowOptionsKit to populate with the contents of this ApplicationWindowOptionsKit. |
bool ApplicationWindowOptionsKit::ShowAntiAliasCapable | ( | bool & | out_state, |
unsigned int & | out_samples | ||
) | const |
Shows the anti-alias options for this ApplicationWindowOptionsKit.
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. |
bool ApplicationWindowOptionsKit::ShowDriver | ( | Window::Driver & | out_driver | ) | const |
Shows the driver for this ApplicationWindowOptionsKit.
out_driver | The driver for this ApplicationWindowOptionsKit. |
bool ApplicationWindowOptionsKit::ShowFramebufferRetention | ( | bool & | out_retain | ) | const |
Shows the framebuffer retention setting for this ApplicationWindowOptionsKit.
out_retain | The framebuffer retention setting for this ApplicationWindowOptionsKit. |
bool ApplicationWindowOptionsKit::ShowPlatformData | ( | PlatformData & | out_platform_data | ) | const |
Shows the platform specific data for this ApplicationWindowOptionsKit.
out_platform_data | The platform specific data for this ApplicationWindowOptionsKit. |
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::UnsetAntiAliasCapable | ( | ) |
Removes the anti-alias options for this ApplicationWindowOptionsKit.
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::UnsetDriver | ( | ) |
Removes the driver for this ApplicationWindowOptionsKit.
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ApplicationWindowOptionsKit.
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::UnsetFramebufferRetention | ( | ) |
Removes the framebuffer retention setting for this ApplicationWindowOptionsKit.
ApplicationWindowOptionsKit& ApplicationWindowOptionsKit::UnsetPlatformData | ( | ) |
Removes the platform specific data for this ApplicationWindowOptionsKit.