Inheritance diagram for HPS.OffScreenWindowOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.OffScreenWindowOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 OffScreenWindowOptionsKit ()
 
 OffScreenWindowOptionsKit (HPS.OffScreenWindowOptionsKit in_kit)
 
void Set (HPS.OffScreenWindowOptionsKit in_kit)
 
HPS.OffScreenWindowOptionsKit SetAntiAliasCapable (bool in_state, uint in_samples)
 
HPS.OffScreenWindowOptionsKit SetAntiAliasCapable (bool in_state)
 
HPS.OffScreenWindowOptionsKit SetDriver (HPS.Window.Driver in_driver)
 
HPS.OffScreenWindowOptionsKit SetFramebufferRetention (bool in_retain)
 
HPS.OffScreenWindowOptionsKit SetHardwareResident (bool in_state)
 
HPS.OffScreenWindowOptionsKit SetNativeFormat (HPS.Window.ImageFormat in_format, float in_quality)
 
HPS.OffScreenWindowOptionsKit SetNativeFormat (HPS.Window.ImageFormat in_format)
 
HPS.OffScreenWindowOptionsKit SetOpacity (bool in_state, float in_opacity)
 
HPS.OffScreenWindowOptionsKit SetOpacity (bool in_state)
 
HPS.OffScreenWindowOptionsKit SetOpacity (float in_opacity)
 
HPS.OffScreenWindowOptionsKit SetPreferredGPU (HPS.GPU.Preference in_gpu_preference, string in_gpu_name)
 
HPS.OffScreenWindowOptionsKit SetPreferredGPU (HPS.GPU.Preference in_gpu_preference)
 
HPS.OffScreenWindowOptionsKit SetScreenAntiAliasing (bool in_state)
 
void Show (out HPS.OffScreenWindowOptionsKit out_kit)
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 
bool ShowFramebufferRetention (out bool out_retain)
 
bool ShowHardwareResident (out bool out_state)
 
bool ShowNativeFormat (out HPS.Window.ImageFormat out_format, out float out_quality)
 
bool ShowOpacity (out bool out_state, out float out_opacity)
 
bool ShowPreferredGPU (out HPS.GPU.Preference out_gpu_preference, out string out_gpu_name)
 
HPS.OffScreenWindowOptionsKit UnsetAntiAliasCapable ()
 
HPS.OffScreenWindowOptionsKit UnsetDriver ()
 
HPS.OffScreenWindowOptionsKit UnsetEverything ()
 
HPS.OffScreenWindowOptionsKit UnsetFramebufferRetention ()
 
HPS.OffScreenWindowOptionsKit UnsetHardwareResident ()
 
HPS.OffScreenWindowOptionsKit UnsetNativeFormat ()
 
HPS.OffScreenWindowOptionsKit UnsetOpacity ()
 
HPS.OffScreenWindowOptionsKit UnsetPreferredGPU ()
 
HPS.OffScreenWindowOptionsKit UnsetScreenAntiAliasing ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.OffScreenWindowOptionsKit GetDefault ()
 
static bool operator!= (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b)
 
