pyvvisf 0.4.3

Pure Python ISF shader renderer with PyOpenGL and json5

pyvvisf

Pure Python ISF shader renderer with PyOpenGL and json5.

Overview

pyvvisf is a pure Python implementation for parsing and rendering ISF (Interactive Shader Format) shaders. It provides a modern, maintainable alternative to the C++ VVISF-GL library with enhanced error reporting and cross-platform compatibility.

Features

• Pure Python: No C++ compilation required
• Robust JSON parsing: Uses json5 for comment support and trailing commas
• Modern OpenGL: PyOpenGL with GLFW for cross-platform context management
• Enhanced error reporting: Detailed Python-native error messages with context
• Type safety: Pydantic models for metadata validation
• Auto-coercion: Automatic type conversion for shader inputs
• Context management: Automatic resource cleanup

Installation

pip install pyvvisf

Development Installation

git clone https://github.com/jimcortez/pyvvisf.git
cd pyvvisf
pip install -e .

Quick Start

from pyvvisf import ISFRenderer, ISFColor, ISFPoint2D

# Create a simple test shader
test_shader = """
/*{
    "NAME": "Test Shader",
    "INPUTS": [
        {
            "NAME": "color",
            "TYPE": "color",
            "DEFAULT": [1.0, 0.0, 0.0, 1.0]
        },
        {
            "NAME": "scale",
            "TYPE": "float",
            "DEFAULT": 1.0
        }
    ]
}*/

uniform vec2 RENDERSIZE;
uniform vec4 color;
uniform float scale;

out vec4 fragColor;

void main() {
    vec2 uv = gl_FragCoord.xy / RENDERSIZE.xy;
    vec2 pos = (uv - 0.5) * scale;
    float dist = length(pos);
    float circle = smoothstep(0.5, 0.4, dist);
    fragColor = color * circle;
}
"""

# Render the shader
with ISFRenderer() as renderer:
    # Load shader
    metadata = renderer.load_shader_content(test_shader)
    
    # Render with default parameters
    image_array = renderer.render(width=512, height=512)
    
    # Render with custom parameters
    custom_inputs = {
        'color': [0.0, 1.0, 0.0, 1.0],  # Green
        'scale': 2.0
    }
    
    image_array = renderer.render(
        width=512, height=512,
        inputs=custom_inputs,
        metadata=metadata
    )
    
    # Save to file
    renderer.save_render("output.png", width=512, height=512)

Examples

See the examples/ directory for complete examples:

• pure_python_demo.py: Basic usage demonstration
• isf_renderer_demo.py: Advanced rendering examples

Development

Building

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black src/ tests/
isort src/ tests/

# Type checking
mypy src/

Project Structure

pyvvisf/
├── src/pyvvisf/
│   ├── core/
│   │   ├── __init__.py
│   │   ├── renderer.py      # Main renderer
│   │   ├── parser.py        # ISF parser with json5
│   │   ├── types.py         # Value types
│   │   └── errors.py        # Error handling
│   ├── __init__.py
│   └── _version.py
├── examples/
├── tests/
└── docs/

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.