#include <hps.h>

Public Member Functions | |
HPS::Type | ObjectType () const |
OffScreenWindowOptionsControl (OffScreenWindowKey &in_seg) | |
OffScreenWindowOptionsControl (OffScreenWindowOptionsControl const &in_that) | |
OffScreenWindowOptionsControl (OffScreenWindowOptionsControl &&in_that) | |
OffScreenWindowOptionsControl & | operator= (OffScreenWindowOptionsControl &&in_that) |
OffScreenWindowOptionsControl & | operator= (OffScreenWindowOptionsControl const &in_that) |
OffScreenWindowOptionsControl & | SetFallbackFonts (UTF8Array const &in_fonts) |
OffScreenWindowOptionsControl & | SetNativeFormat (Window::ImageFormat in_format, float in_quality=1.0f) |
OffScreenWindowOptionsControl & | SetSize (unsigned int in_width, unsigned int in_height) |
bool | ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const |
bool | ShowDriver (Window::Driver &out_driver) const |
size_t | ShowFallbackFonts (UTF8Array &out_fonts) const |
bool | ShowHardwareResident (bool &out_state) const |
bool | ShowImage (Image::Format in_format, ImageKit &out_image) const |
bool | ShowImage (ByteArray &out_bytes) const |
bool | ShowNativeFormat (Window::ImageFormat &out_format, float &out_quality) const |
bool | ShowOpacity (bool &out_state, float &out_opacity) const |
bool | ShowSize (unsigned int &out_width, unsigned int &out_height) const |
OffScreenWindowOptionsControl & | UnsetFallbackFonts () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
The HPS::OffScreenWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query offscreen-window-specific options on an OffScreenWindowKey. This control also gives you the ability to make a screenshot of the Visualize scene using ShowImage. This table lists default values for the various segment attributes accessible from HPS::OffScreenWindowOptionsControl.
Constructor & Destructor Documentation
|
explicit |
This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window.
- Parameters
-
in_window The offscreen window which this OffScreenWindowOptionsControl should operate on.
HPS::OffScreenWindowOptionsControl::OffScreenWindowOptionsControl | ( | OffScreenWindowOptionsControl const & | in_that | ) |
The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl.
- Parameters
-
in_that The source OffScreenWindowOptionsControl to copy.
HPS::OffScreenWindowOptionsControl::OffScreenWindowOptionsControl | ( | OffScreenWindowOptionsControl && | in_that | ) |
The move constructor creates an OffScreenWindowOptionsControl by transferring the underlying impl of the rvalue reference to this OffScreenWindowOptionsControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an OffScreenWindowOptionsControl to take the impl from.
Member Function Documentation
|
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.
OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::operator= | ( | OffScreenWindowOptionsControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this OffScreenWindowOptionsControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an OffScreenWindowOptionsControl to take the impl from.
- Returns
- A reference to this OffScreenWindowOptionsControl.
OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::operator= | ( | OffScreenWindowOptionsControl const & | in_that | ) |
Share the underlying smart-pointer of the OffScreenWindowOptionsControl source.
- Parameters
-
in_that The OffScreenWindowOptionsControl source of the assignment.
- Returns
- A reference to this OffScreenWindowOptionsControl.
OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::SetFallbackFonts | ( | UTF8Array const & | in_fonts | ) |
Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font.
- Parameters
-
in_fonts An array of UTF8 encoded strings that correspond to the fallback fonts being used.
OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::SetNativeFormat | ( | Window::ImageFormat | in_format, |
float | in_quality = 1.0f |
||
) |
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 OffScreenWindowOptionsControl.
OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::SetSize | ( | unsigned int | in_width, |
unsigned int | in_height | ||
) |
Sets the width and height in pixels of the associated offscreen window.
- Parameters
-
in_width The width in pixels of the associated offscreen window. in_height The height in pixels of the associated offscreen window.
- Returns
- A reference to this OffScreenWindowOptionsControl.
bool HPS::OffScreenWindowOptionsControl::ShowAntiAliasCapable | ( | bool & | out_state, |
unsigned int & | out_samples | ||
) | const |
Shows the whether this offscreen window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.
- Parameters
-
out_state Whether this offscreen window is anti-alias capable. out_samples The number of anti-alias samples supported by this offscreen window.
- Returns
- true if any anti-alias options were set, false otherwise.
bool HPS::OffScreenWindowOptionsControl::ShowDriver | ( | Window::Driver & | out_driver | ) | const |
Shows the driver for the associated offscreen window.
- Parameters
-
out_driver The driver for the associated offscreen window.
- Returns
- true if a driver was set, false otherwise.
size_t HPS::OffScreenWindowOptionsControl::ShowFallbackFonts | ( | UTF8Array & | out_fonts | ) | const |
Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font.
- Parameters
-
out_fonts An array of UTF8 encoded strings that correspond to the fallback fonts being used.
bool HPS::OffScreenWindowOptionsControl::ShowHardwareResident | ( | bool & | out_state | ) | const |
Shows the hardware resident option of the associated offscreen window.
- 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::OffScreenWindowOptionsControl::ShowImage | ( | Image::Format | in_format, |
ImageKit & | out_image | ||
) | const |
Shows the contents of this offscreen window into the provided ImageKit in the specified format.
- Parameters
-
in_format The format of the image to generate. out_image The contents of this offscreen window as an image in the specified format.
- Returns
- true if the shown image is valid, false otherwise.
bool HPS::OffScreenWindowOptionsControl::ShowImage | ( | ByteArray & | out_bytes | ) | const |
Shows the image bytes in the native format for this OffScreenWindow.
- Parameters
-
in_quality Desired quality for compressed image formats. out_bytes Image data as an array of bytes.
- Returns
- true if the shown image is valid, false otherwise.
bool HPS::OffScreenWindowOptionsControl::ShowNativeFormat | ( | Window::ImageFormat & | out_format, |
float & | out_quality | ||
) | const |
Shows the native format and quality of the associated offscreen window.
- 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::OffScreenWindowOptionsControl::ShowOpacity | ( | bool & | out_state, |
float & | out_opacity | ||
) | const |
Shows the opacity of the associated offscreen window
- Parameters
-
out_state Whether the offscreen window supports opacity in the window background. out_opacity The opacity value that will be applied when rendering the window background.
- Returns
- true if an opacity option was set, false otherwise.
bool HPS::OffScreenWindowOptionsControl::ShowSize | ( | unsigned int & | out_width, |
unsigned int & | out_height | ||
) | const |
Shows the width and height in pixels of the associated offscreen window.
- Parameters
-
out_width The width in pixels of the associated offscreen window. out_height The height in pixels of the associated offscreen window.
- Returns
- true if a height and width were set, false otherwise.
OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::UnsetFallbackFonts | ( | ) |
Unsets any fonts currently used as fallback fonts.
The documentation for this class was generated from the following file:
- include/hps.h