Record Class ShadercIncludeResult

java.lang.Object

java.lang.Record

club.doki7.shaderc.datatype.ShadercIncludeResult

All Implemented Interfaces:

IPointer, IShadercIncludeResult

@ValueBasedCandidate
@UnsafeConstructor
public record ShadercIncludeResult(@NotNull MemorySegment segment)
extends Record
implements IShadercIncludeResult

Represents a pointer to a shaderc_include_result structure in native memory.

Structure

typedef struct shaderc_include_result {
    char const* sourceName;
    size_t sourceNameLength;
    char const* content;
    size_t contentLength;
    void* userData;
} shaderc_include_result;

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	ShadercIncludeResult.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 AddressLayout	LAYOUT$content
static final AddressLayout	LAYOUT$sourceName
static final AddressLayout	LAYOUT$userData
static final long	OFFSET$content
static final long	OFFSET$contentLength
static final long	OFFSET$sourceName
static final long	OFFSET$sourceNameLength
static final long	OFFSET$userData
static final MemoryLayout.PathElement	PATH$content
static final MemoryLayout.PathElement	PATH$contentLength
static final MemoryLayout.PathElement	PATH$sourceName
static final MemoryLayout.PathElement	PATH$sourceNameLength
static final MemoryLayout.PathElement	PATH$userData
static final long	SIZE$content
static final long	SIZE$contentLength
static final long	SIZE$sourceName
static final long	SIZE$sourceNameLength
static final long	SIZE$userData

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ShadercIncludeResult	allocate(Arena arena)
static ShadercIncludeResult.Ptr	allocate(Arena arena, long count)
static ShadercIncludeResult	clone(Arena arena, ShadercIncludeResult src)
@Nullable BytePtr	content()	Note: the returned BytePtr does not have correct BytePtr.size() property.
ShadercIncludeResult	content(@Nullable BytePtr value)
long	contentLength()
ShadercIncludeResult	contentLength(long value)
@NotNull MemorySegment	contentRaw()
void	contentRaw(@NotNull MemorySegment value)
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.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable BytePtr	sourceName()	Note: the returned BytePtr does not have correct BytePtr.size() property.
ShadercIncludeResult	sourceName(@Nullable BytePtr value)
long	sourceNameLength()
ShadercIncludeResult	sourceNameLength(long value)
@NotNull MemorySegment	sourceNameRaw()
void	sourceNameRaw(@NotNull MemorySegment value)
final String	toString()	Returns a string representation of this record class.
@NotNull MemorySegment	userData()
ShadercIncludeResult	userData(@Nullable IPointer pointer)
ShadercIncludeResult	userData(@NotNull MemorySegment 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$sourceName

public static final MemoryLayout.PathElement PATH$sourceName

PATH$sourceNameLength

public static final MemoryLayout.PathElement PATH$sourceNameLength

PATH$content

public static final MemoryLayout.PathElement PATH$content

PATH$contentLength

public static final MemoryLayout.PathElement PATH$contentLength

PATH$userData

public static final MemoryLayout.PathElement PATH$userData

LAYOUT$sourceName

public static final AddressLayout LAYOUT$sourceName

LAYOUT$content

public static final AddressLayout LAYOUT$content

LAYOUT$userData

public static final AddressLayout LAYOUT$userData

SIZE$sourceName

public static final long SIZE$sourceName

SIZE$sourceNameLength

public static final long SIZE$sourceNameLength

SIZE$content

public static final long SIZE$content

SIZE$contentLength

public static final long SIZE$contentLength

SIZE$userData

public static final long SIZE$userData

OFFSET$sourceName

public static final long OFFSET$sourceName

OFFSET$sourceNameLength

public static final long OFFSET$sourceNameLength

OFFSET$content

public static final long OFFSET$content

OFFSET$contentLength

public static final long OFFSET$contentLength

OFFSET$userData

public static final long OFFSET$userData

Constructor Details

ShadercIncludeResult

public ShadercIncludeResult(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a ShadercIncludeResult record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static ShadercIncludeResult allocate(Arena arena)

allocate

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

clone

public static ShadercIncludeResult clone(Arena arena,
 ShadercIncludeResult src)

sourceName

@Nullable
public @Nullable BytePtr sourceName()

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.

sourceName

public ShadercIncludeResult sourceName(@Nullable
 @Nullable BytePtr value)

sourceNameRaw

@Pointer(comment="int8_t*")
@NotNull
public @NotNull MemorySegment sourceNameRaw()

sourceNameRaw

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

sourceNameLength

@Unsigned
public long sourceNameLength()

sourceNameLength

public ShadercIncludeResult sourceNameLength(@Unsigned
 long value)

content

@Nullable
public @Nullable BytePtr content()

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.

content

public ShadercIncludeResult content(@Nullable
 @Nullable BytePtr value)

contentRaw

@Pointer(comment="int8_t*")
@NotNull
public @NotNull MemorySegment contentRaw()

contentRaw

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

contentLength

@Unsigned
public long contentLength()

contentLength

public ShadercIncludeResult contentLength(@Unsigned
 long value)

userData

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment userData()

userData

public ShadercIncludeResult userData(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

userData

public ShadercIncludeResult userData(@Nullable
 @Nullable IPointer pointer)

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