Record Class VkSampleLocationsInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSampleLocationsInfoEXT

All Implemented Interfaces:

IPointer, IVkSampleLocationsInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkSampleLocationsInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkSampleLocationsInfoEXT

Represents a pointer to a VkSampleLocationsInfoEXT structure in native memory.

Structure

typedef struct VkSampleLocationsInfoEXT {
    VkStructureType sType;
    void const* pNext; // optional
    VkSampleCountFlags sampleLocationsPerPixel;
    VkExtent2D sampleLocationGridSize;
    uint32_t sampleLocationsCount; // optional
    VkSampleLocationEXT const* pSampleLocations; // optional
} VkSampleLocationsInfoEXT;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT

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:

• VkSampleLocationsInfoEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pSampleLocations
static final StructLayout	LAYOUT$sampleLocationGridSize
static final ValueLayout.OfInt	LAYOUT$sampleLocationsCount
static final ValueLayout.OfInt	LAYOUT$sampleLocationsPerPixel
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$pNext
static final long	OFFSET$pSampleLocations
static final long	OFFSET$sampleLocationGridSize
static final long	OFFSET$sampleLocationsCount
static final long	OFFSET$sampleLocationsPerPixel
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pSampleLocations
static final MemoryLayout.PathElement	PATH$sampleLocationGridSize
static final MemoryLayout.PathElement	PATH$sampleLocationsCount
static final MemoryLayout.PathElement	PATH$sampleLocationsPerPixel
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$pNext
static final long	SIZE$pSampleLocations
static final long	SIZE$sampleLocationGridSize
static final long	SIZE$sampleLocationsCount
static final long	SIZE$sampleLocationsPerPixel
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSampleLocationsInfoEXT	allocate(Arena arena)
static VkSampleLocationsInfoEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkSampleLocationsInfoEXT	clone(Arena arena, VkSampleLocationsInfoEXT src)
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.
@NotNull MemorySegment	pNext()
VkSampleLocationsInfoEXT	pNext(@Nullable IPointer pointer)
VkSampleLocationsInfoEXT	pNext(@NotNull MemorySegment value)
@Nullable VkSampleLocationEXT	pSampleLocations()
VkSampleLocationEXT.Ptr	pSampleLocations(int assumedCount)
VkSampleLocationsInfoEXT	pSampleLocations(@Nullable IVkSampleLocationEXT value)
@NotNull MemorySegment	pSampleLocationsRaw()
void	pSampleLocationsRaw(@NotNull MemorySegment value)
@NotNull VkExtent2D	sampleLocationGridSize()
VkSampleLocationsInfoEXT	sampleLocationGridSize(@NotNull VkExtent2D value)
VkSampleLocationsInfoEXT	sampleLocationGridSize(Consumer<@NotNull VkExtent2D> consumer)
int	sampleLocationsCount()
VkSampleLocationsInfoEXT	sampleLocationsCount(int value)
int	sampleLocationsPerPixel()
VkSampleLocationsInfoEXT	sampleLocationsPerPixel(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkSampleLocationsInfoEXT	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$sampleLocationsPerPixel

public static final MemoryLayout.PathElement PATH$sampleLocationsPerPixel

PATH$sampleLocationGridSize

public static final MemoryLayout.PathElement PATH$sampleLocationGridSize

PATH$sampleLocationsCount

public static final MemoryLayout.PathElement PATH$sampleLocationsCount

PATH$pSampleLocations

public static final MemoryLayout.PathElement PATH$pSampleLocations

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$sampleLocationsPerPixel

public static final ValueLayout.OfInt LAYOUT$sampleLocationsPerPixel

LAYOUT$sampleLocationGridSize

public static final StructLayout LAYOUT$sampleLocationGridSize

LAYOUT$sampleLocationsCount

public static final ValueLayout.OfInt LAYOUT$sampleLocationsCount

LAYOUT$pSampleLocations

public static final AddressLayout LAYOUT$pSampleLocations

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$sampleLocationsPerPixel

public static final long SIZE$sampleLocationsPerPixel

SIZE$sampleLocationGridSize

public static final long SIZE$sampleLocationGridSize

SIZE$sampleLocationsCount

public static final long SIZE$sampleLocationsCount

SIZE$pSampleLocations

public static final long SIZE$pSampleLocations

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$sampleLocationsPerPixel

public static final long OFFSET$sampleLocationsPerPixel

OFFSET$sampleLocationGridSize

public static final long OFFSET$sampleLocationGridSize

OFFSET$sampleLocationsCount

public static final long OFFSET$sampleLocationsCount

OFFSET$pSampleLocations

public static final long OFFSET$pSampleLocations

Constructor Details

VkSampleLocationsInfoEXT

public VkSampleLocationsInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSampleLocationsInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSampleLocationsInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkSampleLocationsInfoEXT clone(Arena arena,
 VkSampleLocationsInfoEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSampleLocationsInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

sampleLocationsPerPixel

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

sampleLocationsPerPixel

public VkSampleLocationsInfoEXT sampleLocationsPerPixel(@Bitmask(VkSampleCountFlags.class)
 int value)

sampleLocationGridSize

@NotNull
public @NotNull VkExtent2D sampleLocationGridSize()

sampleLocationGridSize

public VkSampleLocationsInfoEXT sampleLocationGridSize(@NotNull
 @NotNull VkExtent2D value)

sampleLocationGridSize

public VkSampleLocationsInfoEXT sampleLocationGridSize(Consumer<@NotNull VkExtent2D> consumer)

sampleLocationsCount

@Unsigned
public int sampleLocationsCount()

sampleLocationsCount

public VkSampleLocationsInfoEXT sampleLocationsCount(@Unsigned
 int value)

pSampleLocations

public VkSampleLocationsInfoEXT pSampleLocations(@Nullable
 @Nullable IVkSampleLocationEXT value)

pSampleLocations

@Unsafe
@Nullable
public VkSampleLocationEXT.Ptr pSampleLocations(int assumedCount)

pSampleLocations

@Nullable
public @Nullable VkSampleLocationEXT pSampleLocations()

pSampleLocationsRaw

@Pointer(target=VkSampleLocationEXT.class)
@NotNull
public @NotNull MemorySegment pSampleLocationsRaw()

pSampleLocationsRaw

public void pSampleLocationsRaw(@Pointer(target=VkSampleLocationEXT.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