static bool operator== (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.OffScreenWindowOptionsKit class is a user space object. It is used to specify off-screen-window-specific options. Calling HPS.OffScreenWindowOptionsKit.GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ OffScreenWindowOptionsKit() [1/2]

HPS.OffScreenWindowOptionsKit.OffScreenWindowOptionsKit ( )
inline

The default constructor creates an empty OffScreenWindowOptionsKit object.

◆ OffScreenWindowOptionsKit() [2/2]

HPS.OffScreenWindowOptionsKit.OffScreenWindowOptionsKit ( HPS.OffScreenWindowOptionsKit  in_kit)
inline

The copy constructor creates a new OffScreenWindowOptionsKit object that contains the same settings as the source OffScreenWindowOptionsKit.

Parameters
in_kitThe source OffScreenWindowOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.OffScreenWindowOptionsKit.Empty ( )
inlinevirtual

Indicates whether this OffScreenWindowOptionsKit has any values set on it.

Returns
true if no values are set on this OffScreenWindowOptionsKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.OffScreenWindowOptionsKit.Equals ( HPS.OffScreenWindowOptionsKit  in_kit)
inline

Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit.

Parameters
in_kitThe source OffScreenWindowOptionsKit to compare to this OffScreenWindowOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.GetDefault ( )
inlinestatic

Creates an OffScreenWindowOptionsKit 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.

Returns
An OffScreenWindowOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.OffScreenWindowOptionsKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Kit.

◆ Set()

void HPS.OffScreenWindowOptionsKit.Set ( HPS.OffScreenWindowOptionsKit  in_kit)
inline

Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.

Parameters
in_kitThe source OffScreenWindowOptionsKit to copy.

◆ SetAntiAliasCapable() [1/2]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetAntiAliasCapable ( bool  in_state,
uint  in_samples 
)
inline

Sets the anti-alias options for this OffScreenWindowOptionsKit.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
in_samplesThe number of anti-alias samples to use for the associated off-screen window.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetAntiAliasCapable() [2/2]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetAntiAliasCapable ( bool  in_state)
inline

Sets the anti-alias options for this OffScreenWindowOptionsKit.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetDriver()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetDriver ( HPS.Window.Driver  in_driver)
inline

Sets the driver for this OffScreenWindowOptionsKit.

Parameters
in_driverThe driver for this OffScreenWindowOptionsKit.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetFramebufferRetention()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetFramebufferRetention ( bool  in_retain)
inline

Sets the framebuffer retention option for this OffScreenWindowOptionsKit.

Parameters
in_retainWhether the associated offscreen window retains the image from the previous frame.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetHardwareResident()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetHardwareResident ( bool  in_state)
inline

Sets whether the image data for this offscreen window should be stored exclusively in video memory. Storing the image in video memory improves the update time but may make the image data inaccessible directly.

Parameters
in_stateWhether the image data for this offscreen window should be stored exclusively in video memory.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetNativeFormat() [1/2]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetNativeFormat ( HPS.Window.ImageFormat  in_format,
float  in_quality 
)
inline

Sets the native image format to store data in.

Parameters
in_formatFormat image data will be stored in.
in_qualityThe compression quality for the image data (when applicable).
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetNativeFormat() [2/2]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetNativeFormat ( HPS.Window.ImageFormat  in_format)
inline

Sets the native image format to store data in.

Parameters
in_formatFormat image data will be stored in.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetOpacity() [1/3]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetOpacity ( bool  in_state,
float  in_opacity 
)
inline

Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.

Parameters
in_stateWhether this offscreen window should support opacity in the window background.
in_opacityThe opacity value that will be applied when rendering the window background. The value is clamped if the opacity is outside the range 0 to 1.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetOpacity() [2/3]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetOpacity ( bool  in_state)
inline

Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.

Parameters
in_stateWhether this offscreen window should support opacity in the window background.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetOpacity() [3/3]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetOpacity ( float  in_opacity)
inline

Enables support for opacity in the window background and applies the specified opacity value when rendering the window background.

Parameters
in_opacityThe opacity value that will be applied when rendering the window background.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetPreferredGPU() [1/2]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetPreferredGPU ( HPS.GPU.Preference  in_gpu_preference,
string  in_gpu_name 
)
inline

Sets which GPU to use when there are multiple available GPUs on a system. This method is only available when using the DirectX11 driver. Other drivers will ignore this request.

<computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> GPU.Preference.Specific </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> Database.ShowAvailableGPUs() </computeroutput>. If you select something other than default GPU, and Visualize cannot find a GPU which satisfies the requirement, the default GPU will be used.

All Visualize windows using DirectX11 will use the same GPU. The user should select the preferred GPU before creating a DirectX11 window. The default is for DirectX11 windows to use HighPerformance GPUs. The Microsoft Basic Software Render Driver is always returned as one of the available GPUs by DirectX11. By selecting it (which users can do by calling <computeroutput>SetPreferredGPU(GPU.Preference.Specific, "Microsoft Basic Render Driver")</computeroutput>), DirectX11 will run in software mode.

Parameters
in_gpu_preferenceWhich GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required.
in_gpu_nameThe name of the specific GPU to use. Required when in_gpu_preference is GPU.Preference.Specific, ignored otherwise.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetPreferredGPU() [2/2]

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetPreferredGPU ( HPS.GPU.Preference  in_gpu_preference)
inline

Sets which GPU to use when there are multiple available GPUs on a system. This method is only available when using the DirectX11 driver. Other drivers will ignore this request.

<computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> GPU.Preference.Specific </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> Database.ShowAvailableGPUs() </computeroutput>. If you select something other than default GPU, and Visualize cannot find a GPU which satisfies the requirement, the default GPU will be used.

All Visualize windows using DirectX11 will use the same GPU. The user should select the preferred GPU before creating a DirectX11 window. The default is for DirectX11 windows to use HighPerformance GPUs. The Microsoft Basic Software Render Driver is always returned as one of the available GPUs by DirectX11. By selecting it (which users can do by calling <computeroutput>SetPreferredGPU(GPU.Preference.Specific, "Microsoft Basic Render Driver")</computeroutput>), DirectX11 will run in software mode.

Parameters
in_gpu_preferenceWhich GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetScreenAntiAliasing()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetScreenAntiAliasing ( bool  in_state)
inline

Manipulates the state of screen anti-aliasing.

Parameters
in_stateWhether screen anti-aliasing should be used.
Returns
A reference to this object.

◆ Show()

void HPS.OffScreenWindowOptionsKit.Show ( out HPS.OffScreenWindowOptionsKit  out_kit)
inline

Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit.

Parameters
out_kitThe OffScreenWindowOptionsKit to populate with the contents of this OffScreenWindowOptionsKit.

◆ ShowAntiAliasCapable()

bool HPS.OffScreenWindowOptionsKit.ShowAntiAliasCapable ( out bool  out_state,
out uint  out_samples 
)
inline

Shows the anti-alias options for this OffScreenWindowOptionsKit.

Parameters
out_stateWhether the associated application window should be anti-alias capable.
out_samplesThe number of anti-alias samples to use for the associated application window.
Returns
true if anti-alias options were set, false otherwise.

◆ ShowDriver()

bool HPS.OffScreenWindowOptionsKit.ShowDriver ( out HPS.Window.Driver  out_driver)
inline

Shows the driver for this OffScreenWindowOptionsKit.

Parameters
out_driverThe driver for this OffScreenWindowOptionsKit.
Returns
true if a driver was set, false otherwise.

◆ ShowFramebufferRetention()

bool HPS.OffScreenWindowOptionsKit.ShowFramebufferRetention ( out bool  out_retain)
inline

Shows the framebuffer retention setting for this OffScreenWindowOptionsKit.

Parameters
out_retainThe framebuffer retention setting for this OffScreenWindowOptionsKit.
Returns
true if platform specific data was set, false otherwise.

◆ ShowHardwareResident()

bool HPS.OffScreenWindowOptionsKit.ShowHardwareResident ( out bool  out_state)
inline

Shows the hardware resident option for this OffScreenWindowOptionsKit.

Parameters
out_stateWhether 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.

◆ ShowNativeFormat()

bool HPS.OffScreenWindowOptionsKit.ShowNativeFormat ( out HPS.Window.ImageFormat  out_format,
out float  out_quality 
)
inline

Shows the native format option for this OffScreenWindowOptionsKit.

Parameters
out_formatFormat image data will be stored in.
out_qualityThe compression quality for the image data (when applicable).
Returns
true if a native format option was set, false otherwise.

◆ ShowOpacity()

bool HPS.OffScreenWindowOptionsKit.ShowOpacity ( out bool  out_state,
out float  out_opacity 
)
inline

Shows the opacity option for this offscreen window

Parameters
out_stateWhether this offscreen window supports opacity in the window background.
out_opacityThe opacity value that will be applied when rendering the window background.
Returns
true if an opacity option was set, false otherwise.

◆ ShowPreferredGPU()

bool HPS.OffScreenWindowOptionsKit.ShowPreferredGPU ( out HPS.GPU.Preference  out_gpu_preference,
out string  out_gpu_name 
)
inline

Shows the preference settings for picking a GPU when multiple GPUs are available.

Parameters
out_gpu_preferenceThe preference for picking a GPU when multiple GPUs are available.
out_gpu_nameThe name of the GPU to use. Only valid when out_gpu_preference is GPU.Preference.Specific
Returns
true if a GPU preference was set, false otherwise.

◆ UnsetAntiAliasCapable()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetAntiAliasCapable ( )
inline

Removes the anti-alias options for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetDriver()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetDriver ( )
inline

Removes the driver for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetEverything()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetEverything ( )
inline

Removes all settings from this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetFramebufferRetention()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetFramebufferRetention ( )
inline

Removes the framebuffer retention setting for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetHardwareResident()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetHardwareResident ( )
inline

Removes the hardware resident option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetNativeFormat()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetNativeFormat ( )
inline

Removes the native format option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetOpacity()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetOpacity ( )
inline

Removes the opacity option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetPreferredGPU()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetPreferredGPU ( )
inline

Removes the setting for which GPU should be used when multiple GPUs are available.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetScreenAntiAliasing()

HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetScreenAntiAliasing ( )
inline

Removes the screen anti-alias options for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.OffScreenWindowOptionsKit.cs