Record Class SDL_hid_device_info

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_hid_device_info

All Implemented Interfaces:

IPointer, ISDL_hid_device_info

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_hid_device_info(@NotNull MemorySegment segment)
extends Record
implements ISDL_hid_device_info

Information about a connected HID device

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_hid_device_info {
    char* path;
    short vendor_id;
    short product_id;
    wchar_t* serial_number;
    short release_number;
    wchar_t* manufacturer_string;
    wchar_t* product_string;
    short usage_page;
    short usage;
    int interface_number;
    int interface_class;
    int interface_subclass;
    int interface_protocol;
    SDL_hid_bus_type bus_type;
    SDL_hid_device_info* next;
} SDL_hid_device_info;

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.

Member documentation

• path() Platform-specific device path
• vendor_id() Device Vendor ID
• product_id() Device Product ID
• serial_number() Serial Number
• release_number() Device Release Number in binary-coded decimal, also known as Device Version Number
• manufacturer_string() Manufacturer String
• product_string() Product string
• usage_page() Usage Page for this Device/Interface (Windows/Mac/hidraw only)
• usage() Usage for this Device/Interface (Windows/Mac/hidraw only)
• interface_number() The USB interface which this logical device represents.

  Valid only if the device is a USB HID device. Set to -1 in all other cases.

