Record Class SDL_GPUBlitInfo

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUBlitInfo

All Implemented Interfaces:

IPointer, ISDL_GPUBlitInfo

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUBlitInfo(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUBlitInfo

A structure containing parameters for a blit command.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_BlitGPUTexture

Structure

typedef struct SDL_GPUBlitInfo {
    SDL_GPUBlitRegion destination;
    SDL_GPULoadOp load_op;
    SDL_FColor clear_color;
    SDL_FlipMode flip_mode;
    SDL_GPUFilter filter;
    bool cycle;
    Uint8 padding1;
    Uint8 padding2;
    Uint8 padding3;
} SDL_GPUBlitInfo;

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_GPUBlitInfo.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 StructLayout	LAYOUT$clear_color
static final ValueLayout.OfBoolean	LAYOUT$cycle
static final StructLayout	LAYOUT$destination
static final ValueLayout.OfInt	LAYOUT$filter
static final ValueLayout.OfInt	LAYOUT$flip_mode
static final ValueLayout.OfInt	LAYOUT$load_op
static final ValueLayout.OfByte	LAYOUT$padding1
static final ValueLayout.OfByte	LAYOUT$padding2
static final ValueLayout.OfByte	LAYOUT$padding3
static final long	OFFSET$clear_color
static final long	OFFSET$cycle
static final long	OFFSET$destination
static final long	OFFSET$filter
static final long	OFFSET$flip_mode
static final long	OFFSET$load_op
static final long	OFFSET$padding1
static final long	OFFSET$padding2
static final long	OFFSET$padding3
static final MemoryLayout.PathElement	PATH$clear_color
static final MemoryLayout.PathElement	PATH$cycle
static final MemoryLayout.PathElement	PATH$destination
static final MemoryLayout.PathElement	PATH$filter
static final MemoryLayout.PathElement	PATH$flip_mode
static final MemoryLayout.PathElement	PATH$load_op
static final MemoryLayout.PathElement	PATH$padding1
static final MemoryLayout.PathElement	PATH$padding2
static final MemoryLayout.PathElement	PATH$padding3
static final long	SIZE$clear_color
static final long	SIZE$cycle
static final long	SIZE$destination
static final long	SIZE$filter
static final long	SIZE$flip_mode
static final long	SIZE$load_op
static final long	SIZE$padding1
static final long	SIZE$padding2
static final long	SIZE$padding3

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUBlitInfo	allocate(Arena arena)
static SDL_GPUBlitInfo.Ptr	allocate(Arena arena, long count)
@NotNull SDL_FColor	clear_color()
SDL_GPUBlitInfo	clear_color(@NotNull SDL_FColor value)
SDL_GPUBlitInfo	clear_color(Consumer<@NotNull SDL_FColor> consumer)
static SDL_GPUBlitInfo	clone(Arena arena, SDL_GPUBlitInfo src)
boolean	cycle()
SDL_GPUBlitInfo	cycle(boolean value)
@NotNull SDL_GPUBlitRegion	destination()
SDL_GPUBlitInfo	destination(@NotNull SDL_GPUBlitRegion value)
SDL_GPUBlitInfo	destination(Consumer<@NotNull SDL_GPUBlitRegion> consumer)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	filter()
SDL_GPUBlitInfo	filter(int value)
int	flip_mode()
SDL_GPUBlitInfo	flip_mode(int value)
final int	hashCode()	Returns a hash code value for this object.
int	load_op()
SDL_GPUBlitInfo	load_op(int value)
byte	padding1()
SDL_GPUBlitInfo	padding1(byte value)
byte	padding2()
SDL_GPUBlitInfo	padding2(byte value)
byte	padding3()
SDL_GPUBlitInfo	padding3(byte 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$destination

public static final MemoryLayout.PathElement PATH$destination

PATH$load_op

public static final MemoryLayout.PathElement PATH$load_op

PATH$clear_color

public static final MemoryLayout.PathElement PATH$clear_color

PATH$flip_mode

public static final MemoryLayout.PathElement PATH$flip_mode

PATH$filter

public static final MemoryLayout.PathElement PATH$filter

PATH$cycle

public static final MemoryLayout.PathElement PATH$cycle

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

public static final StructLayout LAYOUT$destination

LAYOUT$load_op

public static final ValueLayout.OfInt LAYOUT$load_op

LAYOUT$clear_color

public static final StructLayout LAYOUT$clear_color

LAYOUT$flip_mode

public static final ValueLayout.OfInt LAYOUT$flip_mode

LAYOUT$filter

public static final ValueLayout.OfInt LAYOUT$filter

LAYOUT$cycle

public static final ValueLayout.OfBoolean LAYOUT$cycle

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

public static final long SIZE$destination

SIZE$load_op

public static final long SIZE$load_op

SIZE$clear_color

public static final long SIZE$clear_color

SIZE$flip_mode

public static final long SIZE$flip_mode

SIZE$filter

public static final long SIZE$filter

SIZE$cycle

public static final long SIZE$cycle

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

public static final long OFFSET$destination

OFFSET$load_op

public static final long OFFSET$load_op

OFFSET$clear_color

public static final long OFFSET$clear_color

OFFSET$flip_mode

public static final long OFFSET$flip_mode

OFFSET$filter

public static final long OFFSET$filter

OFFSET$cycle

public static final long OFFSET$cycle

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_GPUBlitInfo

public SDL_GPUBlitInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUBlitInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUBlitInfo allocate(Arena arena)

allocate

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

clone

public static SDL_GPUBlitInfo clone(Arena arena,
 SDL_GPUBlitInfo src)

destination

@NotNull
public @NotNull SDL_GPUBlitRegion destination()

destination

public SDL_GPUBlitInfo destination(@NotNull
 @NotNull SDL_GPUBlitRegion value)

destination

public SDL_GPUBlitInfo destination(Consumer<@NotNull SDL_GPUBlitRegion> consumer)

load_op

@EnumType(SDL_GPULoadOp.class)
public int load_op()

load_op

public SDL_GPUBlitInfo load_op(@EnumType(SDL_GPULoadOp.class)
 int value)

clear_color

@NotNull
public @NotNull SDL_FColor clear_color()

clear_color

public SDL_GPUBlitInfo clear_color(@NotNull
 @NotNull SDL_FColor value)

clear_color

public SDL_GPUBlitInfo clear_color(Consumer<@NotNull SDL_FColor> consumer)

flip_mode

@EnumType(SDL_FlipMode.class)
public int flip_mode()

flip_mode

public SDL_GPUBlitInfo flip_mode(@EnumType(SDL_FlipMode.class)
 int value)

filter

@EnumType(SDL_GPUFilter.class)
public int filter()

filter

public SDL_GPUBlitInfo filter(@EnumType(SDL_GPUFilter.class)
 int value)

cycle

@NativeType("boolean")
public boolean cycle()

cycle

public SDL_GPUBlitInfo cycle(@NativeType("boolean")
 boolean value)

padding1

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

padding1

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

padding2

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

padding2

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

padding3

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

padding3

public SDL_GPUBlitInfo 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