Struct VolumeCamera.WindowState

Struct to encapsulate a change in window state.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.PolySpatial

Assembly: Unity.PolySpatial.dll

Syntax

public struct VolumeCamera.WindowState

Fields

ContentDimensions

The dimensions that your Volume Camera's dimensions are mapped to, in Unity's coordinate units. (On visionOS, these will typically be the same, but they may not be on other platforms.)

Declaration

public Vector3 ContentDimensions

Field Value

Type	Description
Vector3

IsFocused

When windowEvent is set to WindowEvent.Focused, this will indicate whether it has received focus or lost it.

Declaration

public bool IsFocused

Field Value

Type	Description
bool

Mode

The mode this volume camera will display its content in, Bounded or Unbounded.

Declaration

public VolumeCamera.PolySpatialVolumeCameraMode Mode

Field Value

Type	Description
VolumeCamera.PolySpatialVolumeCameraMode

OutputDimensions

The actual dimensions of the window in world space, or Vector3.zero if the volume is unbounded.

Declaration

public Vector3 OutputDimensions

Field Value

Type	Description
Vector3

SessionID

An ID representing the PolySpatial session that generated this event. If the value is 0, the event was generated by the local (in-process) session. For any other value, the event was generated by a remote (network-connected) session. If developing using Play-to-Device, this value can be used to determine if an event was generated by the Editor (ID == 0), or by a device (ID > 0).

Declaration

public ushort SessionID

Field Value

Type	Description
ushort

WindowEvent

The change in state that just occurred for this window. Change of states can mean actions such as the window was opened or the window was backgrounded.

Declaration

public VolumeCamera.WindowEvent WindowEvent

Field Value

Type	Description
VolumeCamera.WindowEvent

Methods

IsLocalEvent()

Helper for determining if this event was generated by the local session.

Declaration

public readonly bool IsLocalEvent()

Returns

Type	Description
bool	True if generated by the local session