Skip to content

api.md

Latest commit

 

History

History
74 lines (58 loc) · 3.32 KB

api.md

File metadata and controls

74 lines (58 loc) · 3.32 KB
Raw

API Reference

This reference maps Feather's public API by subsystem. It is written for application code first, with notes for shader-only markers and generated contracts where they matter.

Feather code usually uses these namespaces:

Namespace Purpose
Feather Runtime entry point, contexts, kernel attributes, dispatch IDs, barriers, atomics, profiler.
Feather.Resources Buffers, textures, samplers, uniforms, shader-facing resource views.
Feather.Math Vectors, matrices, swizzles, shader math, HLSL-style aliases.
Feather.Graphics Preview raster graphics pipeline and draw-state types.
Feather.Windowing Native windows, events, pixel buffers, and texture presentation.
Feather.AD Preview automatic differentiation markers, AD kernel wrapper, gradient set.
Feather.NN Preview tensor, module, optimizer, training, and checkpoint APIs.
Feather.Interop Generated contracts, FEIR readers, resource descriptors, shader inspection helpers.

Reference Pages

  • Core Runtime: GPU, GpuContext, capabilities, dispatch, profiler, attributes, diagnostics.
  • Resources: buffers, textures, samplers, uniforms, access modes, layout and lifetime.
  • Kernels: kernel interfaces, thread IDs, group IDs, callables, GPU struct instance helpers, generic interface monomorphization, barriers, shared memory, atomics.
  • Math: vector and matrix types, swizzles, ShaderMath, Hlsl.
  • Graphics: vertex/fragment shaders, pipelines, state objects, draw calls.
  • Windowing: GpuWindow, events, pixel buffers, texture presenters.
  • Automatic Differentiation: AD, GpuADKernel<T>, GradientSet.
  • Neural Networks: tensors, parameters, modules, tensor ops, losses, optimizers, training steps.
  • Interop and Inspection: FEIR readers, shader inspection, dispatch paths, native asset override.

Common Program Shape

using Feather;
using Feather.Math;
using Feather.Resources;

using var input = GPU.CreateBuffer<float>([1, 2, 3, 4], BufferAccess.ReadOnly);
using var output = GPU.CreateBuffer<float>(4, BufferAccess.ReadWrite);

GPU.Dispatch(new ScaleKernel(input.AsReadOnly(), output.AsReadWrite(), new Uniform<float>(2.0f)), 4);

[Kernel]
[ThreadGroupSize(DefaultThreadGroupSizes.X)]
public readonly partial struct ScaleKernel(
    ReadOnlyBuffer<float> input,
    ReadWriteBuffer<float> output,
    Uniform<float> scale) : IKernel1D
{
    public void Execute()
    {
        int i = ThreadIds.X;
        output[i] = input[i] * scale.Value;
    }
}

Host API Vs Shader API

Feather has two kinds of APIs:

Kind Examples Where it runs
Host/runtime API GPU.CreateBuffer, GPU.Dispatch, GpuWindow.Create, GpuADKernel.Backward Normal .NET code.
Shader-facing values ReadWriteBuffer<T>, Uniform<T>, ThreadIds.X, AD.Parameter Inside generated kernel/shader methods.

Shader-facing marker methods throw if called on the CPU. They exist so the Roslyn generator can recognize intent and lower it into FEIR.

Related Guides