Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrColor4f

extends Struct<XrColor4f>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Color Vector.
Description

Unless otherwise specified, colors are encoded as linear (not with sRGB nor other gamma compression) values with individual components being in the range of 0.0 through 1.0, and without the RGB components being premultiplied by the alpha component.

If color encoding is specified as being premultiplied by the alpha component, the RGB components are set to zero if the alpha component is zero.

See Also

XrCompositionLayerColorScaleBiasKHR, XrPassthroughColorMapMonoToRgbaFB, XrPassthroughStyleFB, XrSwapchainStateSamplerOpenGLESFB, XrSwapchainStateSamplerVulkanFB

Layout


struct XrColor4f {
    float r;
    float g;
    float b;
    float a;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrColor4f.Buffer

An array of XrColor4f structs.

Field Summary

Modifier and TypeField and Description
public static final int
A

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
B

The struct member offsets.

public static final int
G

The struct member offsets.

public static final int
R

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
XrColor4f(long address, ByteBuffer container)

public
XrColor4f(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public float
a()

the alpha component of the color.

public XrColor4f
a(float value)

Sets the specified value to the a field.

public float
b()

the blue component of the color.

public XrColor4f
b(float value)

Sets the specified value to the b field.

public static XrColor4f
calloc()

Returns a new XrColor4f instance allocated with memCalloc.

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

Returns a new XrColor4f.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrColor4f
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 XrColor4f
create()

Returns a new XrColor4f instance allocated with BufferUtils.

public static XrColor4f
create(long address)

Returns a new XrColor4f instance for the specified memory address.

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

Returns a new XrColor4f.Buffer instance allocated with BufferUtils.

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

Create a XrColor4f.Buffer instance at the specified memory.

public static XrColor4f
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public float
g()

the green component of the color.

public XrColor4f
g(float value)

Sets the specified value to the g field.

public static XrColor4f
malloc()

Returns a new XrColor4f instance allocated with memAlloc.

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

Returns a new XrColor4f.Buffer instance allocated with memAlloc.

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

Returns a new XrColor4f instance allocated on the specified MemoryStack.

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

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

public static float
na(long struct)

Unsafe version of a.

public static void
na(long struct, float value)

Unsafe version of a.

public static float
nb(long struct)

Unsafe version of b.

public static void
nb(long struct, float value)

Unsafe version of b.

public static float
ng(long struct)

Unsafe version of g.

public static void
ng(long struct, float value)

Unsafe version of g.

public static float
nr(long struct)

Unsafe version of r.

public static void
nr(long struct, float value)

Unsafe version of r.

public float
r()

the red component of the color.

public XrColor4f
r(float value)

Sets the specified value to the r field.

public XrColor4f
set(float r, float g, float b, float a)

Initializes this struct with the specified values.

public XrColor4f

Returns:

this struct
set
(XrColor4f
the source struct
src
)

Copies the specified struct data to this struct.

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

Aback to summary
public static final int A

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

Bback to summary
public static final int B

The struct member offsets.

Gback to summary
public static final int G

The struct member offsets.

Rback to summary
public static final int R

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrColor4fback to summary
protected XrColor4f(long address, ByteBuffer container)
XrColor4fback to summary
public XrColor4f(ByteBuffer container)

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

aback to summary
public float a()

the alpha component of the color.

aback to summary
public XrColor4f a(float value)

Sets the specified value to the a field.

bback to summary
public float b()

the blue component of the color.

bback to summary
public XrColor4f b(float value)

Sets the specified value to the b field.

callocback to summary
public static XrColor4f calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrColor4f calloc(MemoryStack stack)

Returns a new XrColor4f 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 XrColor4f.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrColor4f.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 XrColor4f 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 XrColor4f create()

Returns a new XrColor4f instance allocated with BufferUtils.

createback to summary
public static XrColor4f create(long address)

Returns a new XrColor4f instance for the specified memory address.

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

Returns a new XrColor4f.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrColor4f.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrColor4f createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
gback to summary
public float g()

the green component of the color.

gback to summary
public XrColor4f g(float value)

Sets the specified value to the g field.

mallocback to summary
public static XrColor4f malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrColor4f malloc(MemoryStack stack)

Returns a new XrColor4f instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

naback to summary
public static float na(long struct)

Unsafe version of a.

naback to summary
public static void na(long struct, float value)

Unsafe version of a.

nbback to summary
public static float nb(long struct)

Unsafe version of b.

nbback to summary
public static void nb(long struct, float value)

Unsafe version of b.

ngback to summary
public static float ng(long struct)

Unsafe version of g.

ngback to summary
public static void ng(long struct, float value)

Unsafe version of g.

nrback to summary
public static float nr(long struct)

Unsafe version of r.

nrback to summary
public static void nr(long struct, float value)

Unsafe version of r.

rback to summary
public float r()

the red component of the color.

rback to summary
public XrColor4f r(float value)

Sets the specified value to the r field.

setback to summary
public XrColor4f set(float r, float g, float b, float a)

Initializes this struct with the specified values.

setback to summary
public XrColor4f set(XrColor4f src)

Copies the specified struct data to this struct.

Parameters
src:XrColor4f

the source struct

Returns:XrColor4f

this struct

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.openxr back to summary

public Class XrColor4f.Buffer

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

An array of XrColor4f structs.

Field Summary

Modifier and TypeField and Description
private static final XrColor4f

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrColor4f.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
public float

Returns:

the value of the XrColor4f#a field.
a
()

public XrColor4f.Buffer
a(float value)

Sets the specified value to the XrColor4f#a field.

public float

Returns:

the value of the XrColor4f#b field.
b
()

public XrColor4f.Buffer
b(float value)

Sets the specified value to the XrColor4f#b field.

public float

Returns:

the value of the XrColor4f#g field.
g
()

public XrColor4f.Buffer
g(float value)

Sets the specified value to the XrColor4f#g field.

protected XrColor4f
public float

Returns:

the value of the XrColor4f#r field.
r
()

public XrColor4f.Buffer
r(float value)

Sets the specified value to the XrColor4f#r field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrColor4f ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrColor4f.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 XrColor4f#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

aback to summary
public float a()
Returns:float

the value of the XrColor4f#a field.

aback to summary
public XrColor4f.Buffer a(float value)

Sets the specified value to the XrColor4f#a field.

bback to summary
public float b()
Returns:float

the value of the XrColor4f#b field.

bback to summary
public XrColor4f.Buffer b(float value)

Sets the specified value to the XrColor4f#b field.

gback to summary
public float g()
Returns:float

the value of the XrColor4f#g field.

gback to summary
public XrColor4f.Buffer g(float value)

Sets the specified value to the XrColor4f#g field.

getElementFactoryback to summary
protected XrColor4f getElementFactory()

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

Annotations
@Override
rback to summary
public float r()
Returns:float

the value of the XrColor4f#r field.

rback to summary
public XrColor4f.Buffer r(float value)

Sets the specified value to the XrColor4f#r field.

selfback to summary
protected XrColor4f.Buffer self()

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

Annotations
@Override