VkPushConstantRange (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkPushConstantRange

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPushConstantRange
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a push constant range.
Valid Usage
- offset must be less than VkPhysicalDeviceLimits::maxPushConstantsSize
- offset must be a multiple of 4
- size must be greater than 0
- size must be a multiple of 4
- size must be less than or equal to VkPhysicalDeviceLimits::maxPushConstantsSize minus offset
Valid Usage (Implicit)
- stageFlags must be a valid combination of VkShaderStageFlagBits values
- stageFlags must not be 0
See Also

VkPipelineLayoutCreateInfo

Member documentation
- 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.
- 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.
- size – see offset
Layout
```
 struct VkPushConstantRange {
     VkShaderStageFlags stageFlags;
     uint32_t offset;
     uint32_t size;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPushConstantRange.Buffer` An array of `VkPushConstantRange` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`OFFSET` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STAGEFLAGS` 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 and Description
`VkPushConstantRange(java.nio.ByteBuffer container)` Creates a `VkPushConstantRange` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPushConstantRange`	`calloc()` Returns a new `VkPushConstantRange` instance allocated with `memCalloc`.
`static VkPushConstantRange.Buffer`	`calloc(int capacity)` Returns a new `VkPushConstantRange.Buffer` instance allocated with `memCalloc`.
`static VkPushConstantRange`	`callocStack()` Returns a new `VkPushConstantRange` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPushConstantRange.Buffer`	`callocStack(int capacity)` Returns a new `VkPushConstantRange.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPushConstantRange.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPushConstantRange.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPushConstantRange`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPushConstantRange` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPushConstantRange`	`create()` Returns a new `VkPushConstantRange` instance allocated with `BufferUtils`.
`static VkPushConstantRange.Buffer`	`create(int capacity)` Returns a new `VkPushConstantRange.Buffer` instance allocated with `BufferUtils`.
`static VkPushConstantRange`	`create(long address)` Returns a new `VkPushConstantRange` instance for the specified memory address.
`static VkPushConstantRange.Buffer`	`create(long address, int capacity)` Create a `VkPushConstantRange.Buffer` instance at the specified memory.
`static VkPushConstantRange`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPushConstantRange.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPushConstantRange`	`malloc()` Returns a new `VkPushConstantRange` instance allocated with `memAlloc`.
`static VkPushConstantRange.Buffer`	`malloc(int capacity)` Returns a new `VkPushConstantRange.Buffer` instance allocated with `memAlloc`.
`static VkPushConstantRange`	`mallocStack()` Returns a new `VkPushConstantRange` instance allocated on the thread-local `MemoryStack`.
`static VkPushConstantRange.Buffer`	`mallocStack(int capacity)` Returns a new `VkPushConstantRange.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPushConstantRange.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPushConstantRange.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPushConstantRange`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPushConstantRange` instance allocated on the specified `MemoryStack`.
`static int`	`noffset(long struct)` Unsafe version of `offset()`.
`static void`	`noffset(long struct, int value)` Unsafe version of `offset`.
`static int`	`nsize(long struct)` Unsafe version of `size()`.
`static void`	`nsize(long struct, int value)` Unsafe version of `size`.
`static int`	`nstageFlags(long struct)` Unsafe version of `stageFlags()`.
`static void`	`nstageFlags(long struct, int value)` Unsafe version of `stageFlags`.
`int`	`offset()` Returns the value of the `offset` field.
`VkPushConstantRange`	`offset(int value)` Sets the specified value to the `offset` field.
`VkPushConstantRange`	`set(int stageFlags, int offset, int size)` Initializes this struct with the specified values.
`VkPushConstantRange`	`set(VkPushConstantRange src)` Copies the specified struct data to this struct.
`int`	`size()` Returns the value of the `size` field.
`VkPushConstantRange`	`size(int value)` Sets the specified value to the `size` field.
`int`	`sizeof()`
`int`	`stageFlags()` Returns the value of the `stageFlags` field.
`VkPushConstantRange`	`stageFlags(int value)` Sets the specified value to the `stageFlags` field.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STAGEFLAGS
```
public static final int STAGEFLAGS
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
- Constructor Detail
  - VkPushConstantRange
```
public VkPushConstantRange(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - stageFlags
```
public int stageFlags()
```
    Returns the value of the stageFlags field.
  - offset
```
public int offset()
```
    Returns the value of the offset field.
  - size
```
public int size()
```
    Returns the value of the size field.
  - stageFlags
```
public VkPushConstantRange stageFlags(int value)
```
    Sets the specified value to the stageFlags field.
  - offset
```
public VkPushConstantRange offset(int value)
```
    Sets the specified value to the offset field.
  - size
```
public VkPushConstantRange size(int value)
```
    Sets the specified value to the size field.
  - set
```
public VkPushConstantRange set(int stageFlags,
                               int offset,
                               int size)
```
    Initializes this struct with the specified values.
  - set
```
public VkPushConstantRange set(VkPushConstantRange src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPushConstantRange malloc()
```
    Returns a new VkPushConstantRange instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPushConstantRange calloc()
```
    Returns a new VkPushConstantRange instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPushConstantRange create()
```
    Returns a new VkPushConstantRange instance allocated with BufferUtils.
  - create
```
public static VkPushConstantRange create(long address)
```
    Returns a new VkPushConstantRange instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPushConstantRange createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPushConstantRange.Buffer malloc(int capacity)
```
    Returns a new VkPushConstantRange.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPushConstantRange.Buffer calloc(int capacity)
```
    Returns a new VkPushConstantRange.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPushConstantRange.Buffer create(int capacity)
```
    Returns a new VkPushConstantRange.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPushConstantRange.Buffer create(long address,
                                                int capacity)
```
    Create a VkPushConstantRange.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPushConstantRange.Buffer createSafe(long address,
                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPushConstantRange mallocStack()
```
    Returns a new VkPushConstantRange instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPushConstantRange callocStack()
```
    Returns a new VkPushConstantRange instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPushConstantRange mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPushConstantRange instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPushConstantRange callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPushConstantRange instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPushConstantRange.Buffer mallocStack(int capacity)
```
    Returns a new VkPushConstantRange.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPushConstantRange.Buffer callocStack(int capacity)
```
    Returns a new VkPushConstantRange.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPushConstantRange.Buffer mallocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPushConstantRange.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPushConstantRange.Buffer callocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPushConstantRange.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
  - nstageFlags
```
public static int nstageFlags(long struct)
```
    Unsafe version of stageFlags().
  - noffset
```
public static int noffset(long struct)
```
    Unsafe version of offset().
  - nsize
```
public static int nsize(long struct)
```
    Unsafe version of size().
  - nstageFlags
```
public static void nstageFlags(long struct,
                               int value)
```
    Unsafe version of stageFlags.
  - noffset
```
public static void noffset(long struct,
                           int value)
```
    Unsafe version of offset.
  - nsize
```
public static void nsize(long struct,
                         int value)
```
    Unsafe version of size.

Class VkPushConstantRange

Valid Usage

Valid Usage (Implicit)

See Also

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 class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STAGEFLAGS

OFFSET

SIZE

Constructor Detail

VkPushConstantRange

Method Detail

sizeof

stageFlags

offset

size

stageFlags

offset

size

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nstageFlags

noffset

nsize

nstageFlags

noffset

nsize