Record Class VkSurfaceCapabilitiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSurfaceCapabilitiesKHR

All Implemented Interfaces:

IPointer, IVkSurfaceCapabilitiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkSurfaceCapabilitiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkSurfaceCapabilitiesKHR

Represents a pointer to a VkSurfaceCapabilitiesKHR structure in native memory.

Structure

typedef struct VkSurfaceCapabilitiesKHR {
    uint32_t minImageCount;
    uint32_t maxImageCount;
    VkExtent2D currentExtent;
    VkExtent2D minImageExtent;
    VkExtent2D maxImageExtent;
    uint32_t maxImageArrayLayers;
    VkSurfaceTransformFlagsKHR supportedTransforms;
    VkSurfaceTransformFlagsKHR currentTransform;
    VkCompositeAlphaFlagsKHR supportedCompositeAlpha;
    VkImageUsageFlags supportedUsageFlags;
} VkSurfaceCapabilitiesKHR;

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:

• VkSurfaceCapabilitiesKHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final StructLayout	LAYOUT$currentExtent
static final ValueLayout.OfInt	LAYOUT$currentTransform
static final ValueLayout.OfInt	LAYOUT$maxImageArrayLayers
static final ValueLayout.OfInt	LAYOUT$maxImageCount
static final StructLayout	LAYOUT$maxImageExtent
static final ValueLayout.OfInt	LAYOUT$minImageCount
static final StructLayout	LAYOUT$minImageExtent
static final ValueLayout.OfInt	LAYOUT$supportedCompositeAlpha
static final ValueLayout.OfInt	LAYOUT$supportedTransforms
static final ValueLayout.OfInt	LAYOUT$supportedUsageFlags
static final long	OFFSET$currentExtent
static final long	OFFSET$currentTransform
static final long	OFFSET$maxImageArrayLayers
static final long	OFFSET$maxImageCount
static final long	OFFSET$maxImageExtent
static final long	OFFSET$minImageCount
static final long	OFFSET$minImageExtent
static final long	OFFSET$supportedCompositeAlpha
static final long	OFFSET$supportedTransforms
static final long	OFFSET$supportedUsageFlags
static final MemoryLayout.PathElement	PATH$currentExtent
static final MemoryLayout.PathElement	PATH$currentTransform
static final MemoryLayout.PathElement	PATH$maxImageArrayLayers
static final MemoryLayout.PathElement	PATH$maxImageCount
static final MemoryLayout.PathElement	PATH$maxImageExtent
static final MemoryLayout.PathElement	PATH$minImageCount
static final MemoryLayout.PathElement	PATH$minImageExtent
static final MemoryLayout.PathElement	PATH$supportedCompositeAlpha
static final MemoryLayout.PathElement	PATH$supportedTransforms
static final MemoryLayout.PathElement	PATH$supportedUsageFlags
static final long	SIZE$currentExtent
static final long	SIZE$currentTransform
static final long	SIZE$maxImageArrayLayers
static final long	SIZE$maxImageCount
static final long	SIZE$maxImageExtent
static final long	SIZE$minImageCount
static final long	SIZE$minImageExtent
static final long	SIZE$supportedCompositeAlpha
static final long	SIZE$supportedTransforms
static final long	SIZE$supportedUsageFlags

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSurfaceCapabilitiesKHR	allocate(Arena arena)
static VkSurfaceCapabilitiesKHR.Ptr	allocate(Arena arena, long count)
static VkSurfaceCapabilitiesKHR	clone(Arena arena, VkSurfaceCapabilitiesKHR src)
@NotNull VkExtent2D	currentExtent()
VkSurfaceCapabilitiesKHR	currentExtent(@NotNull VkExtent2D value)
VkSurfaceCapabilitiesKHR	currentExtent(Consumer<@NotNull VkExtent2D> consumer)
int	currentTransform()
VkSurfaceCapabilitiesKHR	currentTransform(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.
int	maxImageArrayLayers()
VkSurfaceCapabilitiesKHR	maxImageArrayLayers(int value)
int	maxImageCount()
VkSurfaceCapabilitiesKHR	maxImageCount(int value)
@NotNull VkExtent2D	maxImageExtent()
VkSurfaceCapabilitiesKHR	maxImageExtent(@NotNull VkExtent2D value)
VkSurfaceCapabilitiesKHR	maxImageExtent(Consumer<@NotNull VkExtent2D> consumer)
int	minImageCount()
VkSurfaceCapabilitiesKHR	minImageCount(int value)
@NotNull VkExtent2D	minImageExtent()
VkSurfaceCapabilitiesKHR	minImageExtent(@NotNull VkExtent2D value)
VkSurfaceCapabilitiesKHR	minImageExtent(Consumer<@NotNull VkExtent2D> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	supportedCompositeAlpha()
VkSurfaceCapabilitiesKHR	supportedCompositeAlpha(int value)
int	supportedTransforms()
VkSurfaceCapabilitiesKHR	supportedTransforms(int value)
int	supportedUsageFlags()
VkSurfaceCapabilitiesKHR	supportedUsageFlags(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$minImageCount

public static final MemoryLayout.PathElement PATH$minImageCount

PATH$maxImageCount

public static final MemoryLayout.PathElement PATH$maxImageCount

PATH$currentExtent

public static final MemoryLayout.PathElement PATH$currentExtent

PATH$minImageExtent

public static final MemoryLayout.PathElement PATH$minImageExtent

PATH$maxImageExtent

public static final MemoryLayout.PathElement PATH$maxImageExtent

PATH$maxImageArrayLayers

public static final MemoryLayout.PathElement PATH$maxImageArrayLayers

PATH$supportedTransforms

public static final MemoryLayout.PathElement PATH$supportedTransforms

PATH$currentTransform

public static final MemoryLayout.PathElement PATH$currentTransform

PATH$supportedCompositeAlpha

public static final MemoryLayout.PathElement PATH$supportedCompositeAlpha

PATH$supportedUsageFlags

public static final MemoryLayout.PathElement PATH$supportedUsageFlags

LAYOUT$minImageCount

public static final ValueLayout.OfInt LAYOUT$minImageCount

LAYOUT$maxImageCount

public static final ValueLayout.OfInt LAYOUT$maxImageCount

LAYOUT$currentExtent

public static final StructLayout LAYOUT$currentExtent

LAYOUT$minImageExtent

public static final StructLayout LAYOUT$minImageExtent

LAYOUT$maxImageExtent

public static final StructLayout LAYOUT$maxImageExtent

LAYOUT$maxImageArrayLayers

public static final ValueLayout.OfInt LAYOUT$maxImageArrayLayers

LAYOUT$supportedTransforms

public static final ValueLayout.OfInt LAYOUT$supportedTransforms

LAYOUT$currentTransform

public static final ValueLayout.OfInt LAYOUT$currentTransform

LAYOUT$supportedCompositeAlpha

public static final ValueLayout.OfInt LAYOUT$supportedCompositeAlpha

LAYOUT$supportedUsageFlags

public static final ValueLayout.OfInt LAYOUT$supportedUsageFlags

SIZE$minImageCount

public static final long SIZE$minImageCount

SIZE$maxImageCount

public static final long SIZE$maxImageCount

SIZE$currentExtent

public static final long SIZE$currentExtent

SIZE$minImageExtent

public static final long SIZE$minImageExtent

SIZE$maxImageExtent

public static final long SIZE$maxImageExtent

SIZE$maxImageArrayLayers

public static final long SIZE$maxImageArrayLayers

SIZE$supportedTransforms

public static final long SIZE$supportedTransforms

SIZE$currentTransform

public static final long SIZE$currentTransform

SIZE$supportedCompositeAlpha

public static final long SIZE$supportedCompositeAlpha

SIZE$supportedUsageFlags

public static final long SIZE$supportedUsageFlags

OFFSET$minImageCount

public static final long OFFSET$minImageCount

OFFSET$maxImageCount

public static final long OFFSET$maxImageCount

OFFSET$currentExtent

public static final long OFFSET$currentExtent

OFFSET$minImageExtent

public static final long OFFSET$minImageExtent

OFFSET$maxImageExtent

public static final long OFFSET$maxImageExtent

OFFSET$maxImageArrayLayers

public static final long OFFSET$maxImageArrayLayers

OFFSET$supportedTransforms

public static final long OFFSET$supportedTransforms

OFFSET$currentTransform

public static final long OFFSET$currentTransform

OFFSET$supportedCompositeAlpha

public static final long OFFSET$supportedCompositeAlpha

OFFSET$supportedUsageFlags

public static final long OFFSET$supportedUsageFlags

Constructor Details

VkSurfaceCapabilitiesKHR

public VkSurfaceCapabilitiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSurfaceCapabilitiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSurfaceCapabilitiesKHR allocate(Arena arena)

allocate

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

clone

public static VkSurfaceCapabilitiesKHR clone(Arena arena,
 VkSurfaceCapabilitiesKHR src)

minImageCount

@Unsigned
public int minImageCount()

minImageCount

public VkSurfaceCapabilitiesKHR minImageCount(@Unsigned
 int value)

maxImageCount

@Unsigned
public int maxImageCount()

maxImageCount

public VkSurfaceCapabilitiesKHR maxImageCount(@Unsigned
 int value)

currentExtent

@NotNull
public @NotNull VkExtent2D currentExtent()

currentExtent

public VkSurfaceCapabilitiesKHR currentExtent(@NotNull
 @NotNull VkExtent2D value)

currentExtent

public VkSurfaceCapabilitiesKHR currentExtent(Consumer<@NotNull VkExtent2D> consumer)

minImageExtent

@NotNull
public @NotNull VkExtent2D minImageExtent()

minImageExtent

public VkSurfaceCapabilitiesKHR minImageExtent(@NotNull
 @NotNull VkExtent2D value)

minImageExtent

public VkSurfaceCapabilitiesKHR minImageExtent(Consumer<@NotNull VkExtent2D> consumer)

maxImageExtent

@NotNull
public @NotNull VkExtent2D maxImageExtent()

maxImageExtent

public VkSurfaceCapabilitiesKHR maxImageExtent(@NotNull
 @NotNull VkExtent2D value)

maxImageExtent

public VkSurfaceCapabilitiesKHR maxImageExtent(Consumer<@NotNull VkExtent2D> consumer)

maxImageArrayLayers

@Unsigned
public int maxImageArrayLayers()

maxImageArrayLayers

public VkSurfaceCapabilitiesKHR maxImageArrayLayers(@Unsigned
 int value)

supportedTransforms

@EnumType(VkSurfaceTransformFlagsKHR.class)
public int supportedTransforms()

supportedTransforms

public VkSurfaceCapabilitiesKHR supportedTransforms(@EnumType(VkSurfaceTransformFlagsKHR.class)
 int value)

currentTransform

@EnumType(VkSurfaceTransformFlagsKHR.class)
public int currentTransform()

currentTransform

public VkSurfaceCapabilitiesKHR currentTransform(@EnumType(VkSurfaceTransformFlagsKHR.class)
 int value)

supportedCompositeAlpha

@EnumType(VkCompositeAlphaFlagsKHR.class)
public int supportedCompositeAlpha()

supportedCompositeAlpha

public VkSurfaceCapabilitiesKHR supportedCompositeAlpha(@EnumType(VkCompositeAlphaFlagsKHR.class)
 int value)

supportedUsageFlags

@EnumType(VkImageUsageFlags.class)
public int supportedUsageFlags()

supportedUsageFlags

public VkSurfaceCapabilitiesKHR supportedUsageFlags(@EnumType(VkImageUsageFlags.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