| Copyright | (C) 2015, 2016 Dimitri Sabadie |
|---|---|
| License | BSD3 |
| Maintainer | Dimitri Sabadie <dimitri.sabadie@gmail.com> |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Graphics.Luminance.Shader.Program
Description
- data Program u
- programID :: Program u -> GLuint
- createProgram :: (HasProgramError e, MonadError e m, MonadResource m) => [Stage] -> ((forall a. UniformName a -> UniformInterface m (U a)) -> UniformInterface m i) -> m (Program i)
- createProgram_ :: (HasProgramError e, MonadError e m, MonadIO m, MonadResource m) => [Stage] -> m (Program ())
- class Uniform a
- data U a
- data U'
- (.=) :: U a -> a -> U'
- updateUniforms :: MonadIO m => Program a -> (a -> U') -> m ()
- data UniformInterface m a
- data UniformName :: * -> * where
- UniformName :: Uniform a => String -> UniformName a
- UniformSemantic :: Uniform a => Natural -> UniformName a
- UniformBlockName :: UniformBlock a => String -> UniformName (Buffer rw (UB a))
- data SomeUniformName = SomeUniformName (UniformName a)
- class UniformBlock a
- newtype UB a = UB {
- unUB :: a
- data ProgramError
- class HasProgramError a where
- (<>) :: Semigroup a => a -> a -> a
- sconcat :: Semigroup a => NonEmpty a -> a
Shader program creation
Shader program.
createProgram :: (HasProgramError e, MonadError e m, MonadResource m) => [Stage] -> ((forall a. UniformName a -> UniformInterface m (U a)) -> UniformInterface m i) -> m (Program i) Source #
Create a new shader Program.
That function takes a list of Stages and a uniform interface builder function and yields a
Program and the interface.
The builder function takes a function you can use to retrieve uniforms. You can pass
values of type UniformName to identify the uniform you want to retrieve. If the uniform can’t
be retrieved, throws InactiveUniform.
In the end, you get the new Program and a polymorphic value you can choose the type of in
the function you pass as argument. You can use that value to gather uniforms for instance.
createProgram_ :: (HasProgramError e, MonadError e m, MonadIO m, MonadResource m) => [Stage] -> m (Program ()) Source #
A simpler version of createProgram. That function assumes you don’t need a uniform interface
and then just returns the Program.
Uniform
Class of types that can be sent down to shaders. That class is closed because shaders cannot
handle a lot of uniform types. However, you should have a look at the U documentation for
further information about how to augment the scope of the types you can send down to shaders.
Minimal complete definition
toU
Instances
A shader uniform. U a
U is contravariant in its argument. That means that you can use contramap to build more
interesting uniform types.
Another interesting part is the fact that U is also monoidal. You can accumulate several of
them with '(<>)' if they have the same type. That means that you can join them so that when you
pass an actual value, it gets shared inside the resulting value.
The '()' instance doesn’t do anything and doesn’t even use its argument.
Instances
updateUniforms :: MonadIO m => Program a -> (a -> U') -> m () Source #
Update uniforms in a program. That function enables you to update only the uniforms you want and not the whole.
If you want to update several uniforms (not only one), you can use the 'Semigroup'/'Monoid' instances (use '(<>)' or 'sconcat'/'mconcat' for instance).
data UniformInterface m a Source #
Instances
| Monad m => Monad (UniformInterface m) Source # | |
| Functor m => Functor (UniformInterface m) Source # | |
| Monad m => Applicative (UniformInterface m) Source # | |
data UniformName :: * -> * where Source #
Possible way to name uniform values.
Constructors
| UniformName :: Uniform a => String -> UniformName a | |
| UniformSemantic :: Uniform a => Natural -> UniformName a | |
| UniformBlockName :: UniformBlock a => String -> UniformName (Buffer rw (UB a)) |
data SomeUniformName Source #
A uniform name with type-erasure. You can only access the constructors and the carried name but you can’t reconstruct the phantom type.
Constructors
| SomeUniformName (UniformName a) |
Instances
Uniform block
class UniformBlock a Source #
Instances
| UniformBlock Bool Source # | |
| UniformBlock Float Source # | |
| UniformBlock Int32 Source # | |
| UniformBlock Word32 Source # | |
| (Storable a, UniformBlock a) => UniformBlock (V4 a) Source # | |
| (Storable a, UniformBlock a) => UniformBlock (V3 a) Source # | |
| (Storable a, UniformBlock a) => UniformBlock (V2 a) Source # | |
| (UniformBlock a, UniformBlock b) => UniformBlock (a, b) Source # | |
| (UniformBlock a, UniformBlock b) => UniformBlock ((:.) a b) Source # | |
| (UniformBlock a, UniformBlock b, UniformBlock c) => UniformBlock (a, b, c) Source # | |
| (UniformBlock a, UniformBlock b, UniformBlock c, UniformBlock d) => UniformBlock (a, b, c, d) Source # | |
Error handling
data ProgramError Source #
Shader program error.
'LinkFailed reason' happens when a program fails to link. reason contains the error message.
'InactiveUniform uni' happens at linking when a uniform is inactive in the program; that is, unused or semantically set to a negative value.
Constructors
| LinkFailed String | |
| InactiveUniform SomeUniformName |
Instances
class HasProgramError a where Source #
Types that can handle ProgramError – read as, “have”.
Minimal complete definition
Methods
fromProgramError :: ProgramError -> a Source #