NativeStructAlloc<C extends Struct, D extends StructD<C, D>> class

A slot-based allocator for native structs of type C, accepting Dart-side StructD wrappers of type D.

Bridges between the ergonomic Dart StructD layer and raw Pointer<C> memory, supporting both single-value and array slots.

Inheritance
Mixed-in types

Constructors

NativeStructAlloc(RaylibTemp temp, String name, {required int byteSize, required Pointer<C> allocatorFunc([int count]), required String printerFunc(Pointer<C> ptr), required C refFunc(Pointer<C> ptr), required Pointer<C> setRefFunc(Pointer<C> ptr, C value), required void setCFunc(Pointer<C> ptr, int i, C value), required C indexerFunc(Pointer<C> ptr, int i), required void indexSetterFunc(Pointer<C> ptr, int i, C value), required D pointerToStruct(Pointer<C> ptr), required void updateFunc(Pointer<C> ptr, D source)})

Properties

allocatorFunc → Pointer<C> Function([int count])
Allocates count elements and returns the raw source pointer.
finalinherited
byteSize → int
Size in bytes of a single element this allocator manages.
finalinherited
freeFunc → void Function(Pointer<C> ptr)
Frees the memory at ptr.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
indexerFunc → C Function(Pointer<C> ptr, int i)
Returns the C struct at index i of the array at ptr.
final
indexSetterFunc → void Function(Pointer<C> ptr, int i, C value)
Overwrites the i-th element of the array at ptr with value.
final
isPointerNull → bool Function(Pointer<C> ptr)
Returns true if ptr is null or zero.
finalinherited
name → String
Debug name for this allocator, used in logging and diagnostics.
finalinherited
nullptrFactory → Pointer<C> Function()
Returns a null/zero pointer of type P.
finalinherited
pointerFactory → Pointer<C> Function(Pointer<C> ptr)
Wraps a source pointer ptr into the platform pointer type P.
finalinherited
pointerToSource → Pointer<C> Function(Pointer<C> ptr)
Unwraps a platform pointer ptr back to its source type S.
finalinherited
pointerToStruct → D Function(Pointer<C> ptr)
Converts a P to its Dart-side X wrapper, referencing the memory at that pointer.
final
printerFunc → String Function(Pointer<C> ptr)
Returns a human-readable string representation of ptr.
finalinherited
refFunc → C Function(Pointer<C> ptr)
Returns the V struct value referenced by ptr.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
setCFunc → void Function(Pointer<C> ptr, int i, C value)
Copies the raw C struct value into the i-th element of the array at ptr.
final
setRefFunc → Pointer<C> Function(Pointer<C> ptr, C value)
Assigns value to the struct referenced by ptr.
final
slots → Map<String, (Pointer<C>, int)>
Active allocation slots, keyed by slot name. Each entry holds the pointer and its element count.
finalinherited
temp → RaylibTemp
finalinherited
updateFunc → void Function(Pointer<C> ptr, D source)
Copies the fields of source into the native memory at ptr.
final
writeIntoFunc ↔ void Function(Pointer<C> ptr, D value)
Writes the Dart value value into the struct at ptr.
latefinaloverride-getter
writeIntoIndexedFunc ↔ void Function(Pointer<C> ptr, int i, D value)
Writes the Dart value value into the i-th element of the array at ptr.
latefinaloverride-getter

Methods

Array(List<D> array, {String? key}) → Pointer<C>
Writes array into a tracked slot of sufficient capacity.
inherited
At(String key, [int count = 1]) → Pointer<C>
Returns the P stored in key, allocating (or reallocating) if necessary.
inherited
AtUnique(String key, [int count = 1]) → Pointer<C>
Allocates (or reuses) a slot identified by a unique key suffix.
inherited
Copy(Pointer<C> src, int length, {String? key}) → Pointer<C>
Copies length structs from src into a tracked slot using setCFunc.
inherited
dispose() → void
Frees all currently tracked slots and clears the slot table.
inherited
Extract1(void fn(Pointer<C> ptr)) → D
Allocates slot '1' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Extract2(void fn(Pointer<C> ptr)) → D
Allocates slot '2' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Extract3(void fn(Pointer<C> ptr)) → D
Allocates slot '3' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Extract4(void fn(Pointer<C> ptr)) → D
Allocates slot '4' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Extract5(void fn(Pointer<C> ptr)) → D
Allocates slot '5' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Extract6(void fn(Pointer<C> ptr)) → D
Allocates slot '6' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Extract7(void fn(Pointer<C> ptr)) → D
Allocates slot '7' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Extract8(void fn(Pointer<C> ptr)) → D
Allocates slot '8' as an uninitialized sret destination, passes its raw pointer to fn, then returns the struct fn wrote into it.
inherited
Fill(int count, D init(int), {String? key}) → Pointer<C>
Fills a tracked slot of count structs, producing each element via init(i) and writing it through writeIntoIndexedFunc.
inherited
FillInto(int count, void init(int, C), {String? key}) → Pointer<C>
Fills a tracked slot of count structs by calling init(i, struct) which writes directly into the native struct fields.
inherited
FillWith(int count, C init(Pointer<C>, int), {String? key}) → Pointer<C>
Fills a tracked slot of count structs by setting each element to the C returned by init(ptr, i).
inherited
Free(String key) → void
Frees the native memory owned by slot key and removes it from the table.
inherited
getBaseKey(D value, [String? inner]) → String
Builds a RaylibTempBase slot key from value's structName, tag, and an optional inner suffix.
inherited
getBaseKeyWithId(D value, [String? inner]) → String
Like getBaseKey but prefixed with value's internalId, used for pointer-owning structs to prevent cross-instance key collisions.
inherited
Has(String key) → bool
Returns true if a slot with the given key exists.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
PointerTo(D value, [String? key]) → Pointer<C>
Allocates or syncs value to a tracked slot at key.
inherited
Raw([int count = 1]) → Pointer<C>
Allocates count raw elements and returns the wrapped pointer.
inherited
RawArray(List<D> array) → Pointer<C>
Allocates an unslotted array.
inherited
RawArrayPopulated(List<D> array) → Pointer<C>
Allocates an unslotted array and populates it from array.
inherited
RawFillInto(int count, void init(int, C)) → Pointer<C>
Allocates an unslotted array of count structs, populating each via init(i, struct) which writes directly into the native memory.
inherited
RawFillWith(int count, C init(Pointer<C>, int)) → Pointer<C>
Allocates an unslotted array of count structs, setting each element to the C returned by init(ptr, i).
inherited
Ref1([D? o]) → Pointer<C>
Allocates o into slot '1', or reuses the existing slot '1' allocation if o is null.
inherited
Ref1OrNull([D? o]) → Pointer<C>
Allocates o into slot '1', or returns nullptr if o is null.
inherited
Ref2([D? o]) → Pointer<C>
Allocates o into slot '2', or reuses the existing slot '2' allocation if o is null.
inherited
Ref2OrNull([D? o]) → Pointer<C>
Allocates o into slot '2', or returns nullptr if o is null.
inherited
Ref3([D? o]) → Pointer<C>
Allocates o into slot '3', or reuses the existing slot '3' allocation if o is null.
inherited
Ref3OrNull([D? o]) → Pointer<C>
Allocates o into slot '3', or returns nullptr if o is null.
inherited
Ref4([D? o]) → Pointer<C>
Allocates o into slot '4', or reuses the existing slot '4' allocation if o is null.
inherited
Ref4OrNull([D? o]) → Pointer<C>
Allocates o into slot '4', or returns nullptr if o is null.
inherited
Ref5([D? o]) → Pointer<C>
Allocates o into slot '5', or reuses the existing slot '5' allocation if o is null.
inherited
Ref5OrNull([D? o]) → Pointer<C>
Allocates o into slot '5', or returns nullptr if o is null.
inherited
Ref6([D? o]) → Pointer<C>
Allocates o into slot '6', or reuses the existing slot '6' allocation if o is null.
inherited
Ref6OrNull([D? o]) → Pointer<C>
Allocates o into slot '6', or returns nullptr if o is null.
inherited
Ref7([D? o]) → Pointer<C>
Allocates o into slot '7', or reuses the existing slot '7' allocation if o is null.
inherited
Ref7OrNull([D? o]) → Pointer<C>
Allocates o into slot '7', or returns nullptr if o is null.
inherited
Ref8([D? o]) → Pointer<C>
Allocates o into slot '8', or reuses the existing slot '8' allocation if o is null.
inherited
Ref8OrNull([D? o]) → Pointer<C>
Allocates o into slot '8', or returns nullptr if o is null.
inherited
RefCapture(String key, dynamic fn(Pointer<C> ptr)) → D
Copies the native struct o into a uniquely-keyed tracked slot and returns its Dart-side X wrapper via pointerToStruct.
inherited
RefUpdate1<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '1', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
RefUpdate2<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '2', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
RefUpdate3<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '3', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
RefUpdate4<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '4', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
RefUpdate5<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '5', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
RefUpdate6<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '6', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
RefUpdate7<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '7', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
RefUpdate8<R>(D? o, R fn(Pointer<C> p)) → R
Allocates o into slot '8', calls fn with the pointer, then syncs native memory back into o via updateFunc.
inherited
signature() → String
Returns a string that identifies the concrete type of this allocator, including its type parameters.
inherited
Size([int count = 1]) → int
Returns the total byte size for count elements.
inherited
Slot(String key) → Pointer<C>?
Returns the pointer stored under key, or null if the slot does not exist. Does not allocate.
inherited
slotKey([String? key]) → String
Returns the canonical slot key for key, falling back to 'struct' when key is null.
inherited
toString() → String
A string representation of this object.
inherited
uniqueSlotKey(String key) → String
Returns a slot key guaranteed to be unique within this temp context, by prefixing key with the next available ID.
inherited
Unslot(String key) → void
Removes the slot entry for key from the table without freeing the underlying memory.
inherited
Value([D? value, String? key]) → Pointer<C>
Returns the pointer for slot key, optionally writing value into it.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited