Record Class CLMutableDispatchConfigKhr
java.lang.Object
java.lang.Record
club.doki7.opencl.datatype.CLMutableDispatchConfigKhr
- All Implemented Interfaces:
IPointer
,ICLMutableDispatchConfigKhr
@ValueBasedCandidate
@UnsafeConstructor
public record CLMutableDispatchConfigKhr(@NotNull MemorySegment segment)
extends Record
implements ICLMutableDispatchConfigKhr
Represents a pointer to a cl_mutable_dispatch_config_khr structure in native memory.
Structure
typedef struct cl_mutable_dispatch_config_khr {
cl_mutable_command
_khr command
;
cl_uint numArgs
;
cl_uint numSvmArgs
;
cl_uint numExecInfos
;
cl_uint workDim
;
cl_mutable_dispatch_arg_khr const* argList
;
cl_mutable_dispatch_arg_khr const* argSvmList
;
cl_mutable_dispatch_exec_info_khr const* execInfoList
;
size_t const* globalWorkOffset
;
size_t const* globalWorkSize
;
size_t const* localWorkSize
;
} cl_mutable_dispatch_config_khr;
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.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final record
Represents a pointer to / an array of cl_mutable_dispatch_config_khr structure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final long
static final StructLayout
static final AddressLayout
static final AddressLayout
static final AddressLayout
static final AddressLayout
static final AddressLayout
static final AddressLayout
static final AddressLayout
static final ValueLayout.OfInt
static final ValueLayout.OfInt
static final ValueLayout.OfInt
static final ValueLayout.OfInt
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
-
Constructor Summary
ConstructorsConstructorDescriptionCLMutableDispatchConfigKhr
(@NotNull MemorySegment segment) Creates an instance of aCLMutableDispatchConfigKhr
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic CLMutableDispatchConfigKhr
@Nullable CLMutableDispatchArgKhr
argList()
argList
(int assumedCount) argList
(@Nullable ICLMutableDispatchArgKhr value) @NotNull MemorySegment
void
argListRaw
(@NotNull MemorySegment value) @Nullable CLMutableDispatchArgKhr
argSvmList
(int assumedCount) argSvmList
(@Nullable ICLMutableDispatchArgKhr value) @NotNull MemorySegment
void
argSvmListRaw
(@NotNull MemorySegment value) static CLMutableDispatchConfigKhr
clone
(Arena arena, CLMutableDispatchConfigKhr src) @Nullable CLMutableCommandKhr
command()
command
(@Nullable CLMutableCommandKhr value) final boolean
Indicates whether some other object is "equal to" this one.@Nullable CLMutableDispatchExecInfoKhr
execInfoList
(int assumedCount) execInfoList
(@Nullable ICLMutableDispatchExecInfoKhr value) @NotNull MemorySegment
void
execInfoListRaw
(@NotNull MemorySegment value) @Nullable PointerPtr
Note: the returnedPointerPtr
does not have correctPointerPtr.size()
property.globalWorkOffset
(@Nullable PointerPtr value) @NotNull MemorySegment
void
globalWorkOffsetRaw
(@NotNull MemorySegment value) @Nullable PointerPtr
Note: the returnedPointerPtr
does not have correctPointerPtr.size()
property.globalWorkSize
(@Nullable PointerPtr value) @NotNull MemorySegment
void
globalWorkSizeRaw
(@NotNull MemorySegment value) final int
hashCode()
Returns a hash code value for this object.@Nullable PointerPtr
Note: the returnedPointerPtr
does not have correctPointerPtr.size()
property.localWorkSize
(@Nullable PointerPtr value) @NotNull MemorySegment
void
localWorkSizeRaw
(@NotNull MemorySegment value) int
numArgs()
numArgs
(int value) int
numExecInfos
(int value) int
numSvmArgs
(int value) @NotNull MemorySegment
segment()
Returns the value of thesegment
record component.final String
toString()
Returns a string representation of this record class.int
workDim()
workDim
(int value)
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$command
-
PATH$numArgs
-
PATH$numSvmArgs
-
PATH$numExecInfos
-
PATH$workDim
-
PATH$argList
-
PATH$argSvmList
-
PATH$execInfoList
-
PATH$globalWorkOffset
-
PATH$globalWorkSize
-
PATH$localWorkSize
-
LAYOUT$command
-
LAYOUT$numArgs
-
LAYOUT$numSvmArgs
-
LAYOUT$numExecInfos
-
LAYOUT$workDim
-
LAYOUT$argList
-
LAYOUT$argSvmList
-
LAYOUT$execInfoList
-
LAYOUT$globalWorkOffset
-
LAYOUT$globalWorkSize
-
LAYOUT$localWorkSize
-
SIZE$command
public static final long SIZE$command -
SIZE$numArgs
public static final long SIZE$numArgs -
SIZE$numSvmArgs
public static final long SIZE$numSvmArgs -
SIZE$numExecInfos
public static final long SIZE$numExecInfos -
SIZE$workDim
public static final long SIZE$workDim -
SIZE$argList
public static final long SIZE$argList -
SIZE$argSvmList
public static final long SIZE$argSvmList -
SIZE$execInfoList
public static final long SIZE$execInfoList -
SIZE$globalWorkOffset
public static final long SIZE$globalWorkOffset -
SIZE$globalWorkSize
public static final long SIZE$globalWorkSize -
SIZE$localWorkSize
public static final long SIZE$localWorkSize -
OFFSET$command
public static final long OFFSET$command -
OFFSET$numArgs
public static final long OFFSET$numArgs -
OFFSET$numSvmArgs
public static final long OFFSET$numSvmArgs -
OFFSET$numExecInfos
public static final long OFFSET$numExecInfos -
OFFSET$workDim
public static final long OFFSET$workDim -
OFFSET$argList
public static final long OFFSET$argList -
OFFSET$argSvmList
public static final long OFFSET$argSvmList -
OFFSET$execInfoList
public static final long OFFSET$execInfoList -
OFFSET$globalWorkOffset
public static final long OFFSET$globalWorkOffset -
OFFSET$globalWorkSize
public static final long OFFSET$globalWorkSize -
OFFSET$localWorkSize
public static final long OFFSET$localWorkSize
-
-
Constructor Details
-
CLMutableDispatchConfigKhr
Creates an instance of aCLMutableDispatchConfigKhr
record class.- Parameters:
segment
- the value for thesegment
record component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
command
-
command
-
numArgs
-
numArgs
-
numSvmArgs
-
numSvmArgs
-
numExecInfos
-
numExecInfos
-
workDim
-
workDim
-
argList
-
argList
-
argList
-
argListRaw
-
argListRaw
public void argListRaw(@Pointer(target=CLMutableDispatchArgKhr.class) @NotNull @NotNull MemorySegment value) -
argSvmList
-
argSvmList
-
argSvmList
-
argSvmListRaw
@Pointer(target=CLMutableDispatchArgKhr.class) @NotNull public @NotNull MemorySegment argSvmListRaw() -
argSvmListRaw
public void argSvmListRaw(@Pointer(target=CLMutableDispatchArgKhr.class) @NotNull @NotNull MemorySegment value) -
execInfoList
public CLMutableDispatchConfigKhr execInfoList(@Nullable @Nullable ICLMutableDispatchExecInfoKhr value) -
execInfoList
-
execInfoList
-
execInfoListRaw
@Pointer(target=CLMutableDispatchExecInfoKhr.class) @NotNull public @NotNull MemorySegment execInfoListRaw() -
execInfoListRaw
public void execInfoListRaw(@Pointer(target=CLMutableDispatchExecInfoKhr.class) @NotNull @NotNull MemorySegment value) -
globalWorkOffset
Note: the returnedPointerPtr
does not have correctPointerPtr.size()
property. It's up to user to track the size of the buffer, and usePointerPtr.reinterpret(long)
to set the size before actually reading from or writing to the buffer. -
globalWorkOffset
-
globalWorkOffsetRaw
-
globalWorkOffsetRaw
-
globalWorkSize
Note: the returnedPointerPtr
does not have correctPointerPtr.size()
property. It's up to user to track the size of the buffer, and usePointerPtr.reinterpret(long)
to set the size before actually reading from or writing to the buffer. -
globalWorkSize
-
globalWorkSizeRaw
-
globalWorkSizeRaw
-
localWorkSize
Note: the returnedPointerPtr
does not have correctPointerPtr.size()
property. It's up to user to track the size of the buffer, and usePointerPtr.reinterpret(long)
to set the size before actually reading from or writing to the buffer. -
localWorkSize
-
localWorkSizeRaw
-
localWorkSizeRaw
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object)
. -
segment
Returns the value of thesegment
record component.
-