java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.openvr.CompositorOverlaySettings

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class CompositorOverlaySettings
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Allows the application to customize how the overlay appears in the compositor.

Member documentation

size – sizeof(Compositor_OverlaySettings)

Layout


 struct Compositor_OverlaySettings {
     uint32_t size;
     bool curved;
     bool antialias;
     float scale;
     float distance;
     float alpha;
     float uOffset;
     float vOffset;
     float uScale;
     float vScale;
     float gridDivs;
     float gridWidth;
     float gridScale;
     HmdMatrix44_t transform;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CompositorOverlaySettings.Buffer
An array of CompositorOverlaySettings structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`ALPHA ANTIALIAS CURVED DISTANCE GRIDDIVS GRIDSCALE GRIDWIDTH SCALE SIZE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`TRANSFORM UOFFSET USCALE VOFFSET VSCALE`	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
`CompositorOverlaySettings(java.nio.ByteBuffer container)`	Creates a `CompositorOverlaySettings` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`float`	`alpha()`	Returns the value of the `alpha` field.
`CompositorOverlaySettings`	`alpha(float value)`	Sets the specified value to the `alpha` field.
`boolean`	`antialias()`	Returns the value of the `antialias` field.
`CompositorOverlaySettings`	`antialias(boolean value)`	Sets the specified value to the `antialias` field.
`static CompositorOverlaySettings`	`calloc()`	Returns a new `CompositorOverlaySettings` instance allocated with `memCalloc`.
`static CompositorOverlaySettings.Buffer`	`calloc(int capacity)`	Returns a new `CompositorOverlaySettings.Buffer` instance allocated with `memCalloc`.
`static CompositorOverlaySettings`	`callocStack()`	Returns a new `CompositorOverlaySettings` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CompositorOverlaySettings.Buffer`	`callocStack(int capacity)`	Returns a new `CompositorOverlaySettings.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CompositorOverlaySettings.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `CompositorOverlaySettings.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CompositorOverlaySettings`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `CompositorOverlaySettings` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CompositorOverlaySettings`	`create()`	Returns a new `CompositorOverlaySettings` instance allocated with `BufferUtils`.
`static CompositorOverlaySettings.Buffer`	`create(int capacity)`	Returns a new `CompositorOverlaySettings.Buffer` instance allocated with `BufferUtils`.
`static CompositorOverlaySettings`	`create(long address)`	Returns a new `CompositorOverlaySettings` instance for the specified memory address.
`static CompositorOverlaySettings.Buffer`	`create(long address, int capacity)`	Create a `CompositorOverlaySettings.Buffer` instance at the specified memory.
`static CompositorOverlaySettings`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static CompositorOverlaySettings.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`boolean`	`curved()`	Returns the value of the `curved` field.
`CompositorOverlaySettings`	`curved(boolean value)`	Sets the specified value to the `curved` field.
`float`	`distance()`	Returns the value of the `distance` field.
`CompositorOverlaySettings`	`distance(float value)`	Sets the specified value to the `distance` field.
`float`	`gridDivs()`	Returns the value of the `gridDivs` field.
`CompositorOverlaySettings`	`gridDivs(float value)`	Sets the specified value to the `gridDivs` field.
`float`	`gridScale()`	Returns the value of the `gridScale` field.
`CompositorOverlaySettings`	`gridScale(float value)`	Sets the specified value to the `gridScale` field.
`float`	`gridWidth()`	Returns the value of the `gridWidth` field.
`CompositorOverlaySettings`	`gridWidth(float value)`	Sets the specified value to the `gridWidth` field.
`static CompositorOverlaySettings`	`malloc()`	Returns a new `CompositorOverlaySettings` instance allocated with `memAlloc`.
`static CompositorOverlaySettings.Buffer`	`malloc(int capacity)`	Returns a new `CompositorOverlaySettings.Buffer` instance allocated with `memAlloc`.
`static CompositorOverlaySettings`	`mallocStack()`	Returns a new `CompositorOverlaySettings` instance allocated on the thread-local `MemoryStack`.
`static CompositorOverlaySettings.Buffer`	`mallocStack(int capacity)`	Returns a new `CompositorOverlaySettings.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CompositorOverlaySettings.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `CompositorOverlaySettings.Buffer` instance allocated on the specified `MemoryStack`.
`static CompositorOverlaySettings`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `CompositorOverlaySettings` instance allocated on the specified `MemoryStack`.
`static float`	`nalpha(long struct)`	Unsafe version of `alpha()`.
`static void`	`nalpha(long struct, float value)`	Unsafe version of `alpha`.
`static boolean`	`nantialias(long struct)`	Unsafe version of `antialias()`.
`static void`	`nantialias(long struct, boolean value)`	Unsafe version of `antialias`.
`static boolean`	`ncurved(long struct)`	Unsafe version of `curved()`.
`static void`	`ncurved(long struct, boolean value)`	Unsafe version of `curved`.
`static float`	`ndistance(long struct)`	Unsafe version of `distance()`.
`static void`	`ndistance(long struct, float value)`	Unsafe version of `distance`.
`static float`	`ngridDivs(long struct)`	Unsafe version of `gridDivs()`.
`static void`	`ngridDivs(long struct, float value)`	Unsafe version of `gridDivs`.
`static float`	`ngridScale(long struct)`	Unsafe version of `gridScale()`.
`static void`	`ngridScale(long struct, float value)`	Unsafe version of `gridScale`.
`static float`	`ngridWidth(long struct)`	Unsafe version of `gridWidth()`.
`static void`	`ngridWidth(long struct, float value)`	Unsafe version of `gridWidth`.
`static float`	`nscale(long struct)`	Unsafe version of `scale()`.
`static void`	`nscale(long struct, float value)`	Unsafe version of `scale`.
`static int`	`nsize(long struct)`	Unsafe version of `size()`.
`static void`	`nsize(long struct, int value)`	Unsafe version of `size`.
`static HmdMatrix44`	`ntransform(long struct)`	Unsafe version of `transform()`.
`static void`	`ntransform(long struct, HmdMatrix44 value)`	Unsafe version of `transform`.
`static float`	`nuOffset(long struct)`	Unsafe version of `uOffset()`.
`static void`	`nuOffset(long struct, float value)`	Unsafe version of `uOffset`.
`static float`	`nuScale(long struct)`	Unsafe version of `uScale()`.
`static void`	`nuScale(long struct, float value)`	Unsafe version of `uScale`.
`static float`	`nvOffset(long struct)`	Unsafe version of `vOffset()`.
`static void`	`nvOffset(long struct, float value)`	Unsafe version of `vOffset`.
`static float`	`nvScale(long struct)`	Unsafe version of `vScale()`.
`static void`	`nvScale(long struct, float value)`	Unsafe version of `vScale`.
`float`	`scale()`	Returns the value of the `scale` field.
`CompositorOverlaySettings`	`scale(float value)`	Sets the specified value to the `scale` field.
`CompositorOverlaySettings`	`set(int size, boolean curved, boolean antialias, float scale, float distance, float alpha, float uOffset, float vOffset, float uScale, float vScale, float gridDivs, float gridWidth, float gridScale, HmdMatrix44 transform)`	Initializes this struct with the specified values.
`CompositorOverlaySettings`	`set(CompositorOverlaySettings src)`	Copies the specified struct data to this struct.
`int`	`size()`	Returns the value of the `size` field.
`CompositorOverlaySettings`	`size(int value)`	Sets the specified value to the `size` field.
`int`	`sizeof()`
`HmdMatrix44`	`transform()`	Returns a `HmdMatrix44` view of the `transform` field.
`CompositorOverlaySettings`	`transform(java.util.function.Consumer<HmdMatrix44> consumer)`	Passes the `transform` field to the specified `Consumer`.
`CompositorOverlaySettings`	`transform(HmdMatrix44 value)`	Copies the specified `HmdMatrix44` to the `transform` field.
`float`	`uOffset()`	Returns the value of the `uOffset` field.
`CompositorOverlaySettings`	`uOffset(float value)`	Sets the specified value to the `uOffset` field.
`float`	`uScale()`	Returns the value of the `uScale` field.
`CompositorOverlaySettings`	`uScale(float value)`	Sets the specified value to the `uScale` field.
`float`	`vOffset()`	Returns the value of the `vOffset` field.
`CompositorOverlaySettings`	`vOffset(float value)`	Sets the specified value to the `vOffset` field.
`float`	`vScale()`	Returns the value of the `vScale` field.
`CompositorOverlaySettings`	`vScale(float value)`	Sets the specified value to the `vScale` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- SIZE, CURVED, ANTIALIAS, SCALE, DISTANCE, ALPHA, UOFFSET, VOFFSET, USCALE, VSCALE, GRIDDIVS, GRIDWIDTH, GRIDSCALE, TRANSFORM
  
  The struct member offsets.

Constructor Detail
- CompositorOverlaySettings
```
public CompositorOverlaySettings(java.nio.ByteBuffer container)
```
  Creates a CompositorOverlaySettings 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 Detail

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

size
```
public int size()
```
Returns the value of the size field.

curved
```
public boolean curved()
```
Returns the value of the curved field.

antialias
```
public boolean antialias()
```
Returns the value of the antialias field.

scale
```
public float scale()
```
Returns the value of the scale field.

distance
```
public float distance()
```
Returns the value of the distance field.

alpha
```
public float alpha()
```
Returns the value of the alpha field.

uOffset
```
public float uOffset()
```
Returns the value of the uOffset field.

vOffset
```
public float vOffset()
```
Returns the value of the vOffset field.

uScale
```
public float uScale()
```
Returns the value of the uScale field.

vScale
```
public float vScale()
```
Returns the value of the vScale field.

gridDivs
```
public float gridDivs()
```
Returns the value of the gridDivs field.

gridWidth
```
public float gridWidth()
```
Returns the value of the gridWidth field.

gridScale
```
public float gridScale()
```
Returns the value of the gridScale field.

transform
```
public HmdMatrix44 transform()
```
Returns a HmdMatrix44 view of the transform field.

size

public CompositorOverlaySettings size(int value)

Sets the specified value to the size field.

curved

public CompositorOverlaySettings curved(boolean value)

Sets the specified value to the curved field.

antialias

public CompositorOverlaySettings antialias(boolean value)

Sets the specified value to the antialias field.

scale

public CompositorOverlaySettings scale(float value)

Sets the specified value to the scale field.

distance

public CompositorOverlaySettings distance(float value)

Sets the specified value to the distance field.

alpha

public CompositorOverlaySettings alpha(float value)

Sets the specified value to the alpha field.

uOffset

public CompositorOverlaySettings uOffset(float value)

Sets the specified value to the uOffset field.

vOffset

public CompositorOverlaySettings vOffset(float value)

Sets the specified value to the vOffset field.

uScale

public CompositorOverlaySettings uScale(float value)

Sets the specified value to the uScale field.

vScale

public CompositorOverlaySettings vScale(float value)

Sets the specified value to the vScale field.

gridDivs

public CompositorOverlaySettings gridDivs(float value)

Sets the specified value to the gridDivs field.

gridWidth

public CompositorOverlaySettings gridWidth(float value)

Sets the specified value to the gridWidth field.

gridScale

public CompositorOverlaySettings gridScale(float value)

Sets the specified value to the gridScale field.

transform

public CompositorOverlaySettings transform(HmdMatrix44 value)

Copies the specified HmdMatrix44 to the transform field.

transform

public CompositorOverlaySettings transform(java.util.function.Consumer<HmdMatrix44> consumer)

Passes the transform field to the specified Consumer.

set

public CompositorOverlaySettings set(int size,
                                     boolean curved,
                                     boolean antialias,
                                     float scale,
                                     float distance,
                                     float alpha,
                                     float uOffset,
                                     float vOffset,
                                     float uScale,
                                     float vScale,
                                     float gridDivs,
                                     float gridWidth,
                                     float gridScale,
                                     HmdMatrix44 transform)

Initializes this struct with the specified values.

set
```
public CompositorOverlaySettings set(CompositorOverlaySettings src)
```
Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc
```
public static CompositorOverlaySettings malloc()
```
Returns a new CompositorOverlaySettings instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static CompositorOverlaySettings calloc()
```
Returns a new CompositorOverlaySettings instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static CompositorOverlaySettings create()
```
Returns a new CompositorOverlaySettings instance allocated with BufferUtils.

create
```
public static CompositorOverlaySettings create(long address)
```
Returns a new CompositorOverlaySettings instance for the specified memory address.

createSafe

@Nullable
public static CompositorOverlaySettings createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static CompositorOverlaySettings.Buffer malloc(int capacity)
```
Returns a new CompositorOverlaySettings.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static CompositorOverlaySettings.Buffer calloc(int capacity)
```
Returns a new CompositorOverlaySettings.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static CompositorOverlaySettings.Buffer create(int capacity)
```
Returns a new CompositorOverlaySettings.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a CompositorOverlaySettings.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack
```
public static CompositorOverlaySettings mallocStack()
```
Returns a new CompositorOverlaySettings instance allocated on the thread-local MemoryStack.

callocStack
```
public static CompositorOverlaySettings callocStack()
```
Returns a new CompositorOverlaySettings instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack
```
public static CompositorOverlaySettings mallocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new CompositorOverlaySettings instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack
```
public static CompositorOverlaySettings callocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new CompositorOverlaySettings instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

mallocStack
```
public static CompositorOverlaySettings.Buffer mallocStack(int capacity)
```
Returns a new CompositorOverlaySettings.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack
```
public static CompositorOverlaySettings.Buffer callocStack(int capacity)
```
Returns a new CompositorOverlaySettings.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack
```
public static CompositorOverlaySettings.Buffer mallocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
Returns a new CompositorOverlaySettings.Buffer instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

callocStack
```
public static CompositorOverlaySettings.Buffer callocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
Returns a new CompositorOverlaySettings.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsize

public static int nsize(long struct)

Unsafe version of size().

ncurved

public static boolean ncurved(long struct)

Unsafe version of curved().

nantialias

public static boolean nantialias(long struct)

Unsafe version of antialias().

nscale

public static float nscale(long struct)

Unsafe version of scale().

ndistance

public static float ndistance(long struct)

Unsafe version of distance().

nalpha

public static float nalpha(long struct)

Unsafe version of alpha().

nuOffset

public static float nuOffset(long struct)

Unsafe version of uOffset().

nvOffset

public static float nvOffset(long struct)

Unsafe version of vOffset().

nuScale

public static float nuScale(long struct)

Unsafe version of uScale().

nvScale

public static float nvScale(long struct)

Unsafe version of vScale().

ngridDivs

public static float ngridDivs(long struct)

Unsafe version of gridDivs().

ngridWidth

public static float ngridWidth(long struct)

Unsafe version of gridWidth().

ngridScale

public static float ngridScale(long struct)

Unsafe version of gridScale().

ntransform

public static HmdMatrix44 ntransform(long struct)

Unsafe version of transform().

nsize

public static void nsize(long struct,
                         int value)

Unsafe version of size.

ncurved

public static void ncurved(long struct,
                           boolean value)

Unsafe version of curved.

nantialias

public static void nantialias(long struct,
                              boolean value)

Unsafe version of antialias.

nscale

public static void nscale(long struct,
                          float value)

Unsafe version of scale.

ndistance

public static void ndistance(long struct,
                             float value)

Unsafe version of distance.

nalpha

public static void nalpha(long struct,
                          float value)

Unsafe version of alpha.

nuOffset

public static void nuOffset(long struct,
                            float value)

Unsafe version of uOffset.

nvOffset

public static void nvOffset(long struct,
                            float value)

Unsafe version of vOffset.

nuScale

public static void nuScale(long struct,
                           float value)

Unsafe version of uScale.

nvScale

public static void nvScale(long struct,
                           float value)

Unsafe version of vScale.

ngridDivs

public static void ngridDivs(long struct,
                             float value)

Unsafe version of gridDivs.

ngridWidth

public static void ngridWidth(long struct,
                              float value)

Unsafe version of gridWidth.

ngridScale

public static void ngridScale(long struct,
                              float value)

Unsafe version of gridScale.

ntransform

public static void ntransform(long struct,
                              HmdMatrix44 value)

Unsafe version of transform.

Class CompositorOverlaySettings

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

SIZE, CURVED, ANTIALIAS, SCALE, DISTANCE, ALPHA, UOFFSET, VOFFSET, USCALE, VSCALE, GRIDDIVS, GRIDWIDTH, GRIDSCALE, TRANSFORM

Constructor Detail

CompositorOverlaySettings

Method Detail

sizeof

size

curved

antialias

scale

distance

alpha

uOffset

vOffset

uScale

vScale

gridDivs

gridWidth

gridScale

transform

size

curved

antialias

scale

distance

alpha

uOffset

vOffset

uScale

vScale

gridDivs

gridWidth

gridScale

transform

transform

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsize

ncurved

nantialias

nscale

ndistance

nalpha

nuOffset

nvOffset

nuScale

nvScale