Package org.lwjgl.vulkan

Class VkBindDescriptorBufferEmbeddedSamplersInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBindDescriptorBufferEmbeddedSamplersInfoEXT>

org.lwjgl.vulkan.VkBindDescriptorBufferEmbeddedSamplersInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkBindDescriptorBufferEmbeddedSamplersInfoEXT
extends org.lwjgl.system.Struct<VkBindDescriptorBufferEmbeddedSamplersInfoEXT>
implements org.lwjgl.system.NativeResource

Structure specifying embedded immutable sampler offsets to set in a command buffer.

Description

If stageFlags specifies a subset of all stages corresponding to one or more pipeline bind points, the binding operation still affects all stages corresponding to the given pipeline bind point(s) as if the equivalent original version of this command had been called with the same parameters. For example, specifying a stageFlags value of SHADER_STAGE_VERTEX_BIT | SHADER_STAGE_FRAGMENT_BIT | SHADER_STAGE_COMPUTE_BIT is equivalent to calling the original version of this command once with PIPELINE_BIND_POINT_GRAPHICS and once with PIPELINE_BIND_POINT_COMPUTE.

Valid Usage

• The VkDescriptorSetLayout at index set when layout was created must have been created with the DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT bit set
• set must be less than or equal to VkPipelineLayoutCreateInfo::setLayoutCount provided when layout was created

• If the dynamicPipelineLayout feature is not enabled, layout must be a valid VkPipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid VkPipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT
• pNext must be NULL or a pointer to a valid instance of VkPipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• stageFlags must be a valid combination of VkShaderStageFlagBits values
• stageFlags must not be 0
• If layout is not NULL_HANDLE, layout must be a valid VkPipelineLayout handle

See Also

CmdBindDescriptorBufferEmbeddedSamplers2EXT

Layout

 struct VkBindDescriptorBufferEmbeddedSamplersInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkShaderStageFlags stageFlags();
     VkPipelineLayout layout();
     uint32_t set();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	LAYOUT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SET	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STAGEFLAGS	The struct member offsets.
static final int	STYPE	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	Description
VkBindDescriptorBufferEmbeddedSamplersInfoEXT(ByteBuffer container)	Creates a VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT	calloc()	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance allocated with memCalloc.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer	calloc(int capacity)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance allocated with memCalloc.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT	create()	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance allocated with BufferUtils.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer	create(int capacity)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance allocated with BufferUtils.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT	create(long address)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance for the specified memory address.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer	create(long address, int capacity)	Create a VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance at the specified memory.
static @Nullable VkBindDescriptorBufferEmbeddedSamplersInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	layout()	a VkPipelineLayout object used to program the bindings.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	layout(long value)	Sets the specified value to the layout() field.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT	malloc()	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance allocated with memAlloc.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer	malloc(int capacity)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance allocated with memAlloc.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkBindDescriptorBufferEmbeddedSamplersInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance allocated on the specified MemoryStack.
static long	nlayout(long struct)	Unsafe version of layout().
static void	nlayout(long struct, long value)	Unsafe version of layout.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nset(long struct)	Unsafe version of set().
static void	nset(long struct, int value)	Unsafe version of set.
static int	nstageFlags(long struct)	Unsafe version of stageFlags().
static void	nstageFlags(long struct, int value)	Unsafe version of stageFlags.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	pNext(VkPipelineLayoutCreateInfo value)	Prepends the specified VkPipelineLayoutCreateInfo value to the pNext chain.
int	set()	the number of the set to be bound.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	set(int value)	Sets the specified value to the set() field.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	set(int sType, long pNext, int stageFlags, long layout, int set)	Initializes this struct with the specified values.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	set(VkBindDescriptorBufferEmbeddedSamplersInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	stageFlags()	a bitmask of VkShaderStageFlagBits specifying the shader stages that will use the embedded immutable samplers.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	stageFlags(int value)	Sets the specified value to the stageFlags() field.
int	sType()	a VkStructureType value identifying this structure.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkBindDescriptorBufferEmbeddedSamplersInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

STAGEFLAGS

public static final int STAGEFLAGS

The struct member offsets.

LAYOUT

public static final int LAYOUT

The struct member offsets.

SET

public static final int SET

The struct member offsets.

Constructor Details

VkBindDescriptorBufferEmbeddedSamplersInfoEXT

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT(ByteBuffer container)

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

Specified by:

sizeof in class org.lwjgl.system.Struct<VkBindDescriptorBufferEmbeddedSamplersInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

stageFlags

public int stageFlags()

a bitmask of VkShaderStageFlagBits specifying the shader stages that will use the embedded immutable samplers.

layout

public long layout()

a VkPipelineLayout object used to program the bindings. If the dynamicPipelineLayout feature is enabled, layout can be NULL_HANDLE and the layout must be specified by chaining VkPipelineLayoutCreateInfo structure off the pNext

set

public int set()

the number of the set to be bound.

sType

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT value to the sType() field.

pNext

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT pNext(VkPipelineLayoutCreateInfo value)

Prepends the specified VkPipelineLayoutCreateInfo value to the pNext chain.

stageFlags

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT stageFlags(int value)

Sets the specified value to the stageFlags() field.

layout

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT layout(long value)

Sets the specified value to the layout() field.

set

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT set(int value)

Sets the specified value to the set() field.

set

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT set(int sType,
 long pNext,
 int stageFlags,
 long layout,
 int set)

Initializes this struct with the specified values.

set

public VkBindDescriptorBufferEmbeddedSamplersInfoEXT set(VkBindDescriptorBufferEmbeddedSamplersInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT malloc()

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

calloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT calloc()

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

create

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT create()

Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance allocated with BufferUtils.

create

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT create(long address)

Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkBindDescriptorBufferEmbeddedSamplersInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer create(int capacity)

Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkBindDescriptorBufferEmbeddedSamplersInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkBindDescriptorBufferEmbeddedSamplersInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nstageFlags

public static int nstageFlags(long struct)

Unsafe version of stageFlags().

nlayout

public static long nlayout(long struct)

Unsafe version of layout().

nset

public static int nset(long struct)

Unsafe version of set().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nstageFlags

public static void nstageFlags(long struct,
 int value)

Unsafe version of stageFlags.

nlayout

public static void nlayout(long struct,
 long value)

Unsafe version of layout.

nset

public static void nset(long struct,
 int value)

Unsafe version of set.