Graphics.Rendering.Ombra.Stencil

Documentation

data Mode

Stencil mode.

Constructors

Mode (Side Function) (Side Operation)

Instances

Eq Mode

Methods

(==) :: Mode -> Mode -> Bool

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

data Side a

Constructors

FrontBack a

Use the same value for both sides.

Separate a a

Use a different value for each side (front and back).

Instances

Eq a => Eq (Side a)

Methods

(==) :: Side a -> Side a -> Bool

(/=) :: Side a -> Side a -> Bool

data Function

Function type, fragment stencil value and mask.

Constructors

Function FunctionType Int Word

Instances

Eq Function

Methods

(==) :: Function -> Function -> Bool

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

data FunctionType

Operation to perform between the masked fragment stencil value and the masked destination stencil value.

Constructors

Never

Never pass.

Always

Always pass.

Less

<

LessOrEqual

<=

Greater

GreaterOrEqual

=

Equal

==

NotEqual

/=

Instances

Eq FunctionType

Methods

(==) :: FunctionType -> FunctionType -> Bool

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

data Operation

Operations to perform if the stencil test fails, if the stencil test passes but the depth test fails, and if both the stencil test and the depth test pass.

Constructors

Operation OperationType OperationType OperationType

Instances

Eq Operation

Methods

(==) :: Operation -> Operation -> Bool

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

data OperationType

Operation to perform to the stencil value in the buffer.

Constructors

Keep

Keep it unchanged.

Invert

Invert it.

Zero

Set it to zero.

Replace

Replace it with the masked fragment value.

Increment

Increment it if not maximum.

Decrement

Decrement it if not zero.

IncWrap

Increment it, wrapping it if it would overflow.

DecWrap

Decrement it, wrapping it if it would underflow.

Instances

Eq OperationType

Methods

(==) :: OperationType -> OperationType -> Bool

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