#include <hps.h>
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.
HPS::OffScreenWindowOptionsControl::OffScreenWindowOptionsControl |
( |
OffScreenWindowKey & |
in_seg | ) |
|
|
explicit |
HPS::Type HPS::OffScreenWindowOptionsControl::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 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.
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.
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_state | 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.
The documentation for this class was generated from the following file:
- C:/git/visualize/hps/include/hps.h