Record Class VkAttachmentSampleCountInfoAMD

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkAttachmentSampleCountInfoAMD

All Implemented Interfaces:

IPointer, IVkAttachmentSampleCountInfoAMD

@ValueBasedCandidate
@UnsafeConstructor
public record VkAttachmentSampleCountInfoAMD(@NotNull MemorySegment segment)
extends Record
implements IVkAttachmentSampleCountInfoAMD

Represents a pointer to a VkAttachmentSampleCountInfoAMD structure in native memory.

Structure

typedef struct VkAttachmentSampleCountInfoAMD {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t colorAttachmentCount; // optional
    VkSampleCountFlags const* pColorAttachmentSamples; // optional
    VkSampleCountFlags depthStencilAttachmentSamples; // optional
} VkAttachmentSampleCountInfoAMD;

Auto initialization

This structure has the following members that can be automatically initialized:

• sType = VK_STRUCTURE_TYPE_ATTACHMENT_SAMPLE_COUNT_INFO_AMD

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

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:

• VkAttachmentSampleCountInfoAMD

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkAttachmentSampleCountInfoAMD.Ptr	Represents a pointer to / an array of VkAttachmentSampleCountInfoAMD 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$colorAttachmentCount
static final ValueLayout.OfInt	LAYOUT$depthStencilAttachmentSamples
static final AddressLayout	LAYOUT$pColorAttachmentSamples
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$colorAttachmentCount
static final long	OFFSET$depthStencilAttachmentSamples
static final long	OFFSET$pColorAttachmentSamples
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$colorAttachmentCount
static final MemoryLayout.PathElement	PATH$depthStencilAttachmentSamples
static final MemoryLayout.PathElement	PATH$pColorAttachmentSamples
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$colorAttachmentCount
static final long	SIZE$depthStencilAttachmentSamples
static final long	SIZE$pColorAttachmentSamples
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkAttachmentSampleCountInfoAMD	allocate(Arena arena)
static VkAttachmentSampleCountInfoAMD.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkAttachmentSampleCountInfoAMD	clone(Arena arena, VkAttachmentSampleCountInfoAMD src)
int	colorAttachmentCount()
VkAttachmentSampleCountInfoAMD	colorAttachmentCount(int value)
int	depthStencilAttachmentSamples()
VkAttachmentSampleCountInfoAMD	depthStencilAttachmentSamples(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.
@Nullable IntPtr	pColorAttachmentSamples()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkAttachmentSampleCountInfoAMD	pColorAttachmentSamples(@Nullable IntPtr value)
@NotNull MemorySegment	pColorAttachmentSamplesRaw()
void	pColorAttachmentSamplesRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkAttachmentSampleCountInfoAMD	pNext(@Nullable IPointer pointer)
VkAttachmentSampleCountInfoAMD	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkAttachmentSampleCountInfoAMD	sType(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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$colorAttachmentCount

public static final MemoryLayout.PathElement PATH$colorAttachmentCount

PATH$pColorAttachmentSamples

public static final MemoryLayout.PathElement PATH$pColorAttachmentSamples

PATH$depthStencilAttachmentSamples

public static final MemoryLayout.PathElement PATH$depthStencilAttachmentSamples

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$colorAttachmentCount

public static final ValueLayout.OfInt LAYOUT$colorAttachmentCount

LAYOUT$pColorAttachmentSamples

public static final AddressLayout LAYOUT$pColorAttachmentSamples

LAYOUT$depthStencilAttachmentSamples

public static final ValueLayout.OfInt LAYOUT$depthStencilAttachmentSamples

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$colorAttachmentCount

public static final long SIZE$colorAttachmentCount

SIZE$pColorAttachmentSamples

public static final long SIZE$pColorAttachmentSamples

SIZE$depthStencilAttachmentSamples

public static final long SIZE$depthStencilAttachmentSamples

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$colorAttachmentCount

public static final long OFFSET$colorAttachmentCount

OFFSET$pColorAttachmentSamples

public static final long OFFSET$pColorAttachmentSamples

OFFSET$depthStencilAttachmentSamples

public static final long OFFSET$depthStencilAttachmentSamples

Constructor Details

VkAttachmentSampleCountInfoAMD

public VkAttachmentSampleCountInfoAMD(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkAttachmentSampleCountInfoAMD record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkAttachmentSampleCountInfoAMD allocate(Arena arena)

allocate

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

clone

public static VkAttachmentSampleCountInfoAMD clone(Arena arena,
 VkAttachmentSampleCountInfoAMD src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkAttachmentSampleCountInfoAMD sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment pNext()

pNext

public VkAttachmentSampleCountInfoAMD pNext(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pNext

public VkAttachmentSampleCountInfoAMD pNext(@Nullable
 @Nullable IPointer pointer)

colorAttachmentCount

@Unsigned
public int colorAttachmentCount()

colorAttachmentCount

public VkAttachmentSampleCountInfoAMD colorAttachmentCount(@Unsigned
 int value)

pColorAttachmentSamples

@Nullable
@Bitmask(VkSampleCountFlags.class)
public @Nullable IntPtr pColorAttachmentSamples()

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

pColorAttachmentSamples

public VkAttachmentSampleCountInfoAMD pColorAttachmentSamples(@Nullable @Bitmask(VkSampleCountFlags.class)
 @Nullable IntPtr value)

pColorAttachmentSamplesRaw

@Pointer(target=VkSampleCountFlags.class)
@NotNull
public @NotNull MemorySegment pColorAttachmentSamplesRaw()

pColorAttachmentSamplesRaw

public void pColorAttachmentSamplesRaw(@Pointer(target=VkSampleCountFlags.class) @NotNull
 @NotNull MemorySegment value)

depthStencilAttachmentSamples

@Bitmask(VkSampleCountFlags.class)
public int depthStencilAttachmentSamples()

depthStencilAttachmentSamples

public VkAttachmentSampleCountInfoAMD depthStencilAttachmentSamples(@Bitmask(VkSampleCountFlags.class)
 int 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