Record Class VkDescriptorSetLayoutBinding

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDescriptorSetLayoutBinding

All Implemented Interfaces:

IPointer, IVkDescriptorSetLayoutBinding

@ValueBasedCandidate
@UnsafeConstructor
public record VkDescriptorSetLayoutBinding(@NotNull MemorySegment segment)
extends Record
implements IVkDescriptorSetLayoutBinding

Represents a pointer to a VkDescriptorSetLayoutBinding structure in native memory.

Structure

typedef struct VkDescriptorSetLayoutBinding {
    uint32_t binding;
    VkDescriptorType descriptorType;
    uint32_t descriptorCount; // optional
    VkShaderStageFlags stageFlags;
    VkSampler const* pImmutableSamplers; // optional
} VkDescriptorSetLayoutBinding;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

• VkDescriptorSetLayoutBinding

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDescriptorSetLayoutBinding.Ptr	Represents a pointer to / an array of VkDescriptorSetLayoutBinding structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$binding
static final ValueLayout.OfInt	LAYOUT$descriptorCount
static final ValueLayout.OfInt	LAYOUT$descriptorType
static final AddressLayout	LAYOUT$pImmutableSamplers
static final ValueLayout.OfInt	LAYOUT$stageFlags
static final long	OFFSET$binding
static final long	OFFSET$descriptorCount
static final long	OFFSET$descriptorType
static final long	OFFSET$pImmutableSamplers
static final long	OFFSET$stageFlags
static final MemoryLayout.PathElement	PATH$binding
static final MemoryLayout.PathElement	PATH$descriptorCount
static final MemoryLayout.PathElement	PATH$descriptorType
static final MemoryLayout.PathElement	PATH$pImmutableSamplers
static final MemoryLayout.PathElement	PATH$stageFlags
static final long	SIZE$binding
static final long	SIZE$descriptorCount
static final long	SIZE$descriptorType
static final long	SIZE$pImmutableSamplers
static final long	SIZE$stageFlags

Constructor Summary

Constructors

Constructor	Description
VkDescriptorSetLayoutBinding(@NotNull MemorySegment segment)	Creates an instance of a VkDescriptorSetLayoutBinding record class.

Method Summary

Modifier and Type	Method	Description
static VkDescriptorSetLayoutBinding	allocate(Arena arena)
static VkDescriptorSetLayoutBinding.Ptr	allocate(Arena arena, long count)
int	binding()
VkDescriptorSetLayoutBinding	binding(int value)
static VkDescriptorSetLayoutBinding	clone(Arena arena, VkDescriptorSetLayoutBinding src)
int	descriptorCount()
VkDescriptorSetLayoutBinding	descriptorCount(int value)
int	descriptorType()
VkDescriptorSetLayoutBinding	descriptorType(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
VkSampler.Ptr	pImmutableSamplers()	Note: the returned VkSampler.Ptr does not have correct VkSampler.Ptr.size() property.
VkDescriptorSetLayoutBinding	pImmutableSamplers(VkSampler.Ptr value)
@NotNull MemorySegment	pImmutableSamplersRaw()
void	pImmutableSamplersRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	stageFlags()
VkDescriptorSetLayoutBinding	stageFlags(int value)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$binding

public static final MemoryLayout.PathElement PATH$binding

PATH$descriptorType

public static final MemoryLayout.PathElement PATH$descriptorType

PATH$descriptorCount

public static final MemoryLayout.PathElement PATH$descriptorCount

PATH$stageFlags

public static final MemoryLayout.PathElement PATH$stageFlags

PATH$pImmutableSamplers

public static final MemoryLayout.PathElement PATH$pImmutableSamplers

LAYOUT$binding

public static final ValueLayout.OfInt LAYOUT$binding

LAYOUT$descriptorType

public static final ValueLayout.OfInt LAYOUT$descriptorType

LAYOUT$descriptorCount

public static final ValueLayout.OfInt LAYOUT$descriptorCount

LAYOUT$stageFlags

public static final ValueLayout.OfInt LAYOUT$stageFlags

LAYOUT$pImmutableSamplers

public static final AddressLayout LAYOUT$pImmutableSamplers

SIZE$binding

public static final long SIZE$binding

SIZE$descriptorType

public static final long SIZE$descriptorType

SIZE$descriptorCount

public static final long SIZE$descriptorCount

SIZE$stageFlags

public static final long SIZE$stageFlags

SIZE$pImmutableSamplers

public static final long SIZE$pImmutableSamplers

OFFSET$binding

public static final long OFFSET$binding

OFFSET$descriptorType

public static final long OFFSET$descriptorType

OFFSET$descriptorCount

public static final long OFFSET$descriptorCount

OFFSET$stageFlags

public static final long OFFSET$stageFlags

OFFSET$pImmutableSamplers

public static final long OFFSET$pImmutableSamplers

Constructor Details

VkDescriptorSetLayoutBinding

public VkDescriptorSetLayoutBinding(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDescriptorSetLayoutBinding record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDescriptorSetLayoutBinding allocate(Arena arena)

allocate

public static VkDescriptorSetLayoutBinding.Ptr allocate(Arena arena,
 long count)

clone

public static VkDescriptorSetLayoutBinding clone(Arena arena,
 VkDescriptorSetLayoutBinding src)

binding

@Unsigned
public int binding()

binding

public VkDescriptorSetLayoutBinding binding(@Unsigned
 int value)

descriptorType

@EnumType(VkDescriptorType.class)
public int descriptorType()

descriptorType

public VkDescriptorSetLayoutBinding descriptorType(@EnumType(VkDescriptorType.class)
 int value)

descriptorCount

@Unsigned
public int descriptorCount()

descriptorCount

public VkDescriptorSetLayoutBinding descriptorCount(@Unsigned
 int value)

stageFlags

@Bitmask(VkShaderStageFlags.class)
public int stageFlags()

stageFlags

public VkDescriptorSetLayoutBinding stageFlags(@Bitmask(VkShaderStageFlags.class)
 int value)

pImmutableSamplers

@Nullable
public VkSampler.Ptr pImmutableSamplers()

Note: the returned VkSampler.Ptr does not have correct VkSampler.Ptr.size() property. It's up to user to track the size of the buffer, and use VkSampler.Ptr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pImmutableSamplers

public VkDescriptorSetLayoutBinding pImmutableSamplers(@Nullable
 VkSampler.Ptr value)

pImmutableSamplersRaw

@Pointer(target=VkSampler.class)
@NotNull
public @NotNull MemorySegment pImmutableSamplersRaw()

pImmutableSamplersRaw

public void pImmutableSamplersRaw(@Pointer(target=VkSampler.class) @NotNull
 @NotNull MemorySegment value)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component