Record Class VkVideoCapabilitiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVideoCapabilitiesKHR

All Implemented Interfaces:

IPointer, IVkVideoCapabilitiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkVideoCapabilitiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkVideoCapabilitiesKHR

Represents a pointer to a VkVideoCapabilitiesKHR structure in native memory.

Structure

typedef struct VkVideoCapabilitiesKHR {
    VkStructureType sType;
    void* pNext; // optional
    VkVideoCapabilityFlagsKHR flags;
    VkDeviceSize minBitstreamBufferOffsetAlignment;
    VkDeviceSize minBitstreamBufferSizeAlignment;
    VkExtent2D pictureAccessGranularity;
    VkExtent2D minCodedExtent;
    VkExtent2D maxCodedExtent;
    uint32_t maxDpbSlots;
    uint32_t maxActiveReferencePictures;
    VkExtensionProperties stdHeaderVersion;
} VkVideoCapabilitiesKHR;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_VIDEO_CAPABILITIES_KHR

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:

• VkVideoCapabilitiesKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkVideoCapabilitiesKHR.Ptr	Represents a pointer to / an array of VkVideoCapabilitiesKHR 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$flags
static final ValueLayout.OfInt	LAYOUT$maxActiveReferencePictures
static final StructLayout	LAYOUT$maxCodedExtent
static final ValueLayout.OfInt	LAYOUT$maxDpbSlots
static final ValueLayout.OfLong	LAYOUT$minBitstreamBufferOffsetAlignment
static final ValueLayout.OfLong	LAYOUT$minBitstreamBufferSizeAlignment
static final StructLayout	LAYOUT$minCodedExtent
static final StructLayout	LAYOUT$pictureAccessGranularity
static final AddressLayout	LAYOUT$pNext
static final StructLayout	LAYOUT$stdHeaderVersion
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$flags
static final long	OFFSET$maxActiveReferencePictures
static final long	OFFSET$maxCodedExtent
static final long	OFFSET$maxDpbSlots
static final long	OFFSET$minBitstreamBufferOffsetAlignment
static final long	OFFSET$minBitstreamBufferSizeAlignment
static final long	OFFSET$minCodedExtent
static final long	OFFSET$pictureAccessGranularity
static final long	OFFSET$pNext
static final long	OFFSET$stdHeaderVersion
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$maxActiveReferencePictures
static final MemoryLayout.PathElement	PATH$maxCodedExtent
static final MemoryLayout.PathElement	PATH$maxDpbSlots
static final MemoryLayout.PathElement	PATH$minBitstreamBufferOffsetAlignment
static final MemoryLayout.PathElement	PATH$minBitstreamBufferSizeAlignment
static final MemoryLayout.PathElement	PATH$minCodedExtent
static final MemoryLayout.PathElement	PATH$pictureAccessGranularity
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$stdHeaderVersion
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$flags
static final long	SIZE$maxActiveReferencePictures
static final long	SIZE$maxCodedExtent
static final long	SIZE$maxDpbSlots
static final long	SIZE$minBitstreamBufferOffsetAlignment
static final long	SIZE$minBitstreamBufferSizeAlignment
static final long	SIZE$minCodedExtent
static final long	SIZE$pictureAccessGranularity
static final long	SIZE$pNext
static final long	SIZE$stdHeaderVersion
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVideoCapabilitiesKHR	allocate(Arena arena)
static VkVideoCapabilitiesKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkVideoCapabilitiesKHR	clone(Arena arena, VkVideoCapabilitiesKHR src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()
VkVideoCapabilitiesKHR	flags(int value)
final int	hashCode()	Returns a hash code value for this object.
int	maxActiveReferencePictures()
VkVideoCapabilitiesKHR	maxActiveReferencePictures(int value)
@NotNull VkExtent2D	maxCodedExtent()
VkVideoCapabilitiesKHR	maxCodedExtent(@NotNull VkExtent2D value)
VkVideoCapabilitiesKHR	maxCodedExtent(Consumer<@NotNull VkExtent2D> consumer)
int	maxDpbSlots()
VkVideoCapabilitiesKHR	maxDpbSlots(int value)
long	minBitstreamBufferOffsetAlignment()
VkVideoCapabilitiesKHR	minBitstreamBufferOffsetAlignment(long value)
long	minBitstreamBufferSizeAlignment()
VkVideoCapabilitiesKHR	minBitstreamBufferSizeAlignment(long value)
@NotNull VkExtent2D	minCodedExtent()
VkVideoCapabilitiesKHR	minCodedExtent(@NotNull VkExtent2D value)
VkVideoCapabilitiesKHR	minCodedExtent(Consumer<@NotNull VkExtent2D> consumer)
@NotNull VkExtent2D	pictureAccessGranularity()
VkVideoCapabilitiesKHR	pictureAccessGranularity(@NotNull VkExtent2D value)
VkVideoCapabilitiesKHR	pictureAccessGranularity(Consumer<@NotNull VkExtent2D> consumer)
@NotNull MemorySegment	pNext()
VkVideoCapabilitiesKHR	pNext(@Nullable IPointer pointer)
VkVideoCapabilitiesKHR	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull VkExtensionProperties	stdHeaderVersion()
VkVideoCapabilitiesKHR	stdHeaderVersion(@NotNull VkExtensionProperties value)
VkVideoCapabilitiesKHR	stdHeaderVersion(Consumer<@NotNull VkExtensionProperties> consumer)
int	sType()
VkVideoCapabilitiesKHR	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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$minBitstreamBufferOffsetAlignment

public static final MemoryLayout.PathElement PATH$minBitstreamBufferOffsetAlignment

PATH$minBitstreamBufferSizeAlignment

public static final MemoryLayout.PathElement PATH$minBitstreamBufferSizeAlignment

PATH$pictureAccessGranularity

public static final MemoryLayout.PathElement PATH$pictureAccessGranularity

PATH$minCodedExtent

public static final MemoryLayout.PathElement PATH$minCodedExtent

PATH$maxCodedExtent

public static final MemoryLayout.PathElement PATH$maxCodedExtent

PATH$maxDpbSlots

public static final MemoryLayout.PathElement PATH$maxDpbSlots

PATH$maxActiveReferencePictures

public static final MemoryLayout.PathElement PATH$maxActiveReferencePictures

PATH$stdHeaderVersion

public static final MemoryLayout.PathElement PATH$stdHeaderVersion

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$minBitstreamBufferOffsetAlignment

public static final ValueLayout.OfLong LAYOUT$minBitstreamBufferOffsetAlignment

LAYOUT$minBitstreamBufferSizeAlignment

public static final ValueLayout.OfLong LAYOUT$minBitstreamBufferSizeAlignment

LAYOUT$pictureAccessGranularity

public static final StructLayout LAYOUT$pictureAccessGranularity

LAYOUT$minCodedExtent

public static final StructLayout LAYOUT$minCodedExtent

LAYOUT$maxCodedExtent

public static final StructLayout LAYOUT$maxCodedExtent

LAYOUT$maxDpbSlots

public static final ValueLayout.OfInt LAYOUT$maxDpbSlots

LAYOUT$maxActiveReferencePictures

public static final ValueLayout.OfInt LAYOUT$maxActiveReferencePictures

LAYOUT$stdHeaderVersion

public static final StructLayout LAYOUT$stdHeaderVersion

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$flags

public static final long SIZE$flags

SIZE$minBitstreamBufferOffsetAlignment

public static final long SIZE$minBitstreamBufferOffsetAlignment

SIZE$minBitstreamBufferSizeAlignment

public static final long SIZE$minBitstreamBufferSizeAlignment

SIZE$pictureAccessGranularity

public static final long SIZE$pictureAccessGranularity

SIZE$minCodedExtent

public static final long SIZE$minCodedExtent

SIZE$maxCodedExtent

public static final long SIZE$maxCodedExtent

SIZE$maxDpbSlots

public static final long SIZE$maxDpbSlots

SIZE$maxActiveReferencePictures

public static final long SIZE$maxActiveReferencePictures

SIZE$stdHeaderVersion

public static final long SIZE$stdHeaderVersion

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$flags

public static final long OFFSET$flags

OFFSET$minBitstreamBufferOffsetAlignment

public static final long OFFSET$minBitstreamBufferOffsetAlignment

OFFSET$minBitstreamBufferSizeAlignment

public static final long OFFSET$minBitstreamBufferSizeAlignment

OFFSET$pictureAccessGranularity

public static final long OFFSET$pictureAccessGranularity

OFFSET$minCodedExtent

public static final long OFFSET$minCodedExtent

OFFSET$maxCodedExtent

public static final long OFFSET$maxCodedExtent

OFFSET$maxDpbSlots

public static final long OFFSET$maxDpbSlots

OFFSET$maxActiveReferencePictures

public static final long OFFSET$maxActiveReferencePictures

OFFSET$stdHeaderVersion

public static final long OFFSET$stdHeaderVersion

Constructor Details

VkVideoCapabilitiesKHR

public VkVideoCapabilitiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVideoCapabilitiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVideoCapabilitiesKHR allocate(Arena arena)

allocate

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

clone

public static VkVideoCapabilitiesKHR clone(Arena arena,
 VkVideoCapabilitiesKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkVideoCapabilitiesKHR pNext(@Nullable
 @Nullable IPointer pointer)

flags

@Bitmask(VkVideoCapabilityFlagsKHR.class)
public int flags()

flags

public VkVideoCapabilitiesKHR flags(@Bitmask(VkVideoCapabilityFlagsKHR.class)
 int value)

minBitstreamBufferOffsetAlignment

@NativeType("VkDeviceSize")
@Unsigned
public long minBitstreamBufferOffsetAlignment()

minBitstreamBufferOffsetAlignment

public VkVideoCapabilitiesKHR minBitstreamBufferOffsetAlignment(@NativeType("VkDeviceSize") @Unsigned
 long value)

minBitstreamBufferSizeAlignment

@NativeType("VkDeviceSize")
@Unsigned
public long minBitstreamBufferSizeAlignment()

minBitstreamBufferSizeAlignment

public VkVideoCapabilitiesKHR minBitstreamBufferSizeAlignment(@NativeType("VkDeviceSize") @Unsigned
 long value)

pictureAccessGranularity

@NotNull
public @NotNull VkExtent2D pictureAccessGranularity()

pictureAccessGranularity

public VkVideoCapabilitiesKHR pictureAccessGranularity(@NotNull
 @NotNull VkExtent2D value)

pictureAccessGranularity

public VkVideoCapabilitiesKHR pictureAccessGranularity(Consumer<@NotNull VkExtent2D> consumer)

minCodedExtent

@NotNull
public @NotNull VkExtent2D minCodedExtent()

minCodedExtent

public VkVideoCapabilitiesKHR minCodedExtent(@NotNull
 @NotNull VkExtent2D value)

minCodedExtent

public VkVideoCapabilitiesKHR minCodedExtent(Consumer<@NotNull VkExtent2D> consumer)

maxCodedExtent

@NotNull
public @NotNull VkExtent2D maxCodedExtent()

maxCodedExtent

public VkVideoCapabilitiesKHR maxCodedExtent(@NotNull
 @NotNull VkExtent2D value)

maxCodedExtent

public VkVideoCapabilitiesKHR maxCodedExtent(Consumer<@NotNull VkExtent2D> consumer)

maxDpbSlots

@Unsigned
public int maxDpbSlots()

maxDpbSlots

public VkVideoCapabilitiesKHR maxDpbSlots(@Unsigned
 int value)

maxActiveReferencePictures

@Unsigned
public int maxActiveReferencePictures()

maxActiveReferencePictures

public VkVideoCapabilitiesKHR maxActiveReferencePictures(@Unsigned
 int value)

stdHeaderVersion

@NotNull
public @NotNull VkExtensionProperties stdHeaderVersion()

stdHeaderVersion

public VkVideoCapabilitiesKHR stdHeaderVersion(@NotNull
 @NotNull VkExtensionProperties value)

stdHeaderVersion

public VkVideoCapabilitiesKHR stdHeaderVersion(Consumer<@NotNull VkExtensionProperties> consumer)

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