Package org.lwjgl.ovr

Class OVRFovStencilDesc

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<OVRFovStencilDesc>

org.lwjgl.ovr.OVRFovStencilDesc

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class OVRFovStencilDesc
extends org.lwjgl.system.Struct<OVRFovStencilDesc>
implements org.lwjgl.system.NativeResource

Fov-stencil mesh descriptor passed into the function GetFovStencil.

Layout

 struct ovrFovStencilDesc {
     ovrFovStencilType StencilType();
     uint32_t StencilFlags();
     ovrEyeType Eye;
     ovrFovPort FovPort();
     ovrQuatf HmdToEyeRotation();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OVRFovStencilDesc.Buffer	An array of OVRFovStencilDesc structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EYE	The struct member offsets.
static final int	FOVPORT	The struct member offsets.
static final int	HMDTOEYEROTATION	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STENCILFLAGS	The struct member offsets.
static final int	STENCILTYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
OVRFovStencilDesc(ByteBuffer container)	Creates a OVRFovStencilDesc instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static OVRFovStencilDesc	calloc()	Returns a new OVRFovStencilDesc instance allocated with memCalloc.
static OVRFovStencilDesc.Buffer	calloc(int capacity)	Returns a new OVRFovStencilDesc.Buffer instance allocated with memCalloc.
static OVRFovStencilDesc.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new OVRFovStencilDesc.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static OVRFovStencilDesc	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new OVRFovStencilDesc instance allocated on the specified MemoryStack and initializes all its bits to zero.
static OVRFovStencilDesc	callocStack()	Deprecated.
static OVRFovStencilDesc.Buffer	callocStack(int capacity)	Deprecated.
static OVRFovStencilDesc.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static OVRFovStencilDesc	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static OVRFovStencilDesc	create()	Returns a new OVRFovStencilDesc instance allocated with BufferUtils.
static OVRFovStencilDesc.Buffer	create(int capacity)	Returns a new OVRFovStencilDesc.Buffer instance allocated with BufferUtils.
static OVRFovStencilDesc	create(long address)	Returns a new OVRFovStencilDesc instance for the specified memory address.
static OVRFovStencilDesc.Buffer	create(long address, int capacity)	Create a OVRFovStencilDesc.Buffer instance at the specified memory.
static @Nullable OVRFovStencilDesc	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable OVRFovStencilDesc.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	Eye()
OVRFovStencilDesc	Eye(int value)	Sets the specified value to the Eye field.
OVRFovPort	FovPort()	typically FOV obtained from GetRenderDesc
OVRFovStencilDesc	FovPort(Consumer<OVRFovPort> consumer)	Passes the FovPort() field to the specified Consumer.
OVRFovStencilDesc	FovPort(OVRFovPort value)	Copies the specified OVRFovPort to the FovPort() field.
OVRQuatf	HmdToEyeRotation()	typically HmdToEyePose.Orientation obtained from GetRenderDesc.
OVRFovStencilDesc	HmdToEyeRotation(Consumer<OVRQuatf> consumer)	Passes the HmdToEyeRotation() field to the specified Consumer.
OVRFovStencilDesc	HmdToEyeRotation(OVRQuatf value)	Copies the specified OVRQuatf to the HmdToEyeRotation() field.
static OVRFovStencilDesc	malloc()	Returns a new OVRFovStencilDesc instance allocated with memAlloc.
static OVRFovStencilDesc.Buffer	malloc(int capacity)	Returns a new OVRFovStencilDesc.Buffer instance allocated with memAlloc.
static OVRFovStencilDesc.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new OVRFovStencilDesc.Buffer instance allocated on the specified MemoryStack.
static OVRFovStencilDesc	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new OVRFovStencilDesc instance allocated on the specified MemoryStack.
static OVRFovStencilDesc	mallocStack()	Deprecated.
static OVRFovStencilDesc.Buffer	mallocStack(int capacity)	Deprecated.
static OVRFovStencilDesc.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static OVRFovStencilDesc	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nEye(long struct)	Unsafe version of Eye().
static void	nEye(long struct, int value)	Unsafe version of Eye.
static OVRFovPort	nFovPort(long struct)	Unsafe version of FovPort().
static void	nFovPort(long struct, OVRFovPort value)	Unsafe version of FovPort.
static OVRQuatf	nHmdToEyeRotation(long struct)	Unsafe version of HmdToEyeRotation().
static void	nHmdToEyeRotation(long struct, OVRQuatf value)	Unsafe version of HmdToEyeRotation.
static int	nStencilFlags(long struct)	Unsafe version of StencilFlags().
static void	nStencilFlags(long struct, int value)	Unsafe version of StencilFlags.
static int	nStencilType(long struct)	Unsafe version of StencilType().
static void	nStencilType(long struct, int value)	Unsafe version of StencilType.
OVRFovStencilDesc	set(int StencilType, int StencilFlags, int Eye, OVRFovPort FovPort, OVRQuatf HmdToEyeRotation)	Initializes this struct with the specified values.
OVRFovStencilDesc	set(OVRFovStencilDesc src)	Copies the specified struct data to this struct.
int	sizeof()
int	StencilFlags()	one or more of: FovStencilFlag_MeshOriginAtBottomLeft
OVRFovStencilDesc	StencilFlags(int value)	Sets the specified value to the StencilFlags() field.
int	StencilType()	one of: FovStencil_HiddenAreaFovStencil_VisibleAreaFovStencil_BorderLineFovStencil_VisibleRectangle
OVRFovStencilDesc	StencilType(int value)	Sets the specified value to the StencilType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STENCILTYPE

public static final int STENCILTYPE

The struct member offsets.

STENCILFLAGS

public static final int STENCILFLAGS

The struct member offsets.

EYE

public static final int EYE

The struct member offsets.

FOVPORT

public static final int FOVPORT

The struct member offsets.

HMDTOEYEROTATION

public static final int HMDTOEYEROTATION

The struct member offsets.

Constructor Details

OVRFovStencilDesc

public OVRFovStencilDesc(ByteBuffer container)

Creates a OVRFovStencilDesc instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<OVRFovStencilDesc>

StencilType

public int StencilType()

one of:

FovStencil_HiddenArea	FovStencil_VisibleArea	FovStencil_BorderLine
FovStencil_VisibleRectangle

StencilFlags

public int StencilFlags()

one or more of:

FovStencilFlag_MeshOriginAtBottomLeft

Eye

public int Eye()

Returns:

the value of the Eye field.

FovPort

public OVRFovPort FovPort()

typically FOV obtained from GetRenderDesc

HmdToEyeRotation

public OVRQuatf HmdToEyeRotation()

typically HmdToEyePose.Orientation obtained from GetRenderDesc. Note: Currently unsupported, always treated as identity.

StencilType

public OVRFovStencilDesc StencilType(int value)

Sets the specified value to the StencilType() field.

StencilFlags

public OVRFovStencilDesc StencilFlags(int value)

Sets the specified value to the StencilFlags() field.

Eye

public OVRFovStencilDesc Eye(int value)

Sets the specified value to the Eye field.

FovPort

public OVRFovStencilDesc FovPort(OVRFovPort value)

Copies the specified OVRFovPort to the FovPort() field.

FovPort

public OVRFovStencilDesc FovPort(Consumer<OVRFovPort> consumer)

Passes the FovPort() field to the specified Consumer.

HmdToEyeRotation

public OVRFovStencilDesc HmdToEyeRotation(OVRQuatf value)

Copies the specified OVRQuatf to the HmdToEyeRotation() field.

HmdToEyeRotation

public OVRFovStencilDesc HmdToEyeRotation(Consumer<OVRQuatf> consumer)

Passes the HmdToEyeRotation() field to the specified Consumer.

set

public OVRFovStencilDesc set(int StencilType,
 int StencilFlags,
 int Eye,
 OVRFovPort FovPort,
 OVRQuatf HmdToEyeRotation)

Initializes this struct with the specified values.

set

public OVRFovStencilDesc set(OVRFovStencilDesc src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static OVRFovStencilDesc malloc()

Returns a new OVRFovStencilDesc instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static OVRFovStencilDesc calloc()

Returns a new OVRFovStencilDesc instance allocated with memCalloc. The instance must be explicitly freed.

create

public static OVRFovStencilDesc create()

Returns a new OVRFovStencilDesc instance allocated with BufferUtils.

create

public static OVRFovStencilDesc create(long address)

Returns a new OVRFovStencilDesc instance for the specified memory address.

createSafe

public static @Nullable OVRFovStencilDesc createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static OVRFovStencilDesc.Buffer malloc(int capacity)

Returns a new OVRFovStencilDesc.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static OVRFovStencilDesc.Buffer calloc(int capacity)

Returns a new OVRFovStencilDesc.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static OVRFovStencilDesc.Buffer create(int capacity)

Returns a new OVRFovStencilDesc.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static OVRFovStencilDesc.Buffer create(long address,
 int capacity)

Create a OVRFovStencilDesc.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable OVRFovStencilDesc.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static OVRFovStencilDesc mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static OVRFovStencilDesc callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static OVRFovStencilDesc mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static OVRFovStencilDesc callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static OVRFovStencilDesc.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static OVRFovStencilDesc.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static OVRFovStencilDesc.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static OVRFovStencilDesc.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static OVRFovStencilDesc malloc(org.lwjgl.system.MemoryStack stack)

Returns a new OVRFovStencilDesc instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static OVRFovStencilDesc calloc(org.lwjgl.system.MemoryStack stack)

Returns a new OVRFovStencilDesc instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static OVRFovStencilDesc.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new OVRFovStencilDesc.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static OVRFovStencilDesc.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new OVRFovStencilDesc.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nStencilType

public static int nStencilType(long struct)

Unsafe version of StencilType().

nStencilFlags

public static int nStencilFlags(long struct)

Unsafe version of StencilFlags().

nEye

public static int nEye(long struct)

Unsafe version of Eye().

nFovPort

public static OVRFovPort nFovPort(long struct)

Unsafe version of FovPort().

nHmdToEyeRotation

public static OVRQuatf nHmdToEyeRotation(long struct)

Unsafe version of HmdToEyeRotation().

nStencilType

public static void nStencilType(long struct,
 int value)

Unsafe version of StencilType.

nStencilFlags

public static void nStencilFlags(long struct,
 int value)

Unsafe version of StencilFlags.

nEye

public static void nEye(long struct,
 int value)

Unsafe version of Eye.

nFovPort

public static void nFovPort(long struct,
 OVRFovPort value)

Unsafe version of FovPort.

nHmdToEyeRotation

public static void nHmdToEyeRotation(long struct,
 OVRQuatf value)

Unsafe version of HmdToEyeRotation.