Skip to main content

vcti-shader-foundry

The shader artifact-set builder: composes the installed shader features into the pipeline matrix, drives the compiler, and emits the artifact set for VCollab renderers.

Overview

vcti-shader-foundry is the assembler of the shader system — the offline build tool that turns the installed shader features into the artifact set the runtime ships. It composes nine feature packages — mask, deform, transform, derive, fringe, clip, cap, pick and material — into nine fragment shapes drawn through three vertex variants, capped and uncapped, generates the Slang that wires them, drives vcti-shader-compiler to emit and validate GLSL ES, checks every result against its contract and the GLSL ES 3.00 budgets, and packs the shaders, one envelope per pipeline and the registry.json index into a single archive, written atomically, for a consumer to take as it likes.

Composition is the whole job, and it is the part no feature can do: each feature declares its own fields and cannot see what it is combined with, so the builder is where the uniforms that belong to nobody are added — the clip-space transform, the color selector, the opacity — where a name two features declare differently is rejected, where the features run in the one order they each require, and where the manifest, the only contract the runtime reads, is written. Mask, transform, clip and the surface finish are in every pipeline with their off state supplied as data; the argument for that, and for which pipelines exist at all, is in docs/pipeline-matrix.md.

It is not the toolchain and not the vocabulary: the .slang → GLSL ES machinery lives in vcti-shader-compiler, the specs you declare fields with in vcti-shader-base, and each shader feature in its own package. See docs/design.md for the system design and docs/extending.md for adding a shader feature.

Installation

pip install vcti-shader-foundry

This is a build tool, not a runtime dependency; install it in the authoring environment alongside the feature packages you want built. The shader compilers (slangc, spirv-cross, glslang) are external and pinned — discovered via SLANG_DIR / SPIRV_CROSS_DIR / GLSLANG_DIR or PATH.

Quick Start

Build the artifact set as one archive:

$ shader-foundry emit
wrote shaders-6.0.0-5496bf45.zip: 54 pipeline(s), 3,670,840 bytes, sha256 5496bf45…
  registry.json, pipelines/*.json (54), shaders/*.glsl (108)
  toolchain slangc 2026.12.0.1, spirv-cross vulkan-sdk-1.4.357.0, glslang 11:16.5.0 (pinned)

One file, three kinds of content, because the same build is read three ways: registry.json for a consumer choosing a pipeline, one self-contained envelope per pipeline — contract, uniform layout, sampler bindings and sources inline — for one rendering it, and the .glsl files for a person. The archive is written whole or not at all: everything is built and checked in memory, then written to a temporary file and renamed into place. It is also reproducible, so identical inputs give an identical file and the hash above identifies the set. --out takes any path, with {version} and {sha8} filled in wherever they appear.

Give a directory instead of a .zip path and the same files are unpacked into it — to read them, or to build a subset with --pipeline ID (repeatable) while iterating on one shape. A subset carries no registry.json and cannot become an archive. shader-foundry pipelines lists the ids, and needs no toolchain.

The executable versions a set is built with are pinned in the package. emit warns when the installed tools differ from the pins and refuses with --strict-toolchain; the manifest records what was actually used either way.

The same from Python, when a build needs to do more around it:

# requires: the shader toolchain (slangc, spirv-cross, glslang)
from vcti.shader.compiler import discover_toolchain
from vcti.shader.foundry import build_artifact_set, build_manifest, toolchain_info, write_archive

toolchain = discover_toolchain()
artifact_set = build_artifact_set(build_manifest(toolchain_info(toolchain)), toolchain)
print(write_archive(artifact_set))          # shaders-<version>-<sha8>.zip, the default name

Inspect the matrix without compiling anything — nine shapes through three vertex variants, capped and uncapped:

from vcti.shader.foundry import build_pipelines

for pipeline in build_pipelines():
    print(pipeline.id, [t.semantic for t in pipeline.tables])
# deform3.symtensor ['mask', 'transform', 'material']
# deform3.symtensor.capped ['mask', 'transform', 'material']
# pick ['mask', 'transform']

Dependencies

vcti-shader-compiler, vcti-shader-base, the nine feature packages (vcti-shader-mask, -deform, -transform, -derive, -fringe, -clip, -cap, -pick, -material), plus vcti-derived. The shader toolchain executables (slangc, spirv-cross, glslang) are external, not pip dependencies. Nothing here needs a GL context: moderngl lives in the gl extra, for the tests that prove each emitted pair links, binds and draws what its contract says; pip install "vcti-shader-foundry[gl]" pulls it in on a machine that has a GL stack.

Documentation

If you want to… Read
Understand the system design and decisions docs/design.md
See which pipelines are emitted and why docs/pipeline-matrix.md
See what features expect of each other, and where they disagree docs/composition-expectations.md
Add a new shader feature docs/extending.md
See practical build workflows docs/patterns.md
Navigate and modify the builder source docs/source-guide.md
Look up a specific function or type docs/api.md

Metadata

Release files for vcti-shader-foundry 6.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vcti-shader-foundry 6.0.0
File Size Uploaded Provenance Actions
vcti_shader_foundry-6.0.0.tar.gz 97.5 kB With provenance Details for vcti_shader_foundry-6.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vcti-shader-foundry 6.0.0
File Interpreter ABI Platform Actions
vcti_shader_foundry-6.0.0-py3-none-any.whl Python 3 none any Details for vcti_shader_foundry-6.0.0-py3-none-any.whl

Total release size: 156.1 kB

Release files / vcti_shader_foundry-6.0.0.tar.gz

Download URL vcti_shader_foundry-6.0.0.tar.gz
Size 97.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ac5582b9b87419aa3de84dc00b341665c18554711781854bd5f98f5e41cf57b7
BLAKE2b-256 checksum
How to use checksums
f2363d1257a23f1afa9916bc7a15844423ea5c66bba8a45975fb52e359c31f19
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.

Transparency log

Release files / vcti_shader_foundry-6.0.0-py3-none-any.whl

Download URL vcti_shader_foundry-6.0.0-py3-none-any.whl
Size 58.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
19c1799d6406061eafc02fc26570232e7540ee9f5a9eb7306bd281c95bbfb335
BLAKE2b-256 checksum
How to use checksums
c20475bd0d26dea38a3ab5af23244dd3649340c1cf6f00ef50efd348e0f5db8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.

Transparency log

Security for vcti-shader-foundry 6.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for vcti_shader_foundry-6.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page