Record Class SDL_GPUBufferCreateInfo

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUBufferCreateInfo

All Implemented Interfaces:

IPointer, ISDL_GPUBufferCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUBufferCreateInfo(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUBufferCreateInfo

A structure specifying the parameters of a buffer.

Usage flags can be bitwise OR'd together for combinations of usages. Note that certain combinations are invalid, for example VERTEX and INDEX.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_CreateGPUBuffer
• SDL_GPUBufferUsageFlags

Structure

typedef struct SDL_GPUBufferCreateInfo {
    SDL_GPUBufferUsageFlags usage;
    Uint32 size;
    SDL_PropertiesID props;
} SDL_GPUBufferCreateInfo;

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_GPUBufferCreateInfo.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$props
static final ValueLayout.OfInt	LAYOUT$size
static final ValueLayout.OfInt	LAYOUT$usage
static final long	OFFSET$props
static final long	OFFSET$size
static final long	OFFSET$usage
static final MemoryLayout.PathElement	PATH$props
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$usage
static final long	SIZE$props
static final long	SIZE$size
static final long	SIZE$usage

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUBufferCreateInfo	allocate(Arena arena)
static SDL_GPUBufferCreateInfo.Ptr	allocate(Arena arena, long count)
static SDL_GPUBufferCreateInfo	clone(Arena arena, SDL_GPUBufferCreateInfo 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	props()
SDL_GPUBufferCreateInfo	props(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	size()
SDL_GPUBufferCreateInfo	size(int value)
final String	toString()	Returns a string representation of this record class.
int	usage()
SDL_GPUBufferCreateInfo	usage(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$usage

public static final MemoryLayout.PathElement PATH$usage

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$props

public static final MemoryLayout.PathElement PATH$props

LAYOUT$usage

public static final ValueLayout.OfInt LAYOUT$usage

LAYOUT$size

public static final ValueLayout.OfInt LAYOUT$size

LAYOUT$props

public static final ValueLayout.OfInt LAYOUT$props

SIZE$usage

public static final long SIZE$usage

SIZE$size

public static final long SIZE$size

SIZE$props

public static final long SIZE$props

OFFSET$usage

public static final long OFFSET$usage

OFFSET$size

public static final long OFFSET$size

OFFSET$props

public static final long OFFSET$props

Constructor Details

SDL_GPUBufferCreateInfo

public SDL_GPUBufferCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUBufferCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUBufferCreateInfo allocate(Arena arena)

allocate

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

clone

public static SDL_GPUBufferCreateInfo clone(Arena arena,
 SDL_GPUBufferCreateInfo src)

usage

@EnumType(SDL_GPUBufferUsageFlags.class)
public int usage()

usage

public SDL_GPUBufferCreateInfo usage(@EnumType(SDL_GPUBufferUsageFlags.class)
 int value)

size

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

size

public SDL_GPUBufferCreateInfo size(@NativeType("Uint32") @Unsigned
 int value)

props

@NativeType("SDL_PropertiesID")
@Unsigned
public int props()

props

public SDL_GPUBufferCreateInfo props(@NativeType("SDL_PropertiesID") @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