Record Class SDL_GPUTextureTransferInfo

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUTextureTransferInfo

All Implemented Interfaces:

IPointer, ISDL_GPUTextureTransferInfo

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUTextureTransferInfo(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUTextureTransferInfo

A structure specifying parameters related to transferring data to or from a texture.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_UploadToGPUTexture
• SDL_DownloadFromGPUTexture

Structure

typedef struct SDL_GPUTextureTransferInfo {
    SDL_GPUTransferBuffer* transfer_buffer;
    Uint32 offset;
    Uint32 pixels_per_row;
    Uint32 rows_per_layer;
} SDL_GPUTextureTransferInfo;

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_GPUTextureTransferInfo.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$offset
static final ValueLayout.OfInt	LAYOUT$pixels_per_row
static final ValueLayout.OfInt	LAYOUT$rows_per_layer
static final AddressLayout	LAYOUT$transfer_buffer
static final long	OFFSET$offset
static final long	OFFSET$pixels_per_row
static final long	OFFSET$rows_per_layer
static final long	OFFSET$transfer_buffer
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$pixels_per_row
static final MemoryLayout.PathElement	PATH$rows_per_layer
static final MemoryLayout.PathElement	PATH$transfer_buffer
static final long	SIZE$offset
static final long	SIZE$pixels_per_row
static final long	SIZE$rows_per_layer
static final long	SIZE$transfer_buffer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUTextureTransferInfo	allocate(Arena arena)
static SDL_GPUTextureTransferInfo.Ptr	allocate(Arena arena, long count)
static SDL_GPUTextureTransferInfo	clone(Arena arena, SDL_GPUTextureTransferInfo src)
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	offset()
SDL_GPUTextureTransferInfo	offset(int value)
int	pixels_per_row()
SDL_GPUTextureTransferInfo	pixels_per_row(int value)
int	rows_per_layer()
SDL_GPUTextureTransferInfo	rows_per_layer(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
@Nullable SDL_GPUTransferBuffer	transfer_buffer()
SDL_GPUTextureTransferInfo	transfer_buffer(@Nullable SDL_GPUTransferBuffer value)

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

public static final MemoryLayout.PathElement PATH$transfer_buffer

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$pixels_per_row

public static final MemoryLayout.PathElement PATH$pixels_per_row

PATH$rows_per_layer

public static final MemoryLayout.PathElement PATH$rows_per_layer

LAYOUT$transfer_buffer

public static final AddressLayout LAYOUT$transfer_buffer

LAYOUT$offset

public static final ValueLayout.OfInt LAYOUT$offset

LAYOUT$pixels_per_row

public static final ValueLayout.OfInt LAYOUT$pixels_per_row

LAYOUT$rows_per_layer

public static final ValueLayout.OfInt LAYOUT$rows_per_layer

SIZE$transfer_buffer

public static final long SIZE$transfer_buffer

SIZE$offset

public static final long SIZE$offset

SIZE$pixels_per_row

public static final long SIZE$pixels_per_row

SIZE$rows_per_layer

public static final long SIZE$rows_per_layer

OFFSET$transfer_buffer

public static final long OFFSET$transfer_buffer

OFFSET$offset

public static final long OFFSET$offset

OFFSET$pixels_per_row

public static final long OFFSET$pixels_per_row

OFFSET$rows_per_layer

public static final long OFFSET$rows_per_layer

Constructor Details

SDL_GPUTextureTransferInfo

public SDL_GPUTextureTransferInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUTextureTransferInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUTextureTransferInfo allocate(Arena arena)

allocate

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

clone

public static SDL_GPUTextureTransferInfo clone(Arena arena,
 SDL_GPUTextureTransferInfo src)

transfer_buffer

@Nullable
public @Nullable SDL_GPUTransferBuffer transfer_buffer()

transfer_buffer

public SDL_GPUTextureTransferInfo transfer_buffer(@Nullable
 @Nullable SDL_GPUTransferBuffer value)

offset

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

offset

public SDL_GPUTextureTransferInfo offset(@NativeType("Uint32") @Unsigned
 int value)

pixels_per_row

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

pixels_per_row

public SDL_GPUTextureTransferInfo pixels_per_row(@NativeType("Uint32") @Unsigned
 int value)

rows_per_layer

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

rows_per_layer

public SDL_GPUTextureTransferInfo rows_per_layer(@NativeType("Uint32") @Unsigned
 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