RDShaderFile

RDShaderFile is a Resource containing named SPIR-V variants and a file-level parsing error. It is neither a spatial/canvas Shader for ShaderMaterial nor a GPU RID. SetBytecode stores a reference rather than compiling source text; RenderingDevice creates a GPU shader separately. Use RDShaderSource for source text.

The version parameter names a variant inside the file, such as zeta, not an engine release. Omitting it selects the empty name. It does not mean “first available variant”: GetSpirV with a missing key emits a native error and returns null. GetVersionList returns a separate list sorted by name; check the required key first. A new RDShaderFile contains no versions.

Check three independent things: file BaseError, the selected RDShaderSpirV stage error and that stage’s bytecode presence. Empty BaseError does not mean success. This executed helper extracts only Compute from the selected version and creates a caller-owned GPU shader:

using System;
using System.Collections.Generic;
using Reckfell;

public static class ShaderVersions
{
    // Creates an owned GPU shader containing only the selected compute stage.
    // Use the device's valid call context; free the RID on the same device.
    public static Rid CreateCompute(RenderingDevice device, RDShaderFile file, string version = "")
    {
        ArgumentNullException.ThrowIfNull(device);
        ArgumentNullException.ThrowIfNull(file);
        ArgumentNullException.ThrowIfNull(version);
        if (!string.IsNullOrEmpty(file.BaseError))
            throw new InvalidOperationException(file.BaseError);
        using var name = new StringName(version);
        var names = file.GetVersionList();
        using var namesOwner = (Reckfell.Collections.Array)names;
        if (!names.Contains(name)) throw new KeyNotFoundException("Shader version is absent.");
        var stored = file.GetSpirV(name); // Borrowed shared resource: do not Dispose.
        if (!string.IsNullOrEmpty(stored.CompileErrorCompute))
            throw new InvalidOperationException(stored.CompileErrorCompute);
        byte[] bytes = stored.BytecodeCompute;
        if (bytes.Length == 0) throw new InvalidOperationException("Compute bytecode is empty.");
        using var computeOnly = new RDShaderSpirV { BytecodeCompute = bytes };
        Rid shader = device.ShaderCreateFromSpirV(computeOnly);
        if (!shader.IsValid) throw new InvalidOperationException("GPU shader creation failed.");
        return shader;
    }
}

The helper loads no file and compiles no GLSL. Supply an existing RDShaderFile and a valid RenderingDevice. It excludes other stages when creating computeOnly; it is not a graphics/ray-tracing pipeline validator. After success, create a ComputePipeline and uniform set matching this shader layout. Full dispatch/readback cycle: compute and data.

GetSpirV returns a shared object that multiple names can reference. Do not Dispose it as an independent copy or edit stage errors/bytecode accidentally when changing one variant. Create a separate RDShaderSpirV for an independent variant. The _Versions getter copies the dictionary, not its value objects; this is an internal serialization property, not the recommended editing interface. SetBytecode replaces a matching key and emits Changed. SetBaseError also emits Changed even when writing the same string.

The file descriptor owns no GPU RIDs. ShaderCreateFromSpirV creates a separate resource belonging to one device; free it through the same FreeRid after work completes. The main RenderingDevice is borrowed and must not be freed by your code; the creating component manages a local device and its resources. Use the device’s correct thread/call context.

Installed Windows/Vulkan Forward+ checks covered shared bytecode, variant names/replacement, Changed, container copies, .rdata save/reload and the exact helper. Real compute doubled the original storage buffer after loading. RDUniform edits after UniformSetCreate changed no existing GPU binding; freeing the bound buffer invalidated the dependent set while a copied RID remained nonzero. The Vulkan loader warning remains. Text shader-file importing, graphics/ray stages, other drivers/platforms, images and performance were not tested.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

public RDShaderFile();

public string BaseError { get; set; }

public Reckfell.Collections.Dictionary _Versions { get; set; }

public string GetBaseError();

public RDShaderSpirV GetSpirV(StringName version = null);

public Reckfell.Collections.Array<StringName> GetVersionList();

public void SetBaseError(string error);

public void SetBytecode(RDShaderSpirV bytecode, StringName version = null);