Graphics.Luminance.Texture

Texture information and creation

class Texture t

Class of all textures.

Minimal complete definition

fromBaseTexture, toBaseTexture, textureTypeEnum, textureSize, textureStorage, transferTexelsSub, fillTextureSub

Associated Types

type TextureSize t :: *

Size of a texture. This is an associated type – type family – because the dimensionality of a texture relies on its type.

type TextureOffset t :: *

In order to index regions of texels in texture, we need another associated type – for the same dimensionality reason as for TextureSize.

Instances

Pixel k f => Texture (Cubemap k f)

(KnownNat n, Pixel * f) => Texture (CubemapArray n f)

Pixel k f => Texture (Texture1D k f)

(KnownNat n, Pixel * f) => Texture (Texture1DArray n f)

Pixel k f => Texture (Texture2D k f)

(KnownNat n, Pixel * f) => Texture (Texture2DArray n f)

Pixel k f => Texture (Texture3D k f)

createTexture :: forall m t. (MonadIO m, MonadResource m, Texture t) => TextureSize t -> Natural -> Sampling -> m t

'createTexture w h levels sampling' a new 'w'*'h' texture with levels levels. The format is set through the type.

Sampling

data Sampling

A sampling configuration type.

Constructors

Sampling

Fields

samplingWrapS :: Wrap

samplingWrapT :: Wrap

samplingWrapR :: Wrap

samplingMinFilter :: Filter

samplingMagFilter :: Filter

samplingCompareFunction :: Maybe CompareFunc

Instances

Eq Sampling

Show Sampling

defaultSampling :: Sampling

Default Sampling for convenience.

  defaultSampling = Sampling {
      samplingWrapS           = ClampToEdge
    , samplingWrapT           = ClampToEdge
    , samplingWrapR           = ClampToEdge
    , samplingMinFilter       = Linear
    , samplingMagFilter       = Linear
    , samplingCompareFunction = Nothing
    }

Texture sampler customization

data Filter

Sampling filter. Nearest will sample the nearest texel at the sampling coordinates whilst Linear will perform linear interpolation with the texels nearby.

Constructors

Nearest

Linear

Instances

Eq Filter

Show Filter

data Wrap

Wrap texture parameter. Such an object is used to tell how to sampling is performed when going out of the texture coordinates.

ClampToEdge will clamp the texture coordinates between in '[0,1]'. If you pass '1.1' or '31.456', in both cases you’ll end up with '1'. Same thing for negative values clamped to '0'.

Repeat will clamp the texture in '[0,1]' after applying a fract on the value, yielding a a repeated '[0,1]' pattern.

Constructors

ClampToEdge

Repeat

ClampToBorder

MirroredRepeat

Instances

Eq Wrap

Show Wrap

data CompareFunc

For textures that might require depth comparison, that type defines all the possible cases for comparison.

Constructors

Never

Less

Equal

LessOrEqual

Greater

GreaterOrEqual

NotEqual

Always

Instances

Eq CompareFunc

Show CompareFunc

Texture operations

uploadSub :: forall a m t. (MonadIO m, Storable a, Texture t) => t -> TextureOffset t -> TextureSize t -> Bool -> Vector a -> m ()

uploadSub tex offset size autolvl texels uploads data to a subpart of the texture’s storage. The offset is given with origin at upper-left corner, and size is the size of the area to upload to. autolvl is a Bool that can be used to automatically generate mipmaps.

fillSub :: forall a m t. (MonadIO m, Storable a, Texture t) => t -> TextureOffset t -> TextureSize t -> Bool -> Vector a -> m ()

Fill a subpart of the texture’s storage with a given value.

Available textures

1D textures

data Texture1D f

A 1D texture.

Instances

Eq (Texture1D k f)

Show (Texture1D k f)

Pixel k f => Texture (Texture1D k f)

Uniform (Texture1D k f)

type TextureSize (Texture1D k f) = Natural

type TextureOffset (Texture1D k f) = Natural

texture1DW :: Texture1D f -> Natural

Array texture

data Texture1DArray n f

A 1D texture array.

Instances

Eq (Texture1DArray n f)

Show (Texture1DArray n f)

(KnownNat n, Pixel * f) => Texture (Texture1DArray n f)

type TextureSize (Texture1DArray n f) = Natural

type TextureOffset (Texture1DArray n f) = (Natural, Natural)

texture1DArrayW :: Texture1DArray n f -> Natural

2D textures

data Texture2D f

A 2D texture.

Instances

Eq (Texture2D k f)

Show (Texture2D k f)

Pixel k f => Texture (Texture2D k f)

Uniform (Texture2D k f)

type TextureSize (Texture2D k f) = (Natural, Natural)

type TextureOffset (Texture2D k f) = (Natural, Natural)

texture2DW :: Texture2D f -> Natural

texture2DH :: Texture2D f -> Natural

Array texture

data Texture2DArray n f

A 2D texture array.

Instances

Eq (Texture2DArray n f)

Show (Texture2DArray n f)

(KnownNat n, Pixel * f) => Texture (Texture2DArray n f)

type TextureSize (Texture2DArray n f) = (Natural, Natural)

type TextureOffset (Texture2DArray n f) = (Natural, Natural, Natural)

texture2DArrayW :: Texture2DArray n f -> Natural

3D textures

data Texture3D f

A 3D texture.

Instances

Eq (Texture3D k f)

Show (Texture3D k f)

Pixel k f => Texture (Texture3D k f)

Uniform (Texture3D k f)

type TextureSize (Texture3D k f) = (Natural, Natural, Natural)

type TextureOffset (Texture3D k f) = (Natural, Natural, Natural)

texture3DW :: Texture3D f -> Natural

texture3DH :: Texture3D f -> Natural

texture3DD :: Texture3D f -> Natural

Cubemaps

data Cubemap f

A cubemap.

Instances

Eq (Cubemap k f)

Show (Cubemap k f)

Pixel k f => Texture (Cubemap k f)

Uniform (Cubemap k f)

type TextureSize (Cubemap k f) = (Natural, Natural)

type TextureOffset (Cubemap k f) = (Natural, Natural, CubeFace)

data CubeFace

Face of a Cubemap.

Constructors

PositiveX

NegativeX

PositiveY

NegativeY

PositiveZ

NegativeZ

Instances

Eq CubeFace

Show CubeFace

cubemapW :: Cubemap f -> Natural

cubemapH :: Cubemap f -> Natural

Array textures

data CubemapArray n f

A cubemap array.

Instances

Eq (CubemapArray n f)

Show (CubemapArray n f)

(KnownNat n, Pixel * f) => Texture (CubemapArray n f)

type TextureSize (CubemapArray n f) = (Natural, Natural)

type TextureOffset (CubemapArray n f) = (Natural, Natural, Natural, CubeFace)

cubemapArrayW :: CubemapArray n f -> Natural

cubemapArrayH :: CubemapArray n f -> Natural