Top Description Inners Fields Constructors Methods
org.lwjgl.openvr

public Class CompositorStageRenderSettings

extends Struct<CompositorStageRenderSettings>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct Compositor_StageRenderSettings
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct Compositor_StageRenderSettings {
    HmdColor_t m_PrimaryColor;
    HmdColor_t m_SecondaryColor;
    float m_flVignetteInnerRadius;
    float m_flVignetteOuterRadius;
    float m_flFresnelStrength;
    bool m_bBackfaceCulling;
    bool m_bGreyscale;
    bool m_bWireframe;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
M_BBACKFACECULLING

The struct member offsets.

public static final int
M_BGREYSCALE

The struct member offsets.

public static final int
M_BWIREFRAME

The struct member offsets.

public static final int
M_FLFRESNELSTRENGTH

The struct member offsets.

public static final int
M_FLVIGNETTEINNERRADIUS

The struct member offsets.

public static final int
M_FLVIGNETTEOUTERRADIUS

The struct member offsets.

public static final int
M_PRIMARYCOLOR

The struct member offsets.

public static final int
M_SECONDARYCOLOR

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
CompositorStageRenderSettings(long address, ByteBuffer container)

public
CompositorStageRenderSettings(ByteBuffer container)

Creates a CompositorStageRenderSettings instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static CompositorStageRenderSettings
calloc()

Returns a new CompositorStageRenderSettings instance allocated with memCalloc.

public static CompositorStageRenderSettings.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new CompositorStageRenderSettings.Buffer instance allocated with memCalloc.

public static CompositorStageRenderSettings
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static CompositorStageRenderSettings.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected CompositorStageRenderSettings
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static CompositorStageRenderSettings
create()

Returns a new CompositorStageRenderSettings instance allocated with BufferUtils.

public static CompositorStageRenderSettings
create(long address)

Returns a new CompositorStageRenderSettings instance for the specified memory address.

public static CompositorStageRenderSettings.Buffer
create(int
the buffer capacity
capacity
)

Returns a new CompositorStageRenderSettings.Buffer instance allocated with BufferUtils.

public static CompositorStageRenderSettings.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a CompositorStageRenderSettings.Buffer instance at the specified memory.

public static CompositorStageRenderSettings
createSafe(long address)

Like create, but returns null if address is NULL.

public static CompositorStageRenderSettings.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public boolean
m_bBackfaceCulling()

Controls backface culling.

public boolean
m_bGreyscale()

Converts the render model's texture to luma and applies to rgb equally.

public boolean
m_bWireframe()

Renders mesh as a wireframe.

public float
m_flFresnelStrength()

Fades to the secondary color based on view incidence.

public float
m_flVignetteInnerRadius()

Vignette radius is in meters and is used to fade to the specified secondary solid color over that 3D distance from the origin of the playspace.

public float

Returns:

the value of the m_flVignetteOuterRadius field.
m_flVignetteOuterRadius
()

public HmdColor
m_PrimaryColor()

Primary color is applied as a tint to (i.e. multiplied with) the model's texture.

public HmdColor

Returns:

a HmdColor view of the m_SecondaryColor field.
m_SecondaryColor
()

public static CompositorStageRenderSettings
malloc()

Returns a new CompositorStageRenderSettings instance allocated with memAlloc.

public static CompositorStageRenderSettings.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new CompositorStageRenderSettings.Buffer instance allocated with memAlloc.

public static CompositorStageRenderSettings
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new CompositorStageRenderSettings instance allocated on the specified MemoryStack.

public static CompositorStageRenderSettings.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static boolean
nm_bBackfaceCulling(long struct)

Unsafe version of m_bBackfaceCulling.

public static boolean
nm_bGreyscale(long struct)

Unsafe version of m_bGreyscale.

public static boolean
nm_bWireframe(long struct)

Unsafe version of m_bWireframe.

public static float
nm_flFresnelStrength(long struct)

Unsafe version of m_flFresnelStrength.

public static float
nm_flVignetteInnerRadius(long struct)

Unsafe version of m_flVignetteInnerRadius.

public static float
nm_flVignetteOuterRadius(long struct)

Unsafe version of m_flVignetteOuterRadius.

public static HmdColor
nm_PrimaryColor(long struct)

Unsafe version of m_PrimaryColor.

public static HmdColor
nm_SecondaryColor(long struct)

Unsafe version of m_SecondaryColor.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

M_BBACKFACECULLINGback to summary
public static final int M_BBACKFACECULLING

The struct member offsets.

M_BGREYSCALEback to summary
public static final int M_BGREYSCALE

The struct member offsets.

M_BWIREFRAMEback to summary
public static final int M_BWIREFRAME

The struct member offsets.

M_FLFRESNELSTRENGTHback to summary
public static final int M_FLFRESNELSTRENGTH

The struct member offsets.

M_FLVIGNETTEINNERRADIUSback to summary
public static final int M_FLVIGNETTEINNERRADIUS

The struct member offsets.

M_FLVIGNETTEOUTERRADIUSback to summary
public static final int M_FLVIGNETTEOUTERRADIUS

The struct member offsets.

M_PRIMARYCOLORback to summary
public static final int M_PRIMARYCOLOR

The struct member offsets.

M_SECONDARYCOLORback to summary
public static final int M_SECONDARYCOLOR

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CompositorStageRenderSettingsback to summary
protected CompositorStageRenderSettings(long address, ByteBuffer container)
CompositorStageRenderSettingsback to summary
public CompositorStageRenderSettings(ByteBuffer container)

Creates a CompositorStageRenderSettings 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

callocback to summary
public static CompositorStageRenderSettings calloc()

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

callocback to summary
public static CompositorStageRenderSettings.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CompositorStageRenderSettings calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static CompositorStageRenderSettings.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected CompositorStageRenderSettings create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static CompositorStageRenderSettings create()

Returns a new CompositorStageRenderSettings instance allocated with BufferUtils.

createback to summary
public static CompositorStageRenderSettings create(long address)

Returns a new CompositorStageRenderSettings instance for the specified memory address.

createback to summary
public static CompositorStageRenderSettings.Buffer create(int capacity)

Returns a new CompositorStageRenderSettings.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static CompositorStageRenderSettings.Buffer create(long address, int capacity)

Create a CompositorStageRenderSettings.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CompositorStageRenderSettings createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static CompositorStageRenderSettings.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
m_bBackfaceCullingback to summary
public boolean m_bBackfaceCulling()

Controls backface culling.

Annotations
@NativeType:bool
m_bGreyscaleback to summary
public boolean m_bGreyscale()

Converts the render model's texture to luma and applies to rgb equally.

This is useful to combat compression artifacts that can occur on desaturated source material.

Annotations
@NativeType:bool
m_bWireframeback to summary
public boolean m_bWireframe()

Renders mesh as a wireframe.

Annotations
@NativeType:bool
m_flFresnelStrengthback to summary
public float m_flFresnelStrength()

Fades to the secondary color based on view incidence.

This variable controls the linearity of the effect. It is mutually exclusive with vignette. Additionally, it treats the mesh as faceted.

m_flVignetteInnerRadiusback to summary
public float m_flVignetteInnerRadius()

Vignette radius is in meters and is used to fade to the specified secondary solid color over that 3D distance from the origin of the playspace.

m_flVignetteOuterRadiusback to summary
public float m_flVignetteOuterRadius()
Returns:float

the value of the m_flVignetteOuterRadius field.

m_PrimaryColorback to summary
public HmdColor m_PrimaryColor()

Primary color is applied as a tint to (i.e. multiplied with) the model's texture.

Annotations
@NativeType:HmdColor_t
m_SecondaryColorback to summary
public HmdColor m_SecondaryColor()
Returns:HmdColor

a HmdColor view of the m_SecondaryColor field.

Annotations
@NativeType:HmdColor_t
mallocback to summary
public static CompositorStageRenderSettings malloc()

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

mallocback to summary
public static CompositorStageRenderSettings.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CompositorStageRenderSettings malloc(MemoryStack stack)

Returns a new CompositorStageRenderSettings instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static CompositorStageRenderSettings.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nm_bBackfaceCullingback to summary
public static boolean nm_bBackfaceCulling(long struct)

Unsafe version of m_bBackfaceCulling.

nm_bGreyscaleback to summary
public static boolean nm_bGreyscale(long struct)

Unsafe version of m_bGreyscale.

nm_bWireframeback to summary
public static boolean nm_bWireframe(long struct)

Unsafe version of m_bWireframe.

nm_flFresnelStrengthback to summary
public static float nm_flFresnelStrength(long struct)

Unsafe version of m_flFresnelStrength.

nm_flVignetteInnerRadiusback to summary
public static float nm_flVignetteInnerRadius(long struct)

Unsafe version of m_flVignetteInnerRadius.

nm_flVignetteOuterRadiusback to summary
public static float nm_flVignetteOuterRadius(long struct)

Unsafe version of m_flVignetteOuterRadius.

nm_PrimaryColorback to summary
public static HmdColor nm_PrimaryColor(long struct)

Unsafe version of m_PrimaryColor.

nm_SecondaryColorback to summary
public static HmdColor nm_SecondaryColor(long struct)

Unsafe version of m_SecondaryColor.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.openvr back to summary

public Class CompositorStageRenderSettings.Buffer

extends StructBuffer<CompositorStageRenderSettings, CompositorStageRenderSettings.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CompositorStageRenderSettings structs.

Field Summary

Modifier and TypeField and Description
private static final CompositorStageRenderSettings

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CompositorStageRenderSettings.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected CompositorStageRenderSettings
public boolean
public boolean

Returns:

the value of the CompositorStageRenderSettings#m_bGreyscale field.
m_bGreyscale
()

public boolean

Returns:

the value of the CompositorStageRenderSettings#m_bWireframe field.
m_bWireframe
()

public float
public float
public float

Returns:

the value of the m_flVignetteOuterRadius field.
m_flVignetteOuterRadius
()

public HmdColor
public HmdColor

Returns:

a HmdColor view of the m_SecondaryColor field.
m_SecondaryColor
()

protected CompositorStageRenderSettings.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CompositorStageRenderSettings ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CompositorStageRenderSettings.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by CompositorStageRenderSettings#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected CompositorStageRenderSettings getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
m_bBackfaceCullingback to summary
public boolean m_bBackfaceCulling()
Returns:boolean

the value of the CompositorStageRenderSettings#m_bBackfaceCulling field.

Annotations
@NativeType:bool
m_bGreyscaleback to summary
public boolean m_bGreyscale()
Returns:boolean

the value of the CompositorStageRenderSettings#m_bGreyscale field.

Annotations
@NativeType:bool
m_bWireframeback to summary
public boolean m_bWireframe()
Returns:boolean

the value of the CompositorStageRenderSettings#m_bWireframe field.

Annotations
@NativeType:bool
m_flFresnelStrengthback to summary
public float m_flFresnelStrength()
Returns:float

the value of the CompositorStageRenderSettings#m_flFresnelStrength field.

m_flVignetteInnerRadiusback to summary
public float m_flVignetteInnerRadius()
Returns:float

the value of the CompositorStageRenderSettings#m_flVignetteInnerRadius field.

m_flVignetteOuterRadiusback to summary
public float m_flVignetteOuterRadius()
Returns:float

the value of the m_flVignetteOuterRadius field.

m_PrimaryColorback to summary
public HmdColor m_PrimaryColor()
Returns:HmdColor

a HmdColor view of the CompositorStageRenderSettings#m_PrimaryColor field.

Annotations
@NativeType:HmdColor_t
m_SecondaryColorback to summary
public HmdColor m_SecondaryColor()
Returns:HmdColor

a HmdColor view of the m_SecondaryColor field.

Annotations
@NativeType:HmdColor_t
selfback to summary
protected CompositorStageRenderSettings.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override