Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPushConstantRange

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

Structure specifying a push constant range.
Valid Usage
Valid Usage (Implicit)
See Also

VkPipelineLayoutCreateInfo, VkShaderCreateInfoEXT

Layout


struct VkPushConstantRange {
    VkShaderStageFlags stageFlags;
    uint32_t offset;
    uint32_t size;
}

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
OFFSET

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STAGEFLAGS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkPushConstantRange(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPushConstantRange
calloc()

Returns a new VkPushConstantRange instance allocated with memCalloc.

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

Returns a new VkPushConstantRange.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPushConstantRange
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPushConstantRange
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPushConstantRange.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPushConstantRange.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkPushConstantRange
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 VkPushConstantRange
create()

Returns a new VkPushConstantRange instance allocated with BufferUtils.

public static VkPushConstantRange
create(long address)

Returns a new VkPushConstantRange instance for the specified memory address.

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

Returns a new VkPushConstantRange.Buffer instance allocated with BufferUtils.

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

Create a VkPushConstantRange.Buffer instance at the specified memory.

public static VkPushConstantRange
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPushConstantRange
malloc()

Returns a new VkPushConstantRange instance allocated with memAlloc.

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

Returns a new VkPushConstantRange.Buffer instance allocated with memAlloc.

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

Returns a new VkPushConstantRange instance allocated on the specified MemoryStack.

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

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

public static VkPushConstantRange
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPushConstantRange
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPushConstantRange.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPushConstantRange.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, int value)

Unsafe version of offset.

public static int
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, int value)

Unsafe version of size.

public static int
nstageFlags(long struct)

Unsafe version of stageFlags.

public static void
nstageFlags(long struct, int value)

Unsafe version of stageFlags.

public int
offset()

offset and size are the start offset and size, respectively, consumed by the range.

public VkPushConstantRange
offset(int value)

Sets the specified value to the offset field.

public VkPushConstantRange
set(int stageFlags, int offset, int size)

Initializes this struct with the specified values.

public VkPushConstantRange

Returns:

this struct
set
(VkPushConstantRange
the source struct
src
)

Copies the specified struct data to this struct.

public int
size()

see offset

public VkPushConstantRange
size(int value)

Sets the specified value to the size field.

public int
sizeof()

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

Returns sizeof(struct).
public int
stageFlags()

a set of stage flags describing the shader stages that will access a range of push constants.

public VkPushConstantRange
stageFlags(int value)

Sets the specified value to the stageFlags 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.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STAGEFLAGSback to summary
public static final int STAGEFLAGS

The struct member offsets.

Constructor Detail

VkPushConstantRangeback to summary
protected VkPushConstantRange(long address, ByteBuffer container)
VkPushConstantRangeback to summary
public VkPushConstantRange(ByteBuffer container)

Creates a VkPushConstantRange 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 VkPushConstantRange calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPushConstantRange calloc(MemoryStack stack)

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

Returns a new VkPushConstantRange.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

callocStackback to summary
public static VkPushConstantRange callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPushConstantRange callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPushConstantRange.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPushConstantRange.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkPushConstantRange 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 VkPushConstantRange create()

Returns a new VkPushConstantRange instance allocated with BufferUtils.

createback to summary
public static VkPushConstantRange create(long address)

Returns a new VkPushConstantRange instance for the specified memory address.

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

Returns a new VkPushConstantRange.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPushConstantRange.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPushConstantRange createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkPushConstantRange malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPushConstantRange malloc(MemoryStack stack)

Returns a new VkPushConstantRange instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkPushConstantRange mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkPushConstantRange mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkPushConstantRange.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkPushConstantRange.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
noffsetback to summary
public static int noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, int value)

Unsafe version of offset.

nsizeback to summary
public static int nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, int value)

Unsafe version of size.

nstageFlagsback to summary
public static int nstageFlags(long struct)

Unsafe version of stageFlags.

nstageFlagsback to summary
public static void nstageFlags(long struct, int value)

Unsafe version of stageFlags.

offsetback to summary
public int offset()

offset and size are the start offset and size, respectively, consumed by the range. Both offset and size are in units of bytes and must be a multiple of 4. The layout of the push constant variables is specified in the shader.

Annotations
@NativeType:uint32_t
offsetback to summary
public VkPushConstantRange offset(int value)

Sets the specified value to the offset field.

setback to summary
public VkPushConstantRange set(int stageFlags, int offset, int size)

Initializes this struct with the specified values.

setback to summary
public VkPushConstantRange set(VkPushConstantRange src)

Copies the specified struct data to this struct.

Parameters
src:VkPushConstantRange

the source struct

Returns:VkPushConstantRange

this struct

sizeback to summary
public int size()

see offset

Annotations
@NativeType:uint32_t
sizeback to summary
public VkPushConstantRange size(int value)

Sets the specified value to the size field.

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
stageFlagsback to summary
public int stageFlags()

a set of stage flags describing the shader stages that will access a range of push constants. If a particular stage is not included in the range, then accessing members of that range of push constants from the corresponding shader stage will return undefined values.

Annotations
@NativeType:VkShaderStageFlags
stageFlagsback to summary
public VkPushConstantRange stageFlags(int value)

Sets the specified value to the stageFlags field.

org.lwjgl.vulkan back to summary

public Class VkPushConstantRange.Buffer

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

An array of VkPushConstantRange structs.

Field Summary

Modifier and TypeField and Description
private static final VkPushConstantRange

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkPushConstantRange#offset field.
offset
()

public VkPushConstantRange.Buffer
offset(int value)

Sets the specified value to the VkPushConstantRange#offset field.

protected VkPushConstantRange.Buffer
public int

Returns:

the value of the VkPushConstantRange#size field.
size
()

public VkPushConstantRange.Buffer
size(int value)

Sets the specified value to the VkPushConstantRange#size field.

public int

Returns:

the value of the VkPushConstantRange#stageFlags field.
stageFlags
()

public VkPushConstantRange.Buffer
stageFlags(int value)

Sets the specified value to the VkPushConstantRange#stageFlags field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPushConstantRange ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPushConstantRange.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 VkPushConstantRange#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 VkPushConstantRange getElementFactory()

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

Annotations
@Override
offsetback to summary
public int offset()
Returns:int

the value of the VkPushConstantRange#offset field.

Annotations
@NativeType:uint32_t
offsetback to summary
public VkPushConstantRange.Buffer offset(int value)

Sets the specified value to the VkPushConstantRange#offset field.

selfback to summary
protected VkPushConstantRange.Buffer self()

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

Annotations
@Override
sizeback to summary
public int size()
Returns:int

the value of the VkPushConstantRange#size field.

Annotations
@NativeType:uint32_t
sizeback to summary
public VkPushConstantRange.Buffer size(int value)

Sets the specified value to the VkPushConstantRange#size field.

stageFlagsback to summary
public int stageFlags()
Returns:int

the value of the VkPushConstantRange#stageFlags field.

Annotations
@NativeType:VkShaderStageFlags
stageFlagsback to summary
public VkPushConstantRange.Buffer stageFlags(int value)

Sets the specified value to the VkPushConstantRange#stageFlags field.