shaders

Documentation

Index

• func FormatShader(key string, s *Shader) string
• type Shader
  • func Get(key string) *Shader
• type ShaderSummary
  • func List(category string) []ShaderSummary
  • func Search(query string, limit int) []ShaderSummary
• type Uniform

Functions

func FormatShader

func FormatShader(key string, s *Shader) string

FormatShader formats a shader for CLI display.

Types

type Shader

type Shader struct {
	Name        string    `json:"name"`
	Description string    `json:"description"`
	Category    string    `json:"category"`
	GLSL        string    `json:"glsl"`
	Uniforms    []Uniform `json:"uniforms"`
	Inputs      []string  `json:"inputs"`
	Tags        []string  `json:"tags"`
}

Shader represents a GLSL shader template.

func Get

func Get(key string) *Shader

Get returns a shader by key.

type ShaderSummary

type ShaderSummary struct {
	Key         string `json:"key"`
	Name        string `json:"name"`
	Category    string `json:"category"`
	Description string `json:"description"`
}

ShaderSummary is a brief listing entry.

func List

func List(category string) []ShaderSummary

List returns all shaders, optionally filtered by category.

func Search

func Search(query string, limit int) []ShaderSummary

Search finds shaders matching a query string.

type Uniform

type Uniform struct {
	Name        string      `json:"name"`
	Type        string      `json:"type"`
	Default     interface{} `json:"default"`
	Expression  string      `json:"expression,omitempty"`
	Description string      `json:"description"`
}

Uniform describes a shader uniform parameter.