Top Description Inners Fields Constructors Methods
org.lwjgl.util.spvc

public Class SpvcHlslRootConstants

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

Specifying a root constant (d3d12) or push constant range (vulkan).

start and end denotes the range of the root constant in bytes. Both values need to be multiple of 4.

Layout


struct spvc_hlsl_root_constants {
    unsigned int start;
    unsigned int end;
    unsigned int binding;
    unsigned int space;
}

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
BINDING

The struct member offsets.

public static final int
END

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPACE

The struct member offsets.

public static final int
START

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
SpvcHlslRootConstants(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the binding field.
binding
()

public SpvcHlslRootConstants
binding(int value)

Sets the specified value to the binding field.

public static SpvcHlslRootConstants
calloc()

Returns a new SpvcHlslRootConstants instance allocated with memCalloc.

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

Returns a new SpvcHlslRootConstants.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new SpvcHlslRootConstants instance allocated with BufferUtils.

public static SpvcHlslRootConstants
create(long address)

Returns a new SpvcHlslRootConstants instance for the specified memory address.

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

Returns a new SpvcHlslRootConstants.Buffer instance allocated with BufferUtils.

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

Create a SpvcHlslRootConstants.Buffer instance at the specified memory.

public static SpvcHlslRootConstants
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the end field.
end
()

public SpvcHlslRootConstants
end(int value)

Sets the specified value to the end field.

public static SpvcHlslRootConstants
malloc()

Returns a new SpvcHlslRootConstants instance allocated with memAlloc.

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

Returns a new SpvcHlslRootConstants.Buffer instance allocated with memAlloc.

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

Returns a new SpvcHlslRootConstants instance allocated on the specified MemoryStack.

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

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

public static int
nbinding(long struct)

Unsafe version of binding.

public static void
nbinding(long struct, int value)

Unsafe version of binding.

public static int
nend(long struct)

Unsafe version of end.

public static void
nend(long struct, int value)

Unsafe version of end.

public static int
nspace(long struct)

Unsafe version of space.

public static void
nspace(long struct, int value)

Unsafe version of space.

public static int
nstart(long struct)

Unsafe version of start.

public static void
nstart(long struct, int value)

Unsafe version of start.

public SpvcHlslRootConstants
set(int start, int end, int binding, int space)

Initializes this struct with the specified values.

public SpvcHlslRootConstants

Returns:

this struct
set
(SpvcHlslRootConstants
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).
public int

Returns:

the value of the space field.
space
()

public SpvcHlslRootConstants
space(int value)

Sets the specified value to the space field.

public int

Returns:

the value of the start field.
start
()

public SpvcHlslRootConstants
start(int value)

Sets the specified value to the start field.

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.

BINDINGback to summary
public static final int BINDING

The struct member offsets.

ENDback to summary
public static final int END

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SPACEback to summary
public static final int SPACE

The struct member offsets.

STARTback to summary
public static final int START

The struct member offsets.

Constructor Detail

SpvcHlslRootConstantsback to summary
protected SpvcHlslRootConstants(long address, ByteBuffer container)
SpvcHlslRootConstantsback to summary
public SpvcHlslRootConstants(ByteBuffer container)

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

bindingback to summary
public int binding()
Returns:int

the value of the binding field.

Annotations
@NativeType:unsigned int
bindingback to summary
public SpvcHlslRootConstants binding(int value)

Sets the specified value to the binding field.

callocback to summary
public static SpvcHlslRootConstants calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static SpvcHlslRootConstants calloc(MemoryStack stack)

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

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

Returns a new SpvcHlslRootConstants instance allocated with BufferUtils.

createback to summary
public static SpvcHlslRootConstants create(long address)

Returns a new SpvcHlslRootConstants instance for the specified memory address.

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

Returns a new SpvcHlslRootConstants.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a SpvcHlslRootConstants.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static SpvcHlslRootConstants createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
endback to summary
public int end()
Returns:int

the value of the end field.

Annotations
@NativeType:unsigned int
endback to summary
public SpvcHlslRootConstants end(int value)

Sets the specified value to the end field.

mallocback to summary
public static SpvcHlslRootConstants malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static SpvcHlslRootConstants malloc(MemoryStack stack)

Returns a new SpvcHlslRootConstants instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbindingback to summary
public static int nbinding(long struct)

Unsafe version of binding.

nbindingback to summary
public static void nbinding(long struct, int value)

Unsafe version of binding.

nendback to summary
public static int nend(long struct)

Unsafe version of end.

nendback to summary
public static void nend(long struct, int value)

Unsafe version of end.

nspaceback to summary
public static int nspace(long struct)

Unsafe version of space.

nspaceback to summary
public static void nspace(long struct, int value)

Unsafe version of space.

nstartback to summary
public static int nstart(long struct)

Unsafe version of start.

nstartback to summary
public static void nstart(long struct, int value)

Unsafe version of start.

setback to summary
public SpvcHlslRootConstants set(int start, int end, int binding, int space)

Initializes this struct with the specified values.

setback to summary
public SpvcHlslRootConstants set(SpvcHlslRootConstants src)

Copies the specified struct data to this struct.

Parameters
src:SpvcHlslRootConstants

the source struct

Returns:SpvcHlslRootConstants

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
spaceback to summary
public int space()
Returns:int

the value of the space field.

Annotations
@NativeType:unsigned int
spaceback to summary
public SpvcHlslRootConstants space(int value)

Sets the specified value to the space field.

startback to summary
public int start()
Returns:int

the value of the start field.

Annotations
@NativeType:unsigned int
startback to summary
public SpvcHlslRootConstants start(int value)

Sets the specified value to the start field.

org.lwjgl.util.spvc back to summary

public Class SpvcHlslRootConstants.Buffer

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

An array of SpvcHlslRootConstants structs.

Field Summary

Modifier and TypeField and Description
private static final SpvcHlslRootConstants

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new SpvcHlslRootConstants.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 int

Returns:

the value of the binding field.
binding
()

public SpvcHlslRootConstants.Buffer
binding(int value)

Sets the specified value to the binding field.

public int

Returns:

the value of the end field.
end
()

public SpvcHlslRootConstants.Buffer
end(int value)

Sets the specified value to the end field.

protected SpvcHlslRootConstants
protected SpvcHlslRootConstants.Buffer
public int

Returns:

the value of the space field.
space
()

public SpvcHlslRootConstants.Buffer
space(int value)

Sets the specified value to the space field.

public int

Returns:

the value of the start field.
start
()

public SpvcHlslRootConstants.Buffer
start(int value)

Sets the specified value to the start field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final SpvcHlslRootConstants ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

bindingback to summary
public int binding()
Returns:int

the value of the binding field.

Annotations
@NativeType:unsigned int
bindingback to summary
public SpvcHlslRootConstants.Buffer binding(int value)

Sets the specified value to the binding field.

endback to summary
public int end()
Returns:int

the value of the end field.

Annotations
@NativeType:unsigned int
endback to summary
public SpvcHlslRootConstants.Buffer end(int value)

Sets the specified value to the end field.

getElementFactoryback to summary
protected SpvcHlslRootConstants getElementFactory()

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

Annotations
@Override
selfback to summary
protected SpvcHlslRootConstants.Buffer self()

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

Annotations
@Override
spaceback to summary
public int space()
Returns:int

the value of the space field.

Annotations
@NativeType:unsigned int
spaceback to summary
public SpvcHlslRootConstants.Buffer space(int value)

Sets the specified value to the space field.

startback to summary
public int start()
Returns:int

the value of the start field.

Annotations
@NativeType:unsigned int
startback to summary
public SpvcHlslRootConstants.Buffer start(int value)

Sets the specified value to the start field.