https://github.com/ella-0/sgl-public

public version of my computer science A-Level NEA project
https://github.com/ella-0/sgl-public

Last synced: about 3 hours ago
JSON representation

public version of my computer science A-Level NEA project

• Host: GitHub
• URL: https://github.com/ella-0/sgl-public
• Owner: Ella-0
• Created: 2024-09-12T14:52:08.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T14:52:34.000Z (5 months ago)
• Last Synced: 2025-01-20T11:12:15.487Z (6 days ago)
• Language: Rust
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SGL

Simple Graphics Language

## Example

```sgl

fn main(env: Env) -> Result<(), u32> {

    let spirv = shader {

        fn vert() {

            // ..v vertex shader stage

        }

    }

}

```

## In Progress

 - [ ] Add type pass to fill in a check types in the AST

## Steps

 - [ ] Unit test and rustdoc throughout

 - [ ] Simple syntax

 - [ ] define tokens

 - [ ] create finite automita for tokens

 - [ ] implement lexer around finite automita

 - [ ] work out rough grammars for the langauge

 - [ ] create a simple parser from these grammars

 - [ ] create a basic llvm code genorater of the ast

 - [ ] add a semantic stage for type checking

 - [ ] add shader block and SPIR-V backend.

### Aynalysis

In the computer graphics industry we have two main places we run code, on the GPU and on the CPU and we have two different

programming lanaguages in seperate source files for code to be run on the GPU (shader code) and code to be run on the CPU.

#### Objectives

 - To create a programming langauge that solves this by unifying shader source code and CPU source code

   by having a `shader` keyword that defines a block of code to be compiled to SPIR-V (the format used by

   open graphics libraries such as Vulkan and modern OpenGL).

 - In the current system, one has build scripts that compile shader code (usually hlsl or glsl) to SPIR-V files

   that are included into the binary usually at runtime. hlsl and glsl have different syntaxes from the host langauge

   (usually C, C++ or Rust) which can make it confusing for the programmer.

 - I will not aim to provide semantic verification of calls to OpenGL or Vulkan when loading shaders. It will still be possibly

   to have the wrong input descriptions setup with these libraries and thus the code wont work.