Record Class VAImageFormatCLREF

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.VAImageFormatCLREF

All Implemented Interfaces:

IPointer, IVAImageFormatCLREF

@ValueBasedCandidate
@UnsafeConstructor
public record VAImageFormatCLREF(@NotNull MemorySegment segment)
extends Record
implements IVAImageFormatCLREF

Represents a pointer to a VAImageFormat structure in native memory.

Structure

typedef struct VAImageFormat {
    uint32_t fourcc;
    uint32_t byte_order;
    uint32_t bits_per_pixel;
    uint32_t depth;
    uint32_t red_mask;
    uint32_t green_mask;
    uint32_t blue_mask;
    uint32_t alpha_mask;
    uint32_t[4] va_reserved;
} VAImageFormat;

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VAImageFormatCLREF.Ptr	Represents a pointer to / an array of null 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$alpha_mask
static final ValueLayout.OfInt	LAYOUT$bits_per_pixel
static final ValueLayout.OfInt	LAYOUT$blue_mask
static final ValueLayout.OfInt	LAYOUT$byte_order
static final ValueLayout.OfInt	LAYOUT$depth
static final ValueLayout.OfInt	LAYOUT$fourcc
static final ValueLayout.OfInt	LAYOUT$green_mask
static final ValueLayout.OfInt	LAYOUT$red_mask
static final SequenceLayout	LAYOUT$va_reserved
static final long	OFFSET$alpha_mask
static final long	OFFSET$bits_per_pixel
static final long	OFFSET$blue_mask
static final long	OFFSET$byte_order
static final long	OFFSET$depth
static final long	OFFSET$fourcc
static final long	OFFSET$green_mask
static final long	OFFSET$red_mask
static final long	OFFSET$va_reserved
static final MemoryLayout.PathElement	PATH$alpha_mask
static final MemoryLayout.PathElement	PATH$bits_per_pixel
static final MemoryLayout.PathElement	PATH$blue_mask
static final MemoryLayout.PathElement	PATH$byte_order
static final MemoryLayout.PathElement	PATH$depth
static final MemoryLayout.PathElement	PATH$fourcc
static final MemoryLayout.PathElement	PATH$green_mask
static final MemoryLayout.PathElement	PATH$red_mask
static final MemoryLayout.PathElement	PATH$va_reserved
static final long	SIZE$alpha_mask
static final long	SIZE$bits_per_pixel
static final long	SIZE$blue_mask
static final long	SIZE$byte_order
static final long	SIZE$depth
static final long	SIZE$fourcc
static final long	SIZE$green_mask
static final long	SIZE$red_mask
static final long	SIZE$va_reserved

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VAImageFormatCLREF	allocate(Arena arena)
static VAImageFormatCLREF.Ptr	allocate(Arena arena, long count)
int	alpha_mask()
VAImageFormatCLREF	alpha_mask(int value)
int	bits_per_pixel()
VAImageFormatCLREF	bits_per_pixel(int value)
int	blue_mask()
VAImageFormatCLREF	blue_mask(int value)
int	byte_order()
VAImageFormatCLREF	byte_order(int value)
static VAImageFormatCLREF	clone(Arena arena, VAImageFormatCLREF src)
int	depth()
VAImageFormatCLREF	depth(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	fourcc()
VAImageFormatCLREF	fourcc(int value)
int	green_mask()
VAImageFormatCLREF	green_mask(int value)
final int	hashCode()	Returns a hash code value for this object.
int	red_mask()
VAImageFormatCLREF	red_mask(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
IntPtr	va_reserved()
VAImageFormatCLREF	va_reserved(IntPtr value)
VAImageFormatCLREF	va_reserved(@NotNull Consumer<IntPtr> consumer)
@NotNull MemorySegment	va_reservedRaw()

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$fourcc

public static final MemoryLayout.PathElement PATH$fourcc

PATH$byte_order

public static final MemoryLayout.PathElement PATH$byte_order

PATH$bits_per_pixel

public static final MemoryLayout.PathElement PATH$bits_per_pixel

PATH$depth

public static final MemoryLayout.PathElement PATH$depth

PATH$red_mask

public static final MemoryLayout.PathElement PATH$red_mask

PATH$green_mask

public static final MemoryLayout.PathElement PATH$green_mask

PATH$blue_mask

public static final MemoryLayout.PathElement PATH$blue_mask

PATH$alpha_mask

public static final MemoryLayout.PathElement PATH$alpha_mask

PATH$va_reserved

public static final MemoryLayout.PathElement PATH$va_reserved

LAYOUT$fourcc

public static final ValueLayout.OfInt LAYOUT$fourcc

LAYOUT$byte_order

public static final ValueLayout.OfInt LAYOUT$byte_order

LAYOUT$bits_per_pixel

public static final ValueLayout.OfInt LAYOUT$bits_per_pixel

LAYOUT$depth

public static final ValueLayout.OfInt LAYOUT$depth

LAYOUT$red_mask

public static final ValueLayout.OfInt LAYOUT$red_mask

LAYOUT$green_mask

public static final ValueLayout.OfInt LAYOUT$green_mask

LAYOUT$blue_mask

public static final ValueLayout.OfInt LAYOUT$blue_mask

LAYOUT$alpha_mask

public static final ValueLayout.OfInt LAYOUT$alpha_mask

LAYOUT$va_reserved

public static final SequenceLayout LAYOUT$va_reserved

SIZE$fourcc

public static final long SIZE$fourcc

SIZE$byte_order

public static final long SIZE$byte_order

SIZE$bits_per_pixel

public static final long SIZE$bits_per_pixel

SIZE$depth

public static final long SIZE$depth

SIZE$red_mask

public static final long SIZE$red_mask

SIZE$green_mask

public static final long SIZE$green_mask

SIZE$blue_mask

public static final long SIZE$blue_mask

SIZE$alpha_mask

public static final long SIZE$alpha_mask

SIZE$va_reserved

public static final long SIZE$va_reserved

OFFSET$fourcc

public static final long OFFSET$fourcc

OFFSET$byte_order

public static final long OFFSET$byte_order

OFFSET$bits_per_pixel

public static final long OFFSET$bits_per_pixel

OFFSET$depth

public static final long OFFSET$depth

OFFSET$red_mask

public static final long OFFSET$red_mask

OFFSET$green_mask

public static final long OFFSET$green_mask

OFFSET$blue_mask

public static final long OFFSET$blue_mask

OFFSET$alpha_mask

public static final long OFFSET$alpha_mask

OFFSET$va_reserved

public static final long OFFSET$va_reserved

Constructor Details

VAImageFormatCLREF

public VAImageFormatCLREF(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VAImageFormatCLREF record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VAImageFormatCLREF allocate(Arena arena)

allocate

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

clone

public static VAImageFormatCLREF clone(Arena arena,
 VAImageFormatCLREF src)

fourcc

@Unsigned
public int fourcc()

fourcc

public VAImageFormatCLREF fourcc(@Unsigned
 int value)

byte_order

@Unsigned
public int byte_order()

byte_order

public VAImageFormatCLREF byte_order(@Unsigned
 int value)

bits_per_pixel

@Unsigned
public int bits_per_pixel()

bits_per_pixel

public VAImageFormatCLREF bits_per_pixel(@Unsigned
 int value)

depth

@Unsigned
public int depth()

depth

public VAImageFormatCLREF depth(@Unsigned
 int value)

red_mask

@Unsigned
public int red_mask()

red_mask

public VAImageFormatCLREF red_mask(@Unsigned
 int value)

green_mask

@Unsigned
public int green_mask()

green_mask

public VAImageFormatCLREF green_mask(@Unsigned
 int value)

blue_mask

@Unsigned
public int blue_mask()

blue_mask

public VAImageFormatCLREF blue_mask(@Unsigned
 int value)

alpha_mask

@Unsigned
public int alpha_mask()

alpha_mask

public VAImageFormatCLREF alpha_mask(@Unsigned
 int value)

va_reserved

@Unsigned
public IntPtr va_reserved()

va_reserved

public VAImageFormatCLREF va_reserved(@NotNull
 @NotNull Consumer<IntPtr> consumer)

va_reserved

public VAImageFormatCLREF va_reserved(@Unsigned
 IntPtr value)

va_reservedRaw

@NotNull
public @NotNull MemorySegment va_reservedRaw()

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