• interface_class() Additional information about the USB interface. Valid on libusb and Android implementations.
• bus_type() Underlying bus type
• next(club.doki7.sdl3.datatype.ISDL_hid_device_info) Pointer to the next device

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SDL_hid_device_info.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$bus_type
static final ValueLayout.OfInt	LAYOUT$interface_class
static final ValueLayout.OfInt	LAYOUT$interface_number
static final ValueLayout.OfInt	LAYOUT$interface_protocol
static final ValueLayout.OfInt	LAYOUT$interface_subclass
static final AddressLayout	LAYOUT$manufacturer_string
static final AddressLayout	LAYOUT$next
static final AddressLayout	LAYOUT$path
static final ValueLayout.OfShort	LAYOUT$product_id
static final AddressLayout	LAYOUT$product_string
static final ValueLayout.OfShort	LAYOUT$release_number
static final AddressLayout	LAYOUT$serial_number
static final ValueLayout.OfShort	LAYOUT$usage
static final ValueLayout.OfShort	LAYOUT$usage_page
static final ValueLayout.OfShort	LAYOUT$vendor_id
static final long	OFFSET$bus_type
static final long	OFFSET$interface_class
static final long	OFFSET$interface_number
static final long	OFFSET$interface_protocol
static final long	OFFSET$interface_subclass
static final long	OFFSET$manufacturer_string
static final long	OFFSET$next
static final long	OFFSET$path
static final long	OFFSET$product_id
static final long	OFFSET$product_string
static final long	OFFSET$release_number
static final long	OFFSET$serial_number
static final long	OFFSET$usage
static final long	OFFSET$usage_page
static final long	OFFSET$vendor_id
static final MemoryLayout.PathElement	PATH$bus_type
static final MemoryLayout.PathElement	PATH$interface_class
static final MemoryLayout.PathElement	PATH$interface_number
static final MemoryLayout.PathElement	PATH$interface_protocol
static final MemoryLayout.PathElement	PATH$interface_subclass
static final MemoryLayout.PathElement	PATH$manufacturer_string
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$path
static final MemoryLayout.PathElement	PATH$product_id
static final MemoryLayout.PathElement	PATH$product_string
static final MemoryLayout.PathElement	PATH$release_number
static final MemoryLayout.PathElement	PATH$serial_number
static final MemoryLayout.PathElement	PATH$usage
static final MemoryLayout.PathElement	PATH$usage_page
static final MemoryLayout.PathElement	PATH$vendor_id
static final long	SIZE$bus_type
static final long	SIZE$interface_class
static final long	SIZE$interface_number
static final long	SIZE$interface_protocol
static final long	SIZE$interface_subclass
static final long	SIZE$manufacturer_string
static final long	SIZE$next
static final long	SIZE$path
static final long	SIZE$product_id
static final long	SIZE$product_string
static final long	SIZE$release_number
static final long	SIZE$serial_number
static final long	SIZE$usage
static final long	SIZE$usage_page
static final long	SIZE$vendor_id

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_hid_device_info	allocate(Arena arena)
static SDL_hid_device_info.Ptr	allocate(Arena arena, long count)
int	bus_type()
SDL_hid_device_info	bus_type(int value)
static SDL_hid_device_info	clone(Arena arena, SDL_hid_device_info 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	interface_class()
SDL_hid_device_info	interface_class(int value)
int	interface_number()
SDL_hid_device_info	interface_number(int value)
int	interface_protocol()
SDL_hid_device_info	interface_protocol(int value)
int	interface_subclass()
SDL_hid_device_info	interface_subclass(int value)
MemorySegment	manufacturer_string()
SDL_hid_device_info	manufacturer_string(@Nullable IPointer pointer)
void	manufacturer_string(MemorySegment value)
@Nullable SDL_hid_device_info	next()
SDL_hid_device_info.Ptr	next(int assumedCount)
SDL_hid_device_info	next(@Nullable ISDL_hid_device_info value)
MemorySegment	nextRaw()
void	nextRaw(MemorySegment value)
@Nullable BytePtr	path()	Note: the returned BytePtr does not have correct BytePtr.size() property.
SDL_hid_device_info	path(@Nullable BytePtr value)
MemorySegment	pathRaw()
void	pathRaw(MemorySegment value)
short	product_id()
SDL_hid_device_info	product_id(short value)
MemorySegment	product_string()
SDL_hid_device_info	product_string(@Nullable IPointer pointer)
void	product_string(MemorySegment value)
short	release_number()
SDL_hid_device_info	release_number(short value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
MemorySegment	serial_number()
SDL_hid_device_info	serial_number(@Nullable IPointer pointer)
void	serial_number(MemorySegment value)
final String	toString()	Returns a string representation of this record class.
short	usage()
SDL_hid_device_info	usage(short value)
short	usage_page()
SDL_hid_device_info	usage_page(short value)
short	vendor_id()
SDL_hid_device_info	vendor_id(short 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$path

public static final MemoryLayout.PathElement PATH$path

PATH$vendor_id

public static final MemoryLayout.PathElement PATH$vendor_id

PATH$product_id

public static final MemoryLayout.PathElement PATH$product_id

PATH$serial_number

public static final MemoryLayout.PathElement PATH$serial_number

PATH$release_number

public static final MemoryLayout.PathElement PATH$release_number

PATH$manufacturer_string

public static final MemoryLayout.PathElement PATH$manufacturer_string

PATH$product_string

public static final MemoryLayout.PathElement PATH$product_string

PATH$usage_page

public static final MemoryLayout.PathElement PATH$usage_page

PATH$usage

public static final MemoryLayout.PathElement PATH$usage

PATH$interface_number

public static final MemoryLayout.PathElement PATH$interface_number

PATH$interface_class

public static final MemoryLayout.PathElement PATH$interface_class

PATH$interface_subclass

public static final MemoryLayout.PathElement PATH$interface_subclass

PATH$interface_protocol

public static final MemoryLayout.PathElement PATH$interface_protocol

PATH$bus_type

public static final MemoryLayout.PathElement PATH$bus_type

PATH$next

public static final MemoryLayout.PathElement PATH$next

LAYOUT$path

public static final AddressLayout LAYOUT$path

LAYOUT$vendor_id

public static final ValueLayout.OfShort LAYOUT$vendor_id

LAYOUT$product_id

public static final ValueLayout.OfShort LAYOUT$product_id

LAYOUT$serial_number

public static final AddressLayout LAYOUT$serial_number

LAYOUT$release_number

public static final ValueLayout.OfShort LAYOUT$release_number

LAYOUT$manufacturer_string

public static final AddressLayout LAYOUT$manufacturer_string

LAYOUT$product_string

public static final AddressLayout LAYOUT$product_string

LAYOUT$usage_page

public static final ValueLayout.OfShort LAYOUT$usage_page

LAYOUT$usage

public static final ValueLayout.OfShort LAYOUT$usage

LAYOUT$interface_number

public static final ValueLayout.OfInt LAYOUT$interface_number

LAYOUT$interface_class

public static final ValueLayout.OfInt LAYOUT$interface_class

LAYOUT$interface_subclass

public static final ValueLayout.OfInt LAYOUT$interface_subclass

LAYOUT$interface_protocol

public static final ValueLayout.OfInt LAYOUT$interface_protocol

LAYOUT$bus_type

public static final ValueLayout.OfInt LAYOUT$bus_type

LAYOUT$next

public static final AddressLayout LAYOUT$next

SIZE$path

public static final long SIZE$path

SIZE$vendor_id

public static final long SIZE$vendor_id

SIZE$product_id

public static final long SIZE$product_id

SIZE$serial_number

public static final long SIZE$serial_number

SIZE$release_number

public static final long SIZE$release_number

SIZE$manufacturer_string

public static final long SIZE$manufacturer_string

SIZE$product_string

public static final long SIZE$product_string

SIZE$usage_page

public static final long SIZE$usage_page

SIZE$usage

public static final long SIZE$usage

SIZE$interface_number

public static final long SIZE$interface_number

SIZE$interface_class

public static final long SIZE$interface_class

SIZE$interface_subclass

public static final long SIZE$interface_subclass

SIZE$interface_protocol

public static final long SIZE$interface_protocol

SIZE$bus_type

public static final long SIZE$bus_type

SIZE$next

public static final long SIZE$next

OFFSET$path

public static final long OFFSET$path

OFFSET$vendor_id

public static final long OFFSET$vendor_id

OFFSET$product_id

public static final long OFFSET$product_id

OFFSET$serial_number

public static final long OFFSET$serial_number

OFFSET$release_number

public static final long OFFSET$release_number

OFFSET$manufacturer_string

public static final long OFFSET$manufacturer_string

OFFSET$product_string

public static final long OFFSET$product_string

OFFSET$usage_page

public static final long OFFSET$usage_page

OFFSET$usage

public static final long OFFSET$usage

OFFSET$interface_number

public static final long OFFSET$interface_number

OFFSET$interface_class

public static final long OFFSET$interface_class

OFFSET$interface_subclass

public static final long OFFSET$interface_subclass

OFFSET$interface_protocol

public static final long OFFSET$interface_protocol

OFFSET$bus_type

public static final long OFFSET$bus_type

OFFSET$next

public static final long OFFSET$next

Constructor Details

SDL_hid_device_info

public SDL_hid_device_info(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_hid_device_info record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_hid_device_info allocate(Arena arena)

allocate

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

clone

public static SDL_hid_device_info clone(Arena arena,
 SDL_hid_device_info src)

path

@Nullable
public @Nullable BytePtr path()

Note: the returned BytePtr does not have correct BytePtr.size() property. It's up to user to track the size of the buffer, and use BytePtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

path

public SDL_hid_device_info path(@Nullable
 @Nullable BytePtr value)

pathRaw

@Pointer(comment="int8_t*")
public MemorySegment pathRaw()

pathRaw

public void pathRaw(@Pointer(comment="int8_t*")
 MemorySegment value)

vendor_id

public short vendor_id()

vendor_id

public SDL_hid_device_info vendor_id(short value)

product_id

public short product_id()

product_id

public SDL_hid_device_info product_id(short value)

serial_number

@Pointer(comment="wchar_t*")
public MemorySegment serial_number()

serial_number

public void serial_number(@Pointer(comment="wchar_t*")
 MemorySegment value)

serial_number

public SDL_hid_device_info serial_number(@Nullable
 @Nullable IPointer pointer)

release_number

public short release_number()

release_number

public SDL_hid_device_info release_number(short value)

manufacturer_string

@Pointer(comment="wchar_t*")
public MemorySegment manufacturer_string()

manufacturer_string

public void manufacturer_string(@Pointer(comment="wchar_t*")
 MemorySegment value)

manufacturer_string

public SDL_hid_device_info manufacturer_string(@Nullable
 @Nullable IPointer pointer)

product_string

@Pointer(comment="wchar_t*")
public MemorySegment product_string()

product_string

public void product_string(@Pointer(comment="wchar_t*")
 MemorySegment value)

product_string

public SDL_hid_device_info product_string(@Nullable
 @Nullable IPointer pointer)

usage_page

public short usage_page()

usage_page

public SDL_hid_device_info usage_page(short value)

usage

public short usage()

usage

public SDL_hid_device_info usage(short value)

interface_number

public int interface_number()

interface_number

public SDL_hid_device_info interface_number(int value)

interface_class

public int interface_class()

interface_class

public SDL_hid_device_info interface_class(int value)

interface_subclass

public int interface_subclass()

interface_subclass

public SDL_hid_device_info interface_subclass(int value)

interface_protocol

public int interface_protocol()

interface_protocol

public SDL_hid_device_info interface_protocol(int value)

bus_type

@EnumType(SDL_hid_bus_type.class)
public int bus_type()

bus_type

public SDL_hid_device_info bus_type(@EnumType(SDL_hid_bus_type.class)
 int value)

next

public SDL_hid_device_info next(@Nullable
 @Nullable ISDL_hid_device_info value)

next

@Unsafe
@Nullable
public SDL_hid_device_info.Ptr next(int assumedCount)

next

@Nullable
public @Nullable SDL_hid_device_info next()

nextRaw

@Pointer(target=SDL_hid_device_info.class)
public MemorySegment nextRaw()

nextRaw

public void nextRaw(@Pointer(target=SDL_hid_device_info.class)
 MemorySegment 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