Class VkDescriptorMappingSourcePushIndexEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorMappingSourcePushIndexEXT>

org.lwjgl.vulkan.VkDescriptorMappingSourcePushIndexEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDescriptorMappingSourcePushIndexEXT
extends Struct<VkDescriptorMappingSourcePushIndexEXT>
implements NativeResource

struct VkDescriptorMappingSourcePushIndexEXT {
    uint32_t heapOffset;
    uint32_t pushOffset;
    uint32_t heapIndexStride;
    uint32_t heapArrayStride;
    VkSamplerCreateInfo const * pEmbeddedSampler;
    VkBool32 useCombinedImageSamplerIndex;
    uint32_t samplerHeapOffset;
    uint32_t samplerPushOffset;
    uint32_t samplerHeapIndexStride;
    uint32_t samplerHeapArrayStride;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDescriptorMappingSourcePushIndexEXT.Buffer	An array of VkDescriptorMappingSourcePushIndexEXT structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	HEAPARRAYSTRIDE	The struct member offsets.
static final int	HEAPINDEXSTRIDE	The struct member offsets.
static final int	HEAPOFFSET	The struct member offsets.
static final int	PEMBEDDEDSAMPLER	The struct member offsets.
static final int	PUSHOFFSET	The struct member offsets.
static final int	SAMPLERHEAPARRAYSTRIDE	The struct member offsets.
static final int	SAMPLERHEAPINDEXSTRIDE	The struct member offsets.
static final int	SAMPLERHEAPOFFSET	The struct member offsets.
static final int	SAMPLERPUSHOFFSET	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	USECOMBINEDIMAGESAMPLERINDEX	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDescriptorMappingSourcePushIndexEXT(ByteBuffer container)	Creates a VkDescriptorMappingSourcePushIndexEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDescriptorMappingSourcePushIndexEXT	calloc()	Returns a new VkDescriptorMappingSourcePushIndexEXT instance allocated with memCalloc.
static VkDescriptorMappingSourcePushIndexEXT.Buffer	calloc(int capacity)	Returns a new VkDescriptorMappingSourcePushIndexEXT.Buffer instance allocated with memCalloc.
static VkDescriptorMappingSourcePushIndexEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorMappingSourcePushIndexEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorMappingSourcePushIndexEXT	calloc(MemoryStack stack)	Returns a new VkDescriptorMappingSourcePushIndexEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorMappingSourcePushIndexEXT	create()	Returns a new VkDescriptorMappingSourcePushIndexEXT instance allocated with BufferUtils.
static VkDescriptorMappingSourcePushIndexEXT.Buffer	create(int capacity)	Returns a new VkDescriptorMappingSourcePushIndexEXT.Buffer instance allocated with BufferUtils.
static VkDescriptorMappingSourcePushIndexEXT	create(long address)	Returns a new VkDescriptorMappingSourcePushIndexEXT instance for the specified memory address.
static VkDescriptorMappingSourcePushIndexEXT.Buffer	create(long address, int capacity)	Create a VkDescriptorMappingSourcePushIndexEXT.Buffer instance at the specified memory.
static @Nullable VkDescriptorMappingSourcePushIndexEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorMappingSourcePushIndexEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	heapArrayStride()
VkDescriptorMappingSourcePushIndexEXT	heapArrayStride(int value)	Sets the specified value to the heapArrayStride field.
int	heapIndexStride()
VkDescriptorMappingSourcePushIndexEXT	heapIndexStride(int value)	Sets the specified value to the heapIndexStride field.
int	heapOffset()
VkDescriptorMappingSourcePushIndexEXT	heapOffset(int value)	Sets the specified value to the heapOffset field.
static VkDescriptorMappingSourcePushIndexEXT	malloc()	Returns a new VkDescriptorMappingSourcePushIndexEXT instance allocated with memAlloc.
static VkDescriptorMappingSourcePushIndexEXT.Buffer	malloc(int capacity)	Returns a new VkDescriptorMappingSourcePushIndexEXT.Buffer instance allocated with memAlloc.
static VkDescriptorMappingSourcePushIndexEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorMappingSourcePushIndexEXT.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorMappingSourcePushIndexEXT	malloc(MemoryStack stack)	Returns a new VkDescriptorMappingSourcePushIndexEXT instance allocated on the specified MemoryStack.
static int	nheapArrayStride(long struct)	Unsafe version of heapArrayStride().
static void	nheapArrayStride(long struct, int value)	Unsafe version of heapArrayStride.
static int	nheapIndexStride(long struct)	Unsafe version of heapIndexStride().
static void	nheapIndexStride(long struct, int value)	Unsafe version of heapIndexStride.
static int	nheapOffset(long struct)	Unsafe version of heapOffset().
static void	nheapOffset(long struct, int value)	Unsafe version of heapOffset.
static @Nullable VkSamplerCreateInfo	npEmbeddedSampler(long struct)	Unsafe version of pEmbeddedSampler().
static void	npEmbeddedSampler(long struct, @Nullable VkSamplerCreateInfo value)	Unsafe version of pEmbeddedSampler.
static int	npushOffset(long struct)	Unsafe version of pushOffset().
static void	npushOffset(long struct, int value)	Unsafe version of pushOffset.
static int	nsamplerHeapArrayStride(long struct)	Unsafe version of samplerHeapArrayStride().
static void	nsamplerHeapArrayStride(long struct, int value)	Unsafe version of samplerHeapArrayStride.
static int	nsamplerHeapIndexStride(long struct)	Unsafe version of samplerHeapIndexStride().
static void	nsamplerHeapIndexStride(long struct, int value)	Unsafe version of samplerHeapIndexStride.
static int	nsamplerHeapOffset(long struct)	Unsafe version of samplerHeapOffset().
static void	nsamplerHeapOffset(long struct, int value)	Unsafe version of samplerHeapOffset.
static int	nsamplerPushOffset(long struct)	Unsafe version of samplerPushOffset().
static void	nsamplerPushOffset(long struct, int value)	Unsafe version of samplerPushOffset.
static int	nuseCombinedImageSamplerIndex(long struct)	Unsafe version of useCombinedImageSamplerIndex().
static void	nuseCombinedImageSamplerIndex(long struct, int value)	Unsafe version of useCombinedImageSamplerIndex.
@Nullable VkSamplerCreateInfo	pEmbeddedSampler()
VkDescriptorMappingSourcePushIndexEXT	pEmbeddedSampler(@Nullable VkSamplerCreateInfo value)	Sets the address of the specified VkSamplerCreateInfo to the pEmbeddedSampler field.
int	pushOffset()
VkDescriptorMappingSourcePushIndexEXT	pushOffset(int value)	Sets the specified value to the pushOffset field.
int	samplerHeapArrayStride()
VkDescriptorMappingSourcePushIndexEXT	samplerHeapArrayStride(int value)	Sets the specified value to the samplerHeapArrayStride field.
int	samplerHeapIndexStride()
VkDescriptorMappingSourcePushIndexEXT	samplerHeapIndexStride(int value)	Sets the specified value to the samplerHeapIndexStride field.
int	samplerHeapOffset()
VkDescriptorMappingSourcePushIndexEXT	samplerHeapOffset(int value)	Sets the specified value to the samplerHeapOffset field.
int	samplerPushOffset()
VkDescriptorMappingSourcePushIndexEXT	samplerPushOffset(int value)	Sets the specified value to the samplerPushOffset field.
VkDescriptorMappingSourcePushIndexEXT	set(int heapOffset, int pushOffset, int heapIndexStride, int heapArrayStride, @Nullable VkSamplerCreateInfo pEmbeddedSampler, boolean useCombinedImageSamplerIndex, int samplerHeapOffset, int samplerPushOffset, int samplerHeapIndexStride, int samplerHeapArrayStride)	Initializes this struct with the specified values.
VkDescriptorMappingSourcePushIndexEXT	set(VkDescriptorMappingSourcePushIndexEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
boolean	useCombinedImageSamplerIndex()
VkDescriptorMappingSourcePushIndexEXT	useCombinedImageSamplerIndex(boolean value)	Sets the specified value to the useCombinedImageSamplerIndex field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

HEAPOFFSET

public static final int HEAPOFFSET

The struct member offsets.

PUSHOFFSET

public static final int PUSHOFFSET

The struct member offsets.

HEAPINDEXSTRIDE

public static final int HEAPINDEXSTRIDE

The struct member offsets.

HEAPARRAYSTRIDE

public static final int HEAPARRAYSTRIDE

The struct member offsets.

PEMBEDDEDSAMPLER

public static final int PEMBEDDEDSAMPLER

The struct member offsets.

USECOMBINEDIMAGESAMPLERINDEX

public static final int USECOMBINEDIMAGESAMPLERINDEX

The struct member offsets.

SAMPLERHEAPOFFSET

public static final int SAMPLERHEAPOFFSET

The struct member offsets.

SAMPLERPUSHOFFSET

public static final int SAMPLERPUSHOFFSET

The struct member offsets.

SAMPLERHEAPINDEXSTRIDE

public static final int SAMPLERHEAPINDEXSTRIDE

The struct member offsets.

SAMPLERHEAPARRAYSTRIDE

public static final int SAMPLERHEAPARRAYSTRIDE

The struct member offsets.

Constructor Details

VkDescriptorMappingSourcePushIndexEXT

public VkDescriptorMappingSourcePushIndexEXT(ByteBuffer container)

Creates a VkDescriptorMappingSourcePushIndexEXT 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDescriptorMappingSourcePushIndexEXT>

heapOffset

@NativeType("uint32_t")
public int heapOffset()

Returns:

the value of the heapOffset field.

pushOffset

@NativeType("uint32_t")
public int pushOffset()

Returns:

the value of the pushOffset field.

heapIndexStride

@NativeType("uint32_t")
public int heapIndexStride()

Returns:

the value of the heapIndexStride field.

heapArrayStride

@NativeType("uint32_t")
public int heapArrayStride()

Returns:

the value of the heapArrayStride field.

pEmbeddedSampler

@NativeType("VkSamplerCreateInfo const *")
public @Nullable VkSamplerCreateInfo pEmbeddedSampler()

Returns:

a VkSamplerCreateInfo view of the struct pointed to by the pEmbeddedSampler field.

useCombinedImageSamplerIndex

@NativeType("VkBool32")
public boolean useCombinedImageSamplerIndex()

Returns:

the value of the useCombinedImageSamplerIndex field.

samplerHeapOffset

@NativeType("uint32_t")
public int samplerHeapOffset()

Returns:

the value of the samplerHeapOffset field.

samplerPushOffset

@NativeType("uint32_t")
public int samplerPushOffset()

Returns:

the value of the samplerPushOffset field.

samplerHeapIndexStride

@NativeType("uint32_t")
public int samplerHeapIndexStride()

Returns:

the value of the samplerHeapIndexStride field.

samplerHeapArrayStride

@NativeType("uint32_t")
public int samplerHeapArrayStride()

Returns:

the value of the samplerHeapArrayStride field.

heapOffset

public VkDescriptorMappingSourcePushIndexEXT heapOffset(@NativeType("uint32_t")
 int value)

Sets the specified value to the heapOffset field.

pushOffset

public VkDescriptorMappingSourcePushIndexEXT pushOffset(@NativeType("uint32_t")
 int value)

Sets the specified value to the pushOffset field.

heapIndexStride

public VkDescriptorMappingSourcePushIndexEXT heapIndexStride(@NativeType("uint32_t")
 int value)

Sets the specified value to the heapIndexStride field.

heapArrayStride

public VkDescriptorMappingSourcePushIndexEXT heapArrayStride(@NativeType("uint32_t")
 int value)

Sets the specified value to the heapArrayStride field.

pEmbeddedSampler

public VkDescriptorMappingSourcePushIndexEXT pEmbeddedSampler(@NativeType("VkSamplerCreateInfo const *")
 @Nullable VkSamplerCreateInfo value)

Sets the address of the specified VkSamplerCreateInfo to the pEmbeddedSampler field.

useCombinedImageSamplerIndex

public VkDescriptorMappingSourcePushIndexEXT useCombinedImageSamplerIndex(@NativeType("VkBool32")
 boolean value)

Sets the specified value to the useCombinedImageSamplerIndex field.

samplerHeapOffset

public VkDescriptorMappingSourcePushIndexEXT samplerHeapOffset(@NativeType("uint32_t")
 int value)

Sets the specified value to the samplerHeapOffset field.

samplerPushOffset

public VkDescriptorMappingSourcePushIndexEXT samplerPushOffset(@NativeType("uint32_t")
 int value)

Sets the specified value to the samplerPushOffset field.

samplerHeapIndexStride

public VkDescriptorMappingSourcePushIndexEXT samplerHeapIndexStride(@NativeType("uint32_t")
 int value)

Sets the specified value to the samplerHeapIndexStride field.

samplerHeapArrayStride

public VkDescriptorMappingSourcePushIndexEXT samplerHeapArrayStride(@NativeType("uint32_t")
 int value)

Sets the specified value to the samplerHeapArrayStride field.

set

public VkDescriptorMappingSourcePushIndexEXT set(int heapOffset,
 int pushOffset,
 int heapIndexStride,
 int heapArrayStride,
 @Nullable VkSamplerCreateInfo pEmbeddedSampler,
 boolean useCombinedImageSamplerIndex,
 int samplerHeapOffset,
 int samplerPushOffset,
 int samplerHeapIndexStride,
 int samplerHeapArrayStride)

Initializes this struct with the specified values.

set

public VkDescriptorMappingSourcePushIndexEXT set(VkDescriptorMappingSourcePushIndexEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorMappingSourcePushIndexEXT malloc()

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

calloc

public static VkDescriptorMappingSourcePushIndexEXT calloc()

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

create

public static VkDescriptorMappingSourcePushIndexEXT create()

Returns a new VkDescriptorMappingSourcePushIndexEXT instance allocated with BufferUtils.

create

public static VkDescriptorMappingSourcePushIndexEXT create(long address)

Returns a new VkDescriptorMappingSourcePushIndexEXT instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorMappingSourcePushIndexEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorMappingSourcePushIndexEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorMappingSourcePushIndexEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorMappingSourcePushIndexEXT.Buffer create(int capacity)

Returns a new VkDescriptorMappingSourcePushIndexEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorMappingSourcePushIndexEXT.Buffer create(long address,
 int capacity)

Create a VkDescriptorMappingSourcePushIndexEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkDescriptorMappingSourcePushIndexEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorMappingSourcePushIndexEXT malloc(MemoryStack stack)

Returns a new VkDescriptorMappingSourcePushIndexEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDescriptorMappingSourcePushIndexEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDescriptorMappingSourcePushIndexEXT.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDescriptorMappingSourcePushIndexEXT.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nheapOffset

public static int nheapOffset(long struct)

Unsafe version of heapOffset().

npushOffset

public static int npushOffset(long struct)

Unsafe version of pushOffset().

nheapIndexStride

public static int nheapIndexStride(long struct)

Unsafe version of heapIndexStride().

nheapArrayStride

public static int nheapArrayStride(long struct)

Unsafe version of heapArrayStride().

npEmbeddedSampler

public static @Nullable VkSamplerCreateInfo npEmbeddedSampler(long struct)

Unsafe version of pEmbeddedSampler().

nuseCombinedImageSamplerIndex

public static int nuseCombinedImageSamplerIndex(long struct)

Unsafe version of useCombinedImageSamplerIndex().

nsamplerHeapOffset

public static int nsamplerHeapOffset(long struct)

Unsafe version of samplerHeapOffset().

nsamplerPushOffset

public static int nsamplerPushOffset(long struct)

Unsafe version of samplerPushOffset().

nsamplerHeapIndexStride

public static int nsamplerHeapIndexStride(long struct)

Unsafe version of samplerHeapIndexStride().

nsamplerHeapArrayStride

public static int nsamplerHeapArrayStride(long struct)

Unsafe version of samplerHeapArrayStride().

nheapOffset

public static void nheapOffset(long struct,
 int value)

Unsafe version of heapOffset.

npushOffset

public static void npushOffset(long struct,
 int value)

Unsafe version of pushOffset.

nheapIndexStride

public static void nheapIndexStride(long struct,
 int value)

Unsafe version of heapIndexStride.

nheapArrayStride

public static void nheapArrayStride(long struct,
 int value)

Unsafe version of heapArrayStride.

npEmbeddedSampler

public static void npEmbeddedSampler(long struct,
 @Nullable VkSamplerCreateInfo value)

Unsafe version of pEmbeddedSampler.

nuseCombinedImageSamplerIndex

public static void nuseCombinedImageSamplerIndex(long struct,
 int value)

Unsafe version of useCombinedImageSamplerIndex.

nsamplerHeapOffset

public static void nsamplerHeapOffset(long struct,
 int value)

Unsafe version of samplerHeapOffset.

nsamplerPushOffset

public static void nsamplerPushOffset(long struct,
 int value)

Unsafe version of samplerPushOffset.

nsamplerHeapIndexStride

public static void nsamplerHeapIndexStride(long struct,
 int value)

Unsafe version of samplerHeapIndexStride.

nsamplerHeapArrayStride

public static void nsamplerHeapArrayStride(long struct,
 int value)

Unsafe version of samplerHeapArrayStride.