Record Class SDL_GPUMultisampleState

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUMultisampleState

All Implemented Interfaces:

IPointer, ISDL_GPUMultisampleState

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUMultisampleState(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUMultisampleState

A structure specifying the parameters of the graphics pipeline multisample state.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_GPUGraphicsPipelineCreateInfo

Structure

typedef struct SDL_GPUMultisampleState {
    SDL_GPUSampleCount sample_count;
    Uint32 sample_mask;
    bool enable_mask;
    Uint8 padding1;
    Uint8 padding2;
    Uint8 padding3;
} SDL_GPUMultisampleState;

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	SDL_GPUMultisampleState.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.OfBoolean	LAYOUT$enable_mask
static final ValueLayout.OfByte	LAYOUT$padding1
static final ValueLayout.OfByte	LAYOUT$padding2
static final ValueLayout.OfByte	LAYOUT$padding3
static final ValueLayout.OfInt	LAYOUT$sample_count
static final ValueLayout.OfInt	LAYOUT$sample_mask
static final long	OFFSET$enable_mask
static final long	OFFSET$padding1
static final long	OFFSET$padding2
static final long	OFFSET$padding3
static final long	OFFSET$sample_count
static final long	OFFSET$sample_mask
static final MemoryLayout.PathElement	PATH$enable_mask
static final MemoryLayout.PathElement	PATH$padding1
static final MemoryLayout.PathElement	PATH$padding2
static final MemoryLayout.PathElement	PATH$padding3
static final MemoryLayout.PathElement	PATH$sample_count
static final MemoryLayout.PathElement	PATH$sample_mask
static final long	SIZE$enable_mask
static final long	SIZE$padding1
static final long	SIZE$padding2
static final long	SIZE$padding3
static final long	SIZE$sample_count
static final long	SIZE$sample_mask

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUMultisampleState	allocate(Arena arena)
static SDL_GPUMultisampleState.Ptr	allocate(Arena arena, long count)
static SDL_GPUMultisampleState	clone(Arena arena, SDL_GPUMultisampleState src)
boolean	enable_mask()
SDL_GPUMultisampleState	enable_mask(boolean 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.
byte	padding1()
SDL_GPUMultisampleState	padding1(byte value)
byte	padding2()
SDL_GPUMultisampleState	padding2(byte value)
byte	padding3()
SDL_GPUMultisampleState	padding3(byte value)
int	sample_count()
SDL_GPUMultisampleState	sample_count(int value)
int	sample_mask()
SDL_GPUMultisampleState	sample_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.

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

public static final MemoryLayout.PathElement PATH$sample_count

PATH$sample_mask

public static final MemoryLayout.PathElement PATH$sample_mask

PATH$enable_mask

public static final MemoryLayout.PathElement PATH$enable_mask

PATH$padding1

public static final MemoryLayout.PathElement PATH$padding1

PATH$padding2

public static final MemoryLayout.PathElement PATH$padding2

PATH$padding3

public static final MemoryLayout.PathElement PATH$padding3

LAYOUT$sample_count

public static final ValueLayout.OfInt LAYOUT$sample_count

LAYOUT$sample_mask

public static final ValueLayout.OfInt LAYOUT$sample_mask

LAYOUT$enable_mask

public static final ValueLayout.OfBoolean LAYOUT$enable_mask

LAYOUT$padding1

public static final ValueLayout.OfByte LAYOUT$padding1

LAYOUT$padding2

public static final ValueLayout.OfByte LAYOUT$padding2

LAYOUT$padding3

public static final ValueLayout.OfByte LAYOUT$padding3

SIZE$sample_count

public static final long SIZE$sample_count

SIZE$sample_mask

public static final long SIZE$sample_mask

SIZE$enable_mask

public static final long SIZE$enable_mask

SIZE$padding1

public static final long SIZE$padding1

SIZE$padding2

public static final long SIZE$padding2

SIZE$padding3

public static final long SIZE$padding3

OFFSET$sample_count

public static final long OFFSET$sample_count

OFFSET$sample_mask

public static final long OFFSET$sample_mask

OFFSET$enable_mask

public static final long OFFSET$enable_mask

OFFSET$padding1

public static final long OFFSET$padding1

OFFSET$padding2

public static final long OFFSET$padding2

OFFSET$padding3

public static final long OFFSET$padding3

Constructor Details

SDL_GPUMultisampleState

public SDL_GPUMultisampleState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUMultisampleState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUMultisampleState allocate(Arena arena)

allocate

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

clone

public static SDL_GPUMultisampleState clone(Arena arena,
 SDL_GPUMultisampleState src)

sample_count

@EnumType(SDL_GPUSampleCount.class)
public int sample_count()

sample_count

public SDL_GPUMultisampleState sample_count(@EnumType(SDL_GPUSampleCount.class)
 int value)

sample_mask

@NativeType("Uint32")
@Unsigned
public int sample_mask()

sample_mask

public SDL_GPUMultisampleState sample_mask(@NativeType("Uint32") @Unsigned
 int value)

enable_mask

@NativeType("boolean")
public boolean enable_mask()

enable_mask

public SDL_GPUMultisampleState enable_mask(@NativeType("boolean")
 boolean value)

padding1

@NativeType("Uint8")
@Unsigned
public byte padding1()

padding1

public SDL_GPUMultisampleState padding1(@NativeType("Uint8") @Unsigned
 byte value)

padding2

@NativeType("Uint8")
@Unsigned
public byte padding2()

padding2

public SDL_GPUMultisampleState padding2(@NativeType("Uint8") @Unsigned
 byte value)

padding3

@NativeType("Uint8")
@Unsigned
public byte padding3()

padding3

public SDL_GPUMultisampleState padding3(@NativeType("Uint8") @Unsigned
 byte 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