Record Class SDL_GPUTextureLocation

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUTextureLocation

All Implemented Interfaces:

IPointer, ISDL_GPUTextureLocation

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUTextureLocation(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUTextureLocation

A structure specifying a location in a texture.

Used when copying data from one texture to another.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_CopyGPUTextureToTexture

Structure

typedef struct SDL_GPUTextureLocation {
    SDL_GPUTexture* texture;
    Uint32 mip_level;
    Uint32 layer;
    Uint32 x;
    Uint32 y;
    Uint32 z;
} SDL_GPUTextureLocation;

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_GPUTextureLocation.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$layer
static final ValueLayout.OfInt	LAYOUT$mip_level
static final AddressLayout	LAYOUT$texture
static final ValueLayout.OfInt	LAYOUT$x
static final ValueLayout.OfInt	LAYOUT$y
static final ValueLayout.OfInt	LAYOUT$z
static final long	OFFSET$layer
static final long	OFFSET$mip_level
static final long	OFFSET$texture
static final long	OFFSET$x
static final long	OFFSET$y
static final long	OFFSET$z
static final MemoryLayout.PathElement	PATH$layer
static final MemoryLayout.PathElement	PATH$mip_level
static final MemoryLayout.PathElement	PATH$texture
static final MemoryLayout.PathElement	PATH$x
static final MemoryLayout.PathElement	PATH$y
static final MemoryLayout.PathElement	PATH$z
static final long	SIZE$layer
static final long	SIZE$mip_level
static final long	SIZE$texture
static final long	SIZE$x
static final long	SIZE$y
static final long	SIZE$z

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUTextureLocation	allocate(Arena arena)
static SDL_GPUTextureLocation.Ptr	allocate(Arena arena, long count)
static SDL_GPUTextureLocation	clone(Arena arena, SDL_GPUTextureLocation 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	layer()
SDL_GPUTextureLocation	layer(int value)
int	mip_level()
SDL_GPUTextureLocation	mip_level(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable SDL_GPUTexture	texture()
SDL_GPUTextureLocation	texture(@Nullable SDL_GPUTexture value)
final String	toString()	Returns a string representation of this record class.
int	x()
SDL_GPUTextureLocation	x(int value)
int	y()
SDL_GPUTextureLocation	y(int value)
int	z()
SDL_GPUTextureLocation	z(int 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$texture

public static final MemoryLayout.PathElement PATH$texture

PATH$mip_level

public static final MemoryLayout.PathElement PATH$mip_level

PATH$layer

public static final MemoryLayout.PathElement PATH$layer

PATH$x

public static final MemoryLayout.PathElement PATH$x

PATH$y

public static final MemoryLayout.PathElement PATH$y

PATH$z

public static final MemoryLayout.PathElement PATH$z

LAYOUT$texture

public static final AddressLayout LAYOUT$texture

LAYOUT$mip_level

public static final ValueLayout.OfInt LAYOUT$mip_level

LAYOUT$layer

public static final ValueLayout.OfInt LAYOUT$layer

LAYOUT$x

public static final ValueLayout.OfInt LAYOUT$x

LAYOUT$y

public static final ValueLayout.OfInt LAYOUT$y

LAYOUT$z

public static final ValueLayout.OfInt LAYOUT$z

SIZE$texture

public static final long SIZE$texture

SIZE$mip_level

public static final long SIZE$mip_level

SIZE$layer

public static final long SIZE$layer

SIZE$x

public static final long SIZE$x

SIZE$y

public static final long SIZE$y

SIZE$z

public static final long SIZE$z

OFFSET$texture

public static final long OFFSET$texture

OFFSET$mip_level

public static final long OFFSET$mip_level

OFFSET$layer

public static final long OFFSET$layer

OFFSET$x

public static final long OFFSET$x

OFFSET$y

public static final long OFFSET$y

OFFSET$z

public static final long OFFSET$z

Constructor Details

SDL_GPUTextureLocation

public SDL_GPUTextureLocation(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUTextureLocation record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUTextureLocation allocate(Arena arena)

allocate

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

clone

public static SDL_GPUTextureLocation clone(Arena arena,
 SDL_GPUTextureLocation src)

texture

@Nullable
public @Nullable SDL_GPUTexture texture()

texture

public SDL_GPUTextureLocation texture(@Nullable
 @Nullable SDL_GPUTexture value)

mip_level

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

mip_level

public SDL_GPUTextureLocation mip_level(@NativeType("Uint32") @Unsigned
 int value)

layer

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

layer

public SDL_GPUTextureLocation layer(@NativeType("Uint32") @Unsigned
 int value)

x

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

x

public SDL_GPUTextureLocation x(@NativeType("Uint32") @Unsigned
 int value)

y

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

y

public SDL_GPUTextureLocation y(@NativeType("Uint32") @Unsigned
 int value)

z

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

z

public SDL_GPUTextureLocation z(@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