package/@greenpandastudios/aug-gpu@0.2.0/api.aug diagrams
Project overview · Compiled explanation
Sequences
Call arrows identify checked targets; loop and branch frames determine when they run. Open that target’s module to follow its implementation. Branches describe alternatives; loops describe repeated work. Native calls and interface dispatch stop at their declared contracts. Exit notes end that path; enclosing recovery and cleanup remain visible.
_open
It is private to its defining scope.
It returns ownership of Device. Failures can raise GpuError.
Native implementation: @greenpandastudios/aug-gpu@0.2.0, 0.1.0. Supported targets: macos arm64 14.0+. Binding contract: native.abi.json (SHA-256 d95e237d8be07df8fd20132ca0f5a45a125fd65b7ba93669e69c0a38db63d60c). It calls aug_gpu_open_v1 through the C ABI on the caller thread; a blocking native call blocks that thread. The caller owns the returned handle. Its maintainer permits independent instances on worker threads. The compiler checks the provider, descriptor digest, signature and ownership at August call sites. The native author promises not to retain inputs, enter August from foreign threads, or unwind across the C boundary; internal native workers may run. The compiler does not prove those promises.
May leave with checked errors: GpuError. Native implementation; only the declared contract is known. Explanation.
_upload
It is private to its defining scope.
It takes device as Device and values as List<float>.
It returns ownership of Buffer. Failures can raise GpuError.
Native implementation: @greenpandastudios/aug-gpu@0.2.0, 0.1.0. Supported targets: macos arm64 14.0+. Binding contract: native.abi.json (SHA-256 d95e237d8be07df8fd20132ca0f5a45a125fd65b7ba93669e69c0a38db63d60c). It calls aug_gpu_upload_v1 through the C ABI on the caller thread; a blocking native call blocks that thread. device lends read access for this call. The caller owns the returned handle. Its maintainer permits independent instances on worker threads. The compiler checks the provider, descriptor digest, signature and ownership at August call sites. The native author promises not to retain inputs, enter August from foreign threads, or unwind across the C boundary; internal native workers may run. The compiler does not prove those promises.
May leave with checked errors: GpuError. Native implementation; only the declared contract is known. Explanation.
_add
It is private to its defining scope.
It takes left and right as Buffer.
It returns ownership of Buffer. Failures can raise GpuError.
Native implementation: @greenpandastudios/aug-gpu@0.2.0, 0.1.0. Supported targets: macos arm64 14.0+. Binding contract: native.abi.json (SHA-256 d95e237d8be07df8fd20132ca0f5a45a125fd65b7ba93669e69c0a38db63d60c). It calls aug_gpu_add_v1 through the C ABI on the caller thread; a blocking native call blocks that thread. left lends read access for this call; right lends read access for this call. The caller owns the returned handle. Its maintainer permits independent instances on worker threads. The compiler checks the provider, descriptor digest, signature and ownership at August call sites. The native author promises not to retain inputs, enter August from foreign threads, or unwind across the C boundary; internal native workers may run. The compiler does not prove those promises.
May leave with checked errors: GpuError. Native implementation; only the declared contract is known. Explanation.
_download
It is private to its defining scope.
It takes buffer as Buffer.
It returns List<float>. Failures can raise GpuError.
Native implementation: @greenpandastudios/aug-gpu@0.2.0, 0.1.0. Supported targets: macos arm64 14.0+. Binding contract: native.abi.json (SHA-256 d95e237d8be07df8fd20132ca0f5a45a125fd65b7ba93669e69c0a38db63d60c). It calls aug_gpu_download_v1 through the C ABI on the caller thread; a blocking native call blocks that thread. buffer lends read access for this call. August copies the returned buffer, then calls aug_gpu_values_release_v1 to release it. Its maintainer permits independent instances on worker threads. The compiler checks the provider, descriptor digest, signature and ownership at August call sites. The native author promises not to retain inputs, enter August from foreign threads, or unwind across the C boundary; internal native workers may run. The compiler does not prove those promises.
May leave with checked errors: GpuError. Native implementation; only the declared contract is known. Explanation.
_live
It is private to its defining scope.
It returns int.
Native implementation: @greenpandastudios/aug-gpu@0.2.0, 0.1.0. Supported targets: macos arm64 14.0+. Binding contract: native.abi.json (SHA-256 d95e237d8be07df8fd20132ca0f5a45a125fd65b7ba93669e69c0a38db63d60c). It calls aug_gpu_live_resources_v1 through the C ABI on the caller thread; a blocking native call blocks that thread. Its maintainer permits independent instances on worker threads. The compiler checks the provider, descriptor digest, signature and ownership at August call sites. The native author promises not to retain inputs, enter August from foreign threads, or unwind across the C boundary; internal native workers may run. The compiler does not prove those promises.
Native implementation; only the declared contract is known. Explanation.
openDevice
Open a Metal GPU on the current worker. No device means GpuError.
It returns ownership of Device. Failures can raise GpuError.
Mermaid source
sequenceDiagram
participant p0 as openDevice
rect rgb(245, 240, 241)
Note over p0: Enter unsafe scope
p0->>p0: _open() · native boundary
p0-->>p0: _open result: Device
Note over p0: Return _open()； required cleanup runs before exit
Note over p0: Leave unsafe scope
end
Note over p0: May leave with checked errors: GpuError
upload
Copy finite numbers to an owned float32 GPU buffer. Values round to float32.
It takes device as Device and values as List<float>.
It returns ownership of Buffer. Failures can raise GpuError.
Mermaid source
sequenceDiagram
participant p0 as upload
rect rgb(245, 240, 241)
Note over p0: Enter unsafe scope
p0->>p0: _upload(device=device, values=values) · native boundary
p0-->>p0: _upload result: Buffer
Note over p0: Return _upload(device, values)； required cleanup runs<br/>before exit
Note over p0: Leave unsafe scope
end
Note over p0: May leave with checked errors: GpuError
add
Add equally sized buffers on the GPU. Wait for device completion before returning.
It takes left and right as Buffer.
It returns ownership of Buffer. Failures can raise GpuError.
Mermaid source
sequenceDiagram
participant p0 as add
rect rgb(245, 240, 241)
Note over p0: Enter unsafe scope
p0->>p0: _add(left=left, right=right) · native boundary
p0-->>p0: _add result: Buffer
Note over p0: Return _add(left, right)； required cleanup runs before<br/>exit
Note over p0: Leave unsafe scope
end
Note over p0: May leave with checked errors: GpuError
download
Copy float32 GPU values into an August list of floats.
It takes buffer as Buffer.
Failures can raise GpuError.
Mermaid source
sequenceDiagram
participant p0 as download
rect rgb(245, 240, 241)
Note over p0: Enter unsafe scope
p0->>p0: _download(buffer=buffer) · native boundary
p0-->>p0: _download result: List‹float›
Note over p0: Return _download(buffer)； required cleanup runs before<br/>exit
Note over p0: Leave unsafe scope
end
Note over p0: May leave with checked errors: GpuError