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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkPushConstantRange
extends Struct

Khronos Reference Page
Vulkan Specification

Describes a push constant range.

Valid Usage

stageFlags must be a valid combination of VkShaderStageFlagBits values
stageFlags must not be 0
offset must be less than VkPhysicalDeviceLimits::maxPushConstantsSize
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

Member documentation

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

`SHADER_STAGE_ALL`	`SHADER_STAGE_ALL_GRAPHICS`
`SHADER_STAGE_COMPUTE_BIT`	`SHADER_STAGE_FRAGMENT_BIT`
`SHADER_STAGE_GEOMETRY_BIT`	`SHADER_STAGE_TESSELLATION_CONTROL_BIT`
`SHADER_STAGE_TESSELLATION_EVALUATION_BIT`	`SHADER_STAGE_VERTEX_BIT`

offset – the start offset, in bytes, consumed by the range
size – the size, in bytes, consumed by the range

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
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  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, MemoryStack stack)` Returns a new `VkPushConstantRange.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPushConstantRange`	`callocStack(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 or `null` if the address is `NULL`.
`static VkPushConstantRange.Buffer`	`create(long address, int capacity)` Create a `VkPushConstantRange.Buffer` instance at the specified memory.
`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, MemoryStack stack)` Returns a new `VkPushConstantRange.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPushConstantRange`	`mallocStack(MemoryStack stack)` Returns a new `VkPushConstantRange` instance allocated on the specified `MemoryStack`.
`VkPushConstantRange`	`nset(long struct)` Unsafe version of `set`.
`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()` Returns the `sizeof(struct)`.
`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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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.
  - nset
```
public VkPushConstantRange nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - 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(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(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,
                                                     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,
                                                     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

Class VkPushConstantRange

Valid Usage

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

Constructor Detail

VkPushConstantRange

Method Detail

sizeof

stageFlags

offset

size

stageFlags

offset

size

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack