Record Class WGPURenderBundleEncoderDescriptor
java.lang.Object
java.lang.Record
club.doki7.webgpu.datatype.WGPURenderBundleEncoderDescriptor
- All Implemented Interfaces:
IPointer,IWGPURenderBundleEncoderDescriptor
@ValueBasedCandidate
@UnsafeConstructor
public record WGPURenderBundleEncoderDescriptor(@NotNull MemorySegment segment)
extends Record
implements IWGPURenderBundleEncoderDescriptor
Represents a pointer to a WGPURenderBundleEncoderDescriptor structure in native memory.
Structure
typedef struct WGPURenderBundleEncoderDescriptor {
WGPUChainedStruct const* nextInChain; // optional
WGPUStringView label;
size_t colorFormatCount;
WGPUTextureFormat const* colorFormats;
WGPUTextureFormat depthStencilFormat;
uint32_t sampleCount;
WGPUBool depthReadOnly;
WGPUBool stencilReadOnly;
} WGPURenderBundleEncoderDescriptor;
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 ClassesModifier and TypeClassDescriptionstatic final recordRepresents a pointer to / an array of null structure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final longstatic final StructLayoutstatic final AddressLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final StructLayoutstatic final AddressLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final long -
Constructor Summary
ConstructorsConstructorDescriptionWGPURenderBundleEncoderDescriptor(@NotNull MemorySegment segment) Creates an instance of aWGPURenderBundleEncoderDescriptorrecord class. -
Method Summary
Modifier and TypeMethodDescriptionclone(Arena arena, WGPURenderBundleEncoderDescriptor src) longcolorFormatCount(long value) @Nullable IntPtrNote: the returnedIntPtrdoes not have correctIntPtr.size()property.colorFormats(@Nullable IntPtr value) @NotNull MemorySegmentvoidcolorFormatsRaw(@NotNull MemorySegment value) intdepthReadOnly(int value) intdepthStencilFormat(int value) final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.@NotNull WGPUStringViewlabel()label(@NotNull WGPUStringView value) label(Consumer<@NotNull WGPUStringView> consumer) @Nullable WGPUChainedStructnextInChain(int assumedCount) nextInChain(@Nullable IWGPUChainedStruct value) @NotNull MemorySegmentvoidnextInChainRaw(@NotNull MemorySegment value) intsampleCount(int value) @NotNull MemorySegmentsegment()Returns the value of thesegmentrecord component.intstencilReadOnly(int value) final StringtoString()Returns a string representation of this record class.
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$nextInChain
-
PATH$label
-
PATH$colorFormatCount
-
PATH$colorFormats
-
PATH$depthStencilFormat
-
PATH$sampleCount
-
PATH$depthReadOnly
-
PATH$stencilReadOnly
-
LAYOUT$nextInChain
-
LAYOUT$label
-
LAYOUT$colorFormats
-
LAYOUT$depthStencilFormat
-
LAYOUT$sampleCount
-
LAYOUT$depthReadOnly
-
LAYOUT$stencilReadOnly
-
SIZE$nextInChain
public static final long SIZE$nextInChain -
SIZE$label
public static final long SIZE$label -
SIZE$colorFormatCount
public static final long SIZE$colorFormatCount -
SIZE$colorFormats
public static final long SIZE$colorFormats -
SIZE$depthStencilFormat
public static final long SIZE$depthStencilFormat -
SIZE$sampleCount
public static final long SIZE$sampleCount -
SIZE$depthReadOnly
public static final long SIZE$depthReadOnly -
SIZE$stencilReadOnly
public static final long SIZE$stencilReadOnly -
OFFSET$nextInChain
public static final long OFFSET$nextInChain -
OFFSET$label
public static final long OFFSET$label -
OFFSET$colorFormatCount
public static final long OFFSET$colorFormatCount -
OFFSET$colorFormats
public static final long OFFSET$colorFormats -
OFFSET$depthStencilFormat
public static final long OFFSET$depthStencilFormat -
OFFSET$sampleCount
public static final long OFFSET$sampleCount -
OFFSET$depthReadOnly
public static final long OFFSET$depthReadOnly -
OFFSET$stencilReadOnly
public static final long OFFSET$stencilReadOnly
-
-
Constructor Details
-
WGPURenderBundleEncoderDescriptor
Creates an instance of aWGPURenderBundleEncoderDescriptorrecord class.- Parameters:
segment- the value for thesegmentrecord component
-
-
Method Details
-
allocate
-
allocate
-
clone
public static WGPURenderBundleEncoderDescriptor clone(Arena arena, WGPURenderBundleEncoderDescriptor src) -
nextInChain
-
nextInChain
-
nextInChain
-
nextInChainRaw
-
nextInChainRaw
public void nextInChainRaw(@Pointer(target=WGPUChainedStruct.class) @NotNull @NotNull MemorySegment value) -
label
-
label
-
label
-
colorFormatCount
-
colorFormatCount
-
colorFormats
Note: the returnedIntPtrdoes not have correctIntPtr.size()property. It's up to user to track the size of the buffer, and useIntPtr.reinterpret(long)to set the size before actually reading fro or writing to the buffer. -
colorFormats
public WGPURenderBundleEncoderDescriptor colorFormats(@Nullable @EnumType(WGPUTextureFormat.class) @Nullable IntPtr value) -
colorFormatsRaw
-
colorFormatsRaw
public void colorFormatsRaw(@Pointer(target=WGPUTextureFormat.class) @NotNull @NotNull MemorySegment value) -
depthStencilFormat
-
depthStencilFormat
public WGPURenderBundleEncoderDescriptor depthStencilFormat(@EnumType(WGPUTextureFormat.class) int value) -
sampleCount
-
sampleCount
-
depthReadOnly
-
depthReadOnly
-
stencilReadOnly
-
stencilReadOnly
public WGPURenderBundleEncoderDescriptor stencilReadOnly(@NativeType("WGPUBool") @Unsigned int value) -
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 thesegmentrecord component.
-