Record Class SDL_GPUTransferBufferLocation

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUTransferBufferLocation

All Implemented Interfaces:

IPointer, ISDL_GPUTransferBufferLocation

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUTransferBufferLocation(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUTransferBufferLocation

A structure specifying a location in a transfer buffer.

Used when transferring buffer data to or from a transfer buffer.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_UploadToGPUBuffer
• SDL_DownloadFromGPUBuffer

Structure

typedef struct SDL_GPUTransferBufferLocation {
    SDL_GPUTransferBuffer* transfer_buffer;
    Uint32 offset;
} SDL_GPUTransferBufferLocation;

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_GPUTransferBufferLocation.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 AddressLayout	LAYOUT$transfer_buffer
static final long	OFFSET$offset
static final long	OFFSET$transfer_buffer
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$transfer_buffer
static final long	SIZE$offset
static final long	SIZE$transfer_buffer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUTransferBufferLocation	allocate(Arena arena)
static SDL_GPUTransferBufferLocation.Ptr	allocate(Arena arena, long count)
static SDL_GPUTransferBufferLocation	clone(Arena arena, SDL_GPUTransferBufferLocation 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_GPUTransferBufferLocation	offset(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_GPUTransferBufferLocation	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

LAYOUT$transfer_buffer

public static final AddressLayout LAYOUT$transfer_buffer

LAYOUT$offset

public static final ValueLayout.OfInt LAYOUT$offset

SIZE$transfer_buffer

public static final long SIZE$transfer_buffer

SIZE$offset

public static final long SIZE$offset

OFFSET$transfer_buffer

public static final long OFFSET$transfer_buffer

OFFSET$offset

public static final long OFFSET$offset

Constructor Details

SDL_GPUTransferBufferLocation

public SDL_GPUTransferBufferLocation(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUTransferBufferLocation record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUTransferBufferLocation allocate(Arena arena)

allocate

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

clone

public static SDL_GPUTransferBufferLocation clone(Arena arena,
 SDL_GPUTransferBufferLocation src)

transfer_buffer

@Nullable
public @Nullable SDL_GPUTransferBuffer transfer_buffer()

transfer_buffer

public SDL_GPUTransferBufferLocation transfer_buffer(@Nullable
 @Nullable SDL_GPUTransferBuffer value)

offset

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

offset

public SDL_GPUTransferBufferLocation offset(@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