Safe Haskell	None
Language	Haskell2010

Graphics.Gloss.Rendering

Contents

Picture data type
Colors
Bitmaps
Rendering

Synopsis

Picture data type

data Picture Source

A 2D picture

Constructors

Blank	A blank picture, with nothing in it.
Polygon Path	A convex polygon filled with a solid color.
Line Path	A line along an arbitrary path.
Circle Float	A circle with the given radius.
ThickCircle Float Float	A circle with the given thickness and radius. If the thickness is 0 then this is equivalent to `Circle`.
Arc Float Float Float	A circular arc drawn counter-clockwise between two angles (in degrees) at the given radius.
ThickArc Float Float Float Float	A circular arc drawn counter-clockwise between two angles (in degrees), with the given radius and thickness. If the thickness is 0 then this is equivalent to `Arc`.
Text String	Some text to draw with a vector font.
Bitmap Int Int BitmapData Bool	A bitmap image with a width, height and some 32-bit RGBA bitmap data. The boolean flag controls whether Gloss should cache the data between frames for speed. If you are programatically generating the image for each frame then use `False`. If you have loaded it from a file then use `True`.
Color Color Picture	A picture drawn with this color.
Translate Float Float Picture	A picture translated by the given x and y coordinates.
Rotate Float Picture	A picture rotated clockwise by the given angle (in degrees).
Scale Float Float Picture	A picture scaled by the given x and y factors.
Pictures [Picture]	A picture consisting of several others.

Instances

Eq Picture Source
Data Picture Source
Show Picture Source
Monoid Picture Source

type Point = (Float, Float) Source

A point on the x-y plane.

type Vector = Point Source

A vector can be treated as a point, and vis-versa.

type Path = [Point] Source

A path through the x-y plane.

Colors

data Color Source

An abstract color value. We keep the type abstract so we can be sure that the components are in the required range. To make a custom color use makeColor.

Instances

Eq Color Source
Data Color Source
Num Color Source
Show Color Source

makeColor Source

Arguments

:: Float	Red component.
-> Float	Green component.
-> Float	Blue component.
-> Float	Alpha component.
-> Color

Make a custom color. All components are clamped to the range [0..1].

makeColorI :: Int -> Int -> Int -> Int -> Color Source

Make a custom color. All components are clamped to the range [0..255].

makeRawColor :: Float -> Float -> Float -> Float -> Color Source

Make a custom color.

Using this function over makeColor avoids clamping the components, which saves time. However, if the components are out of range then this will result in integer overflow at rendering time, and the actual picture you get will be implementation dependent.

You'll only need to use this function when using the gloss-raster package that builds a new color for every pixel. If you're just working with the Picture data type then it there is no need for raw colors.

makeRawColorI :: Int -> Int -> Int -> Int -> Color Source

Make a custom color, taking pre-clamped components.

rgbaOfColor :: Color -> (Float, Float, Float, Float) Source

Take the RGBA components of a color.

clampColor :: Color -> Color Source

Clamp components of a raw color into the required range.

Bitmaps

data BitmapData Source

Abstract 32-bit RGBA bitmap data.

Instances

Eq BitmapData Source
Data BitmapData Source
Show BitmapData Source

bitmapOfForeignPtr :: Int -> Int -> ForeignPtr Word8 -> Bool -> Picture Source

O(1). Use a ForeignPtr of RGBA data as a bitmap with the given width and height.

bitmapOfByteString :: Int -> Int -> ByteString -> Bool -> Picture Source

O(size). Copy a ByteString of RGBA data into a bitmap with the given width and height.

The boolean flag controls whether Gloss should cache the data between frames for speed. If you are programatically generating the image for each frame then use False. If you have loaded it from a file then use True.

bitmapOfBMP :: BMP -> Picture Source

O(size). Copy a BMP file into a bitmap.

loadBMP :: FilePath -> IO Picture Source

Load an uncompressed 24 or 32bit RGBA BMP file as a bitmap.

Rendering

displayPicture Source

Arguments

:: (Int, Int)	Window width and height.
-> Color	Color to clear the window with.
-> State	Current rendering state.
-> Float	View port scale, which controls the level of detail. Use 1.0 to start with.
-> Picture	Picture to draw.
-> IO ()

Set up the OpenGL context, clear the buffer, and render the given picture into it.

This is the same as renderPicture composed with withModelview and withClearBuffer. If you want to manage your own OpenGL context then you can just call renderPicture.

Using this function assumes that you've already opened a window and set that to the active context. If you don't want to do your own window management then use the gloss package instead.

renderPicture Source

Arguments

:: State	Current rendering state.
-> Float	View port scale, which controls the level of detail. Use 1.0 to start with.
-> Picture	Picture to render.
-> IO ()

Render a picture into the current OpenGL context.

Assumes that the OpenGL matrix mode is set to Modelview

withModelview Source

Arguments

:: (Int, Int)	Width and height of window.
-> IO ()	Action to perform.
-> IO ()

Set up the OpenGL rendering context for orthographic projection and run an action to draw the model.

withClearBuffer Source

Arguments

:: Color	Background color
-> IO ()	Action to perform
-> IO ()

Clear the OpenGL buffer with the given background color and run an action to draw the model.

initState :: IO State Source

A mutable render state holds references to the textures currently loaded into the OpenGL context. To ensure that textures are cached in GPU memory, pass the same State each time you call displayPicture or renderPicture.

data State Source

Render options settings