Window

class HPS.Window : public IDisposable

The Window class is a concept class for window-related enum classes.

Public Types

enum Driver

Enumerates the types of supported display drivers. We recommend that you use the Default3D driver type, and provide end-users with the ability to manually select from a range of 3d drivers in a driver-pulldown list. This will allow them to potentially work around graphics-card-specific problems that occur with a specific driver type.

Values:

Default3D

Visualize will perform runtime query of the 3D capabilities of the Operating System and graphics card and automatically choose a display driver. Under Windows, preference will be given to DirectX API, followed by OpenGL. Under all other platforms, only the OpenGL API is supported.

OpenGL

This is an alias for OpenGL2.

OpenGL2

Shader-based driver which supports OpenGL Core Profile on Windows, Linux, and macOS. OpenGL ES 2.0+ on iOS and Android.

DirectX11

Shader-based driver which supports DirectX 10.X+ Available on Windows.

OpenGL2Mesa
Metal
enum FrameOptions

Window Frame Positioning

Values:

Inset

Window Frame Positioning.

Overlay

Window Frame Positioning.

enum FrameSize

Dimensions of the Window Frame

Values:

Single

Window Frame Size.

Double

Window Frame Size.

enum ImageFormat

The native image format for off-screen windows

Values:

Default

Image Format.

RGBA

Image Format.

RGB

Image Format.

Jpeg

Image Format.

Png

Image Format.

enum Mobility

Enumerates the mobility modes (i.e., resizing and positioning behaviors) for stand-alone windows.

Values:

Locked

The stand-alone window cannot be moved or resized.

Floating

The stand-alone window can be moved, but cannot be resized.

FixedRatio

The stand-alone window can be moved and resized, but the aspect ratio cannot be changed.

Free

The stand-alone window can be moved and resized, and the aspect ratio can be changed.

enum UpdateStatus

Enumerates the status that can be returned when performing an update.

Values:

InProgress

Update is not done yet.

Completed

Update was successfully completed.

TimedOut

Update timed out before it could be completed.

Interrupted

Update was interrupted.

Failed

Update failed.

enum UpdateType

Controls the type of update that Visualize will attempt to perform. For information regarding static model regeneration for each specific UpdateType, please see Performance Considerations in the Rendering section of the programming guide.

Values:

Default

Makes sure that the screen is up-to-date with respect to the internal scene graph. Allows Visualize to automatically perform optimizations.

Complete
Refresh

Pulls the back buffer onto the screen. This is a useful way to update the screen after an expose event like when a window that was occluding your scene is moved away.

CompileOnly

Only compiles static trees and display lists.

Exhaustive

Public Functions

void Dispose ()
Window (HPS.Window in_that)