GI.Clutter.Objects.Shader

The Shader structure contains only private data and should be accessed using the provided API

Since: 0.6

Exported types

newtype Shader

Memory-managed wrapper type.

Constructors

Shader (ManagedPtr Shader)

Instances

Eq Shader

Defined in GI.Clutter.Objects.Shader

Methods

(==) :: Shader -> Shader -> Bool

(/=) :: Shader -> Shader -> Bool

GObject Shader

Defined in GI.Clutter.Objects.Shader

ManagedPtrNewtype Shader

Defined in GI.Clutter.Objects.Shader

Methods

toManagedPtr :: Shader -> ManagedPtr Shader

TypedObject Shader

Defined in GI.Clutter.Objects.Shader

Methods

glibType :: IO GType

HasParentTypes Shader

Defined in GI.Clutter.Objects.Shader

IsGValue (Maybe Shader)

Convert Shader to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Objects.Shader

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Shader -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Shader)

type ParentTypes Shader

Defined in GI.Clutter.Objects.Shader

type ParentTypes Shader = '[Object]

class (GObject o, IsDescendantOf Shader o) => IsShader o

Type class for types which can be safely cast to Shader, for instance with toShader.

Instances

(GObject o, IsDescendantOf Shader o) => IsShader o

Defined in GI.Clutter.Objects.Shader

toShader :: (MonadIO m, IsShader o) => o -> m Shader

Cast to Shader, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, compile, forceFloating, freezeNotify, getv, isCompiled, isFloating, notify, notifyByPspec, ref, refSink, release, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getCoglFragmentShader, getCoglProgram, getCoglVertexShader, getData, getFragmentSource, getIsEnabled, getProperty, getQdata, getVertexSource.

Setters

setData, setDataFull, setFragmentSource, setIsEnabled, setProperty, setUniform, setVertexSource.

compile

shaderCompile

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m ()

(Can throw GError)

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Compiles and links GLSL sources set for vertex and fragment shaders for a Shader. If the compilation fails and a GError return location is provided the error will contain the errors from the compiler, if any.

Since: 0.8

getCoglFragmentShader

shaderGetCoglFragmentShader

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m (Ptr ())

Returns: A CoglHandle for the fragment shader, or Nothing. The handle is owned by the Shader and it should not be unreferenced

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Retrieves the underlying CoglHandle for the fragment shader.

Since: 1.0

getCoglProgram

shaderGetCoglProgram

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m (Ptr ())

Returns: A CoglHandle for the shader program, or Nothing. The handle is owned by the Shader and it should not be unreferenced

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Retrieves the underlying CoglHandle for the shader program.

Since: 1.0

getCoglVertexShader

shaderGetCoglVertexShader

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m (Ptr ())

Returns: A CoglHandle for the vertex shader, or Nothing. The handle is owned by the Shader and it should not be unreferenced

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Retrieves the underlying CoglHandle for the vertex shader.

Since: 1.0

getFragmentSource

shaderGetFragmentSource

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m Text

Returns: the source of the fragment shader for this ClutterShader object or Nothing. The returned string is owned by the shader object and should never be modified or freed

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Query the current GLSL fragment source set on shader.

Since: 0.6

getIsEnabled

shaderGetIsEnabled

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m Bool

Returns: True if the shader is enabled.

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Checks whether shader is enabled.

Since: 0.6

getVertexSource

shaderGetVertexSource

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m Text

Returns: the source of the vertex shader for this ClutterShader object or Nothing. The returned string is owned by the shader object and should never be modified or freed

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Query the current GLSL vertex source set on shader.

Since: 0.6

isCompiled

shaderIsCompiled

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m Bool

Returns: True if the shader is compiled, linked and ready for use.

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Checks whether shader is is currently compiled, linked and bound to the GL context.

Since: 0.8

new

shaderNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Shader

Returns: a new Shader.

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Create a new Shader instance.

Since: 0.6

release

shaderRelease

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> m ()

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Frees up any GL context resources held by the shader.

Since: 0.6

setFragmentSource

shaderSetFragmentSource

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> Text

data: GLSL source code.

-> Int64

length: length of source buffer (currently ignored)

-> m ()

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Sets the GLSL source code to be used by a Shader for the fragment program.

Since: 0.6

setIsEnabled

shaderSetIsEnabled

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> Bool

enabled: The new state of the shader.

-> m ()

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Enables a shader. This function will attempt to compile and link the shader, if it isn't already.

When enabled is False the default state of the GL pipeline will be used instead.

Since: 0.6

setUniform

shaderSetUniform

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader.

-> Text

name: name of uniform in GLSL shader program to set.

-> GValue

value: a ShaderFloat, ShaderInt or ShaderMatrix Value.

-> m ()

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Sets a user configurable variable in the GLSL shader programs attached to a Shader.

Since: 1.0

setVertexSource

shaderSetVertexSource

Arguments

:: (HasCallStack, MonadIO m, IsShader a)

=> a

shader: a Shader

-> Text

data: GLSL source code.

-> Int64

length: length of source buffer (currently ignored)

-> m ()

Deprecated: (Since version 1.8)Use ShaderEffect instead.

Sets the GLSL source code to be used by a Shader for the vertex program.

Since: 0.6

Properties

compiled

Whether the shader is compiled and linked, ready for use in the GL context.

Since: 0.8

getShaderCompiled :: (MonadIO m, IsShader o) => o -> m Bool

Get the value of the “compiled” property. When overloading is enabled, this is equivalent to

get shader #compiled

enabled

Whether the shader is currently used in the GL rendering pipeline.

Since: 0.6

constructShaderEnabled :: (IsShader o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “enabled” property. This is rarely needed directly, but it is used by new.

getShaderEnabled :: (MonadIO m, IsShader o) => o -> m Bool

Get the value of the “enabled” property. When overloading is enabled, this is equivalent to

get shader #enabled

setShaderEnabled :: (MonadIO m, IsShader o) => o -> Bool -> m ()

Set the value of the “enabled” property. When overloading is enabled, this is equivalent to

set shader [ #enabled := value ]

fragmentSource

GLSL source code for the fragment shader part of the shader program.

Since: 0.6

clearShaderFragmentSource :: (MonadIO m, IsShader o) => o -> m ()

Set the value of the “fragment-source” property to Nothing. When overloading is enabled, this is equivalent to

clear #fragmentSource

constructShaderFragmentSource :: (IsShader o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “fragment-source” property. This is rarely needed directly, but it is used by new.

getShaderFragmentSource :: (MonadIO m, IsShader o) => o -> m Text

Get the value of the “fragment-source” property. When overloading is enabled, this is equivalent to

get shader #fragmentSource

setShaderFragmentSource :: (MonadIO m, IsShader o) => o -> Text -> m ()

Set the value of the “fragment-source” property. When overloading is enabled, this is equivalent to

set shader [ #fragmentSource := value ]

vertexSource

GLSL source code for the vertex shader part of the shader program, if any

Since: 0.6

clearShaderVertexSource :: (MonadIO m, IsShader o) => o -> m ()

Set the value of the “vertex-source” property to Nothing. When overloading is enabled, this is equivalent to

clear #vertexSource

constructShaderVertexSource :: (IsShader o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “vertex-source” property. This is rarely needed directly, but it is used by new.

getShaderVertexSource :: (MonadIO m, IsShader o) => o -> m Text

Get the value of the “vertex-source” property. When overloading is enabled, this is equivalent to

get shader #vertexSource

setShaderVertexSource :: (MonadIO m, IsShader o) => o -> Text -> m ()

Set the value of the “vertex-source” property. When overloading is enabled, this is equivalent to

set shader [ #vertexSource := value ]