Modulesdl2-2.5.5.0Haskell2010

SDL.Video.Renderer

SDL.Video.Renderer provides a high-level interface to SDL's accelerated 2D rendering library.

14 types
72 values

Packagesdl2-2.5.5.0
Exports86
LanguageHaskell2010
LicenceBSD-3-Clause
SourceRenderer.hs

newtypenewtype Renderer

An SDL rendering device. This can be created with createRenderer.

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq RendererDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Data RendererDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Ord RendererDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Show RendererDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Generic RendererDefined in sdl2-2.5.5.0 · SDL.Internal.Types
type Rep Renderer = D1 ('MetaData "Renderer" "SDL.Internal.Types" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'True) (C1 ('MetaCons "Renderer" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Renderer)))Defined in sdl2-2.5.5.0 · SDL.Internal.Types

Renderer Configuration

3 declarations

These configuration options can be used with createRenderer to create Renderers.

datadata RendererConfig

The configuration data used when creating windows.

Constructors

RendererConfig
- rendererType :: RendererType
  The renderer's acceleration mode
- rendererTargetTexture :: Bool
  The renderer supports rendering to texture

Instances9Eq, Data, Ord, Read, Show, Generic, …

Eq RendererConfigDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Data RendererConfigDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord RendererConfigDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read RendererConfigDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show RendererConfigDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic RendererConfigDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
ToNumber RendererConfig Word32Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
FromNumber RendererConfig Word32Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep RendererConfig = D1 ('MetaData "RendererConfig" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "RendererConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "rendererType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RendererType) :*: S1 ('MetaSel ('Just "rendererTargetTexture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

valuedefaultRenderer :: RendererConfig

Default options for RendererConfig.

defaultRenderer = RendererConfig
  { rendererType          = AcceleratedRenderer
  , rendererTargetTexture = False
  }

datadata RendererType

Renderer acceleration mode

Constructors

UnacceleratedRenderer
The renderer does not use hardware acceleration
AcceleratedRenderer
The renderer uses hardware acceleration and refresh rate is ignored
AcceleratedVSyncRenderer
The renderer uses hardware acceleration and present is synchronized with the refresh rate
SoftwareRenderer
The renderer is a software fallback

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Enum RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Eq RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Data RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic RendererTypeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep RendererType = D1 ('MetaData "RendererType" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) ((C1 ('MetaCons "UnacceleratedRenderer" 'PrefixI 'False) U1 :+: C1 ('MetaCons "AcceleratedRenderer" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "AcceleratedVSyncRenderer" 'PrefixI 'False) U1 :+: C1 ('MetaCons "SoftwareRenderer" 'PrefixI 'False) U1))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

Drawing Primitives

25 declarations

valueclear :: (Functor m, MonadIO m) => Renderer -> m ()

Clear the current rendering target with the drawing color.

See SDL_RenderClear for C documentation.

valuecopy

:: MonadIO m
=> Renderer
The rendering context
-> Texture
The source texture
-> Maybe (Rectangle CInt)
The source rectangle to copy, or Nothing for the whole texture
-> Maybe (Rectangle CInt)
The destination rectangle to copy to, or Nothing for the whole rendering target. The texture will be stretched to fill the given rectangle.
-> m ()

Copy a portion of the texture to the current rendering target.

See SDL_RenderCopy for C documentation.

valuecopyEx

:: MonadIO m
=> Renderer
The rendering context
-> Texture
The source texture
-> Maybe (Rectangle CInt)
The source rectangle to copy, or Nothing for the whole texture
-> Maybe (Rectangle CInt)
The destination rectangle to copy to, or Nothing for the whole rendering target. The texture will be stretched to fill the given rectangle.
-> CDouble
The angle of rotation in degrees. The rotation will be performed clockwise.
-> Maybe (Point V2 CInt)
The point indicating the center of the rotation, or Nothing to rotate around the center of the destination rectangle
-> V2 Bool
Whether to flip the texture on the X and/or Y axis
-> m ()

Copy a portion of the texture to the current rendering target, optionally rotating it by angle around the given center and also flipping it top-bottom and/or left-right.

See SDL_RenderCopyEx for C documentation.

valuedrawLine

:: (Functor m, MonadIO m)
=> Renderer
-> Point V2 CInt
The start point of the line
-> Point V2 CInt
The end point of the line
-> m ()

Draw a line on the current rendering target.

See SDL_RenderDrawLine for C documentation.

valuedrawLines

:: MonadIO m
=> Renderer
-> Vector (Point V2 CInt)
A Vector of points along the line. SDL will draw lines between these points.
-> m ()

Draw a series of connected lines on the current rendering target.

See SDL_RenderDrawLines for C documentation.

valuedrawPoint :: (Functor m, MonadIO m) => Renderer -> Point V2 CInt -> m ()

Draw a point on the current rendering target.

See SDL_RenderDrawPoint for C documentation.

valuedrawPoints :: MonadIO m => Renderer -> Vector (Point V2 CInt) -> m ()

Draw multiple points on the current rendering target.

See SDL_RenderDrawPoints for C documentation.

valuedrawRect

:: MonadIO m
=> Renderer
-> Maybe (Rectangle CInt)
The rectangle outline to draw. Nothing for the entire rendering context.
-> m ()

Draw a rectangle outline on the current rendering target.

See SDL_RenderDrawRect for C documentation.

valuedrawRects :: MonadIO m => Renderer -> Vector (Rectangle CInt) -> m ()

Draw some number of rectangles on the current rendering target.

See SDL_RenderDrawRects for C documentation.

valuefillRect

:: MonadIO m
=> Renderer
-> Maybe (Rectangle CInt)
The rectangle to fill.
-> m ()

Fill a rectangle on the current rendering target with the drawing color.

See SDL_RenderFillRect for C documentation.

valuefillRects :: MonadIO m => Renderer -> Vector (Rectangle CInt) -> m ()

Fill some number of rectangles on the current rendering target with the drawing color.

See SDL_RenderFillRects for C documentation.

valuecopyF

:: MonadIO m
=> Renderer
-> Texture
-> Maybe (Rectangle CInt)
-> Maybe (Rectangle CFloat)
-> m ()

Copy a portion of the texture to the current rendering target.

valuecopyExF

:: MonadIO m
=> Renderer
The rendering context
-> Texture
The source texture
-> Maybe (Rectangle CInt)
The source rectangle to copy, or Nothing for the whole texture
-> Maybe (Rectangle CFloat)
The destination rectangle to copy to, or Nothing for the whole rendering target. The texture will be stretched to fill the given rectangle.
-> CDouble
The angle of rotation in degrees. The rotation will be performed clockwise.
-> Maybe (Point V2 CFloat)
The point indicating the center of the rotation, or Nothing to rotate around the center of the destination rectangle
-> V2 Bool
Whether to flip the texture on the X and/or Y axis
-> m ()

Copy a portion of the texture to the current rendering target, optionally rotating it by angle around the given center and also flipping it top-bottom and/or left-right.

valuedrawLineF

:: MonadIO m
=> Renderer
-> Point V2 CFloat
-> Point V2 CFloat
-> m ()

Draw a line between two points on the current rendering target.

valuedrawLinesF :: MonadIO m => Renderer -> Vector (Point V2 CFloat) -> m ()

Draw a series of connected lines on the current rendering target.

valuedrawPointF :: MonadIO m => Renderer -> Point V2 CFloat -> m ()

Draw a point on the current rendering target.

valuedrawPointsF :: MonadIO m => Renderer -> Vector (Point V2 CFloat) -> m ()

Draw a collection of points on the current rendering target.

valuedrawRectF :: MonadIO m => Renderer -> Rectangle CFloat -> m ()

Draw the outline of a rectangle on the current rendering target.

valuedrawRectsF :: MonadIO m => Renderer -> Vector (Rectangle CFloat) -> m ()

Draw a series of rectangle outlines on the current rendering target.

valuefillRectF :: MonadIO m => Renderer -> Rectangle CFloat -> m ()

Draw a filled rectangle on the current rendering target.

valuefillRectsF :: MonadIO m => Renderer -> Vector (Rectangle CFloat) -> m ()

Draw a series of filled rectangles on the current rendering target.

valuerenderGeometry

:: MonadIO m
=> Renderer
-> Maybe Texture
-> Vector Vertex
-> Vector CInt
-> m ()

Render a list of triangles, optionally using a texture and indices into the vertex array Color and alpha modulation is done per vertex (SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).

datadata Vertex

Constructors

Vertex
- vertexPosition :: !FPoint
- vertexColor :: !Color
- vertexTexCoord :: !FPoint

Instances3Eq, Show, Storable

Eq VertexDefined in sdl2-2.5.5.0 · SDL.Raw.Types
Show VertexDefined in sdl2-2.5.5.0 · SDL.Raw.Types
Storable VertexDefined in sdl2-2.5.5.0 · SDL.Raw.Types

valuerenderGeometryRaw

:: (Storable ix, MonadIO m)
=> Renderer
-> Maybe Texture
-> Ptr FPoint
-> CInt
-> Ptr Color
-> CInt
-> Ptr FPoint
-> CInt
-> CInt
-> Vector ix
-> m ()

Render a list of triangles, optionally using a texture and indices into the vertex array Color and alpha modulation is done per vertex (SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).

This version allows storeing vertex data in arbitrary types, but you have to provide pointers and strides yourself.

valuepresent :: MonadIO m => Renderer -> m ()

Update the screen with any rendering performed since the previous call.

SDL's rendering functions operate on a backbuffer; that is, calling a rendering function such as drawLine does not directly put a line on the screen, but rather updates the backbuffer. As such, you compose your entire scene and present the composed backbuffer to the screen as a complete picture.

Therefore, when using SDL's rendering API, one does all drawing intended for the frame, and then calls this function once per frame to present the final drawing to the user.

The backbuffer should be considered invalidated after each present; do not assume that previous contents will exist between frames. You are strongly encouraged to call clear to initialize the backbuffer before starting each new frame's drawing, even if you plan to overwrite every pixel.

See SDL_RenderPresent for C documentation.

Renderer State

8 declarations

SDL exposes a stateful interface to Renderers - the above primitives drawing routines will change their output depending on the value of these state variables.

valuerendererDrawBlendMode :: Renderer -> StateVar BlendMode

Get or set the blend mode used for drawing operations (fill and line).

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetRenderDrawBlendMode and SDL_GetRenderDrawBlendMode for C documentation.

valuerendererDrawColor :: Renderer -> StateVar (V4 Word8)

Get or set the color used for drawing operations (rect, line and clear).

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetRenderDrawColor and SDL_GetRenderDrawColor for C documentation.

valuerendererRenderTarget :: Renderer -> StateVar (Maybe Texture)

Get or set the current render target. Nothing corresponds to the default render target.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetRenderTarget and SDL_GetRenderTarget for C documentation.

valuerendererClipRect :: Renderer -> StateVar (Maybe (Rectangle CInt))

Get or set the clip rectangle for rendering on the specified target.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_RenderSetClipRect and SDL_RenderGetClipRect for C documentation.

valuerendererLogicalSize :: Renderer -> StateVar (Maybe (V2 CInt))

Get or set the device independent resolution for rendering.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_RenderSetLogicalSize and SDL_RenderGetLogicalSize for C documentation.

valuerendererScale :: Renderer -> StateVar (V2 CFloat)

Get or set the drawing scale for rendering on the current target.

The drawing coordinates are scaled by the x/y scaling factors before they are used by the renderer. This allows resolution independent drawing with a single coordinate system.

If this results in scaling or subpixel drawing by the rendering backend, it will be handled using the appropriate quality hints. For best results use integer scaling factors.

See SDL_RenderSetScale and SDL_RenderGetScale for C documentation.

valuerendererViewport :: Renderer -> StateVar (Maybe (Rectangle CInt))

Get or set the drawing area for rendering on the current target.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_RenderSetViewport and SDL_RenderGetViewport for C documentation.

valuerenderTargetSupported :: MonadIO m => Renderer -> m Bool

Determine whether a window supports the use of render targets.

See SDL_RenderTargetSupported for C documentation.

Surfaces

6 declarations

datadata Surface

Constructors

Surface (Ptr Surface) (Maybe (IOVector Word8))

valueupdateWindowSurface :: (Functor m, MonadIO m) => Window -> m ()

Copy the window surface to the screen.

This is the function you use to reflect any changes to the surface on the screen.

See SDL_UpdateWindowSurface for C documentation.

valuesurfaceBlit

:: MonadIO m
=> Surface
The Surface to be copied from
-> Maybe (Rectangle CInt)
The rectangle to be copied, or Nothing to copy the entire surface
-> Surface
The Surface that is the blit target
-> Maybe (Point V2 CInt)
The position to blit to
-> m (Maybe (Rectangle CInt))

Perform a fast surface copy to a destination surface.

See SDL_BlitSurface for C documentation.

valuesurfaceBlitScaled

:: MonadIO m
=> Surface
The Surface to be copied from
-> Maybe (Rectangle CInt)
The rectangle to be copied, or Nothing to copy the entire surface
-> Surface
The Surface that is the blit target
-> Maybe (Rectangle CInt)
The rectangle that is copied into, or Nothing to copy into the entire surface
-> m ()

Perform a scaled surface copy to a destination surface.

See SDL_BlitScaled for C documentation.

valuesurfaceFillRect

:: MonadIO m
=> Surface
The Surface that is the drawing target.
-> Maybe (Rectangle CInt)
The rectangle to fill, or Nothing to fill the entire surface.
-> V4 Word8
The color to fill with. If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place. This colour will be implictly mapped to the closest approximation that matches the surface's pixel format.
-> m ()

Perform a fast fill of a rectangle with a specific color.

If there is a clip rectangle set on the destination (set via clipRect), then this function will fill based on the intersection of the clip rectangle and the given Rectangle.

See SDL_FillRect for C documentation.

valuesurfaceFillRects

:: MonadIO m
=> Surface
The Surface that is the drawing target.
-> Vector (Rectangle CInt)
A Vector of Rectangles to be filled.
-> V4 Word8
The color to fill with. If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place. This colour will be implictly mapped to the closest approximation that matches the surface's pixel format.
-> m ()

Perform a fast fill of a set of rectangles with a specific color.

If there is a clip rectangle set on any of the destinations (set via clipRect), then this function will fill based on the intersection of the clip rectangle and the given Rectangles.

See SDL_FillRects for C documentation.

Creating and Destroying Surfaces

valueconvertSurface

:: (Functor m, MonadIO m)
=> Surface
The Surface to convert
-> SurfacePixelFormat
The pixel format that the new surface is optimized for
-> m Surface

Copy an existing surface into a new one that is optimized for blitting to a surface of a specified pixel format.

This function is used to optimize images for faster repeat blitting. This is accomplished by converting the original and storing the result as a new surface. The new, optimized surface can then be used as the source for future blits, making them faster.

See SDL_ConvertSurface for C documentation.

valuecreateRGBSurface

:: (Functor m, MonadIO m)
=> V2 CInt
The size of the surface
-> PixelFormat
The bit depth, red, green, blue and alpha mask for the pixels
-> m Surface

Allocate a new RGB surface.

See SDL_CreateRGBSurface for C documentation.

valuecreateRGBSurfaceFrom

:: (Functor m, MonadIO m)
=> IOVector Word8
The existing pixel data
-> V2 CInt
The size of the surface
-> CInt
The pitch - the length of a row of pixels in bytes
-> PixelFormat
The bit depth, red, green, blue and alpha mask for the pixels
-> m Surface

Allocate a new RGB surface with existing pixel data.

See SDL_CreateRGBSurfaceFrom for C documentation.

valuefreeSurface :: MonadIO m => Surface -> m ()

Free an RGB surface.

If the surface was created using createRGBSurfaceFrom then the pixel data is not freed.

See SDL_FreeSurface for the C documentation.

valuegetWindowSurface :: (Functor m, MonadIO m) => Window -> m Surface

Get the SDL surface associated with the window.

See SDL_GetWindowSurface for C documentation.

valueloadBMP :: MonadIO m => FilePath -> m Surface

Load a surface from a BMP file.

See SDL_LoadBMP for C documentation.

Surface state

valuesurfaceColorKey :: Surface -> StateVar (Maybe (V4 Word8))

Get or set the color key (transparent pixel color) for a surface.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetColorKey and SDL_GetColorKey for C documentation.

valuesurfaceBlendMode :: Surface -> StateVar BlendMode

Get or set the blend mode used for blit operations.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetSurfaceBlendMode and SDL_GetSurfaceBlendMode for C documentation.

valuesurfaceDimensions :: MonadIO m => Surface -> m (V2 CInt)

Retrive the width and height of a Surface.

valuesurfaceFormat :: MonadIO m => Surface -> m SurfacePixelFormat

Inspect the pixel format under a surface.

valuesurfacePixels :: MonadIO m => Surface -> m (Ptr ())

Obtain the pointer to the underlying pixels in a surface. You should bracket this call with lockSurface and unlockSurface, respectively.

Accessing Surface Data

valuelockSurface :: MonadIO m => Surface -> m ()

Set up a surface for directly accessing the pixels.

See SDL_LockSurface for C documentation.

valueunlockSurface :: MonadIO m => Surface -> m ()

Release a surface after directly accessing the pixels.

See SDL_UnlockSurface for C documentation.

Palettes and pixel formats

10 declarations

newtypenewtype Palette

Instances1Eq

Eq PaletteDefined in sdl2-2.5.5.0 · SDL.Video.Renderer

valuepaletteNColors :: MonadIO m => Palette -> m CInt

valuepaletteColors :: MonadIO m => Palette -> m (Maybe (Vector (V4 Word8)))

valuepaletteColor :: MonadIO m => Palette -> CInt -> m (Maybe (V4 Word8))

datadata PixelFormat

Constructors

Unknown !Word32
Index1LSB
Index1MSB
Index4LSB
Index4MSB
Index8
RGB332
RGB444
RGB555
BGR555
ARGB4444
RGBA4444
ABGR4444
BGRA4444
ARGB1555
RGBA5551
ABGR1555
BGRA5551
RGB565
BGR565
RGB24
BGR24
RGB888
RGBX8888
BGR888
BGRX8888
ARGB8888
RGBA8888
ABGR8888
BGRA8888
ARGB2101010
YV12
IYUV
YUY2
UYVY
YVYU

Instances9Eq, Data, Ord, Read, Show, Generic, …

Eq PixelFormatDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Data PixelFormatDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord PixelFormatDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read PixelFormatDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show PixelFormatDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic PixelFormatDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
ToNumber PixelFormat Word32Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
FromNumber PixelFormat Word32Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep PixelFormat = D1 ('MetaData "PixelFormat" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (((((C1 ('MetaCons "Unknown" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word32)) :+: C1 ('MetaCons "Index1LSB" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Index1MSB" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Index4LSB" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "Index4MSB" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Index8" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "RGB332" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "RGB444" 'PrefixI 'False) U1 :+: C1 ('MetaCons "RGB555" 'PrefixI 'False) U1)))) :+: (((C1 ('MetaCons "BGR555" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ARGB4444" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "RGBA4444" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ABGR4444" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "BGRA4444" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ARGB1555" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "RGBA5551" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ABGR1555" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BGRA5551" 'PrefixI 'False) U1))))) :+: ((((C1 ('MetaCons "RGB565" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BGR565" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "RGB24" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BGR24" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "RGB888" 'PrefixI 'False) U1 :+: C1 ('MetaCons "RGBX8888" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "BGR888" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "BGRX8888" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ARGB8888" 'PrefixI 'False) U1)))) :+: (((C1 ('MetaCons "RGBA8888" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ABGR8888" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "BGRA8888" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ARGB2101010" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "YV12" 'PrefixI 'False) U1 :+: C1 ('MetaCons "IYUV" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "YUY2" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "UYVY" 'PrefixI 'False) U1 :+: C1 ('MetaCons "YVYU" 'PrefixI 'False) U1))))))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

newtypenewtype SurfacePixelFormat

Constructors

SurfacePixelFormat (Ptr PixelFormat)

Instances1Eq

Eq SurfacePixelFormatDefined in sdl2-2.5.5.0 · SDL.Video.Renderer

valueformatPalette :: MonadIO m => SurfacePixelFormat -> m (Maybe Palette)

valuesetPaletteColors

:: MonadIO m
=> Palette
The Palette to modify
-> Vector (V4 Word8)
A Vector of colours to copy into the palette
-> CInt
The index of the first palette entry to modify
-> m ()

Set a range of colors in a palette.

See SDL_SetPaletteColors for C documentation.

valuepixelFormatToMasks :: MonadIO m => PixelFormat -> m (CInt, V4 Word32)

Convert the given the enumerated pixel format to a bpp value and RGBA masks.

See SDL_PixelFormatEnumToMasks for C documentation.

valuemasksToPixelFormat :: MonadIO m => CInt -> V4 Word32 -> m PixelFormat

Convert a bpp value and RGBA masks to an enumerated pixel format.

See SDL_MasksToPixelFormatEnum for C documentation.

Textures

1 declaration

newtypenewtype Texture

Instances1Eq

Eq TextureDefined in sdl2-2.5.5.0 · SDL.Video.Renderer

Creating, Using and Destroying Textures

valuecreateTexture

:: (Functor m, MonadIO m)
=> Renderer
The rendering context.
-> PixelFormat
-> TextureAccess
-> V2 CInt
The size of the texture.
-> m Texture

Create a texture for a rendering context.

See SDL_CreateTexture for C documentation.

datadata TextureAccess

Information to the GPU about how you will use a texture.

Constructors

TextureAccessStatic
Changes rarely, cannot be locked
TextureAccessStreaming
changes frequently, can be locked
TextureAccessTarget
Can be used as a render target

Instances11Bounded, Enum, Eq, Data, Ord, Read, …

Bounded TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Enum TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Eq TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Data TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic TextureAccessDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
ToNumber TextureAccess CIntDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
FromNumber TextureAccess CIntDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep TextureAccess = D1 ('MetaData "TextureAccess" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "TextureAccessStatic" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "TextureAccessStreaming" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TextureAccessTarget" 'PrefixI 'False) U1))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

valuecreateTextureFromSurface

:: (Functor m, MonadIO m)
=> Renderer
The rendering context
-> Surface
The surface containing pixel data used to fill the texture
-> m Texture

Create a texture from an existing surface.

See SDL_CreateTextureFromSurface for C documentation.

valueupdateTexture

:: (Functor m, MonadIO m)
=> Texture
The Texture to be updated
-> Maybe (Rectangle CInt)
The area to update, Nothing for entire texture
-> ByteString
The raw pixel data
-> CInt
The number of bytes in a row of pixel data, including padding between lines
-> m ()

Updates texture rectangle with new pixel data.

See SDL_UpdateTexture for C documentation.

valuedestroyTexture :: MonadIO m => Texture -> m ()

Destroy the specified texture.

See SDL_DestroyTexture for the C documentation.

valueglBindTexture

:: (Functor m, MonadIO m)
=> Texture
The texture to bind to the current OpenGL/ES/ES2 context
-> m ()

Bind an OpenGL/ES/ES2 texture to the current context for use with when rendering OpenGL primitives directly.

See SDL_GL_BindTexture for C documentation.

valueglUnbindTexture

:: (Functor m, MonadIO m)
=> Texture
The texture to unbind from the current OpenGL/ES/ES2 context
-> m ()

Unbind an OpenGL/ES/ES2 texture from the current context.

See SDL_GL_UnbindTexture for C documentation.

Texture State

valuetextureAlphaMod :: Texture -> StateVar Word8

Get or set the additional alpha value multiplied into render copy operations.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetTextureAlphaMod and SDL_GetTextureAlphaMod for C documentation.

valuetextureBlendMode :: Texture -> StateVar BlendMode

Get or set the blend mode used for texture copy operations.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetTextureBlendMode and SDL_GetTextureBlendMode for C documentation.

datadata BlendMode

Blend modes used in copy and drawing operations.

Constructors

BlendNone
No blending

BlendAlphaBlend

Alpha blending.

dstRGB = (srcRGB * srcA) + (dstRGB * (1-srcA))
dstA = srcA + (dstA * (1-srcA))

BlendAdditive

Additive blending

dstRGB = (srcRGB * srcA) + dstRGB
dstA = dstA

BlendMod
Color modulate
@ dstRGB = srcRGB * dstRGB dstA = dstA

Instances11Bounded, Enum, Eq, Data, Ord, Read, …

Bounded BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Enum BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Eq BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Data BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic BlendModeDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
ToNumber BlendMode Word32Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
FromNumber BlendMode Word32Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep BlendMode = D1 ('MetaData "BlendMode" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) ((C1 ('MetaCons "BlendNone" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BlendAlphaBlend" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "BlendAdditive" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BlendMod" 'PrefixI 'False) U1))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

valuetextureColorMod :: Texture -> StateVar (V3 Word8)

Get or set the additional color value multiplied into render copy operations.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetTextureColorMod and SDL_GetTextureColorMod for C documentation.

Accessing Texture Data

valuelockTexture

:: MonadIO m
=> Texture
The Texture to lock for access, which must have been created with TextureAccessStreaming
-> Maybe (Rectangle CInt)
The area to lock for access; Nothing to lock the entire texture
-> m (Ptr (), CInt)
A pointer to the locked pixels, appropriately offset by the locked area, and the pitch of the locked pixels (the pitch is the length of one row in bytes).

Lock a portion of the texture for *write-only* pixel access.

See SDL_LockTexture for C documentation.

valueunlockTexture :: MonadIO m => Texture -> m ()

Unlock a texture, uploading the changes to video memory, if needed.

Warning: See Bug No. 1586 before using this function!

See SDL_UnlockTexture for C documentation.

valuequeryTexture :: MonadIO m => Texture -> m TextureInfo

Query the attributes of a texture.

See SDL_QueryTexture for C documentation.

datadata TextureInfo

Constructors

TextureInfo
- texturePixelFormat :: PixelFormat
  Raw format of the texture; the actual format may differ, but pixel transfers will use this format
- textureAccess :: TextureAccess
  The access available to the texture
- textureWidth :: CInt
  The width of the texture
- textureHeight :: CInt
  The height of the texture

Instances6Eq, Ord, Read, Show, Generic, Rep

Eq TextureInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord TextureInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read TextureInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show TextureInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic TextureInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep TextureInfo = D1 ('MetaData "TextureInfo" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "TextureInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "texturePixelFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PixelFormat) :*: S1 ('MetaSel ('Just "textureAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextureAccess)) :*: (S1 ('MetaSel ('Just "textureWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt) :*: S1 ('MetaSel ('Just "textureHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt))))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

datadata Rectangle a

Constructors

Rectangle (Point V2 a) (V2 a)

Instances8Functor, Eq, Ord, Read, Show, Generic, …

Functor RectangleDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Eq a => Eq (Rectangle a)Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord a => Ord (Rectangle a)Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read a => Read (Rectangle a)Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show a => Show (Rectangle a)Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic (Rectangle a)Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
Storable a => Storable (Rectangle a)Defined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep (Rectangle a) = D1 ('MetaData "Rectangle" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "Rectangle" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point V2 a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (V2 a))))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

Available Renderers

3 declarations

These functions allow you to query the current system for available Renderers that can be created with createRenderer.

valuegetRendererInfo :: MonadIO m => Renderer -> m RendererInfo

Get information about a rendering context.

See SDL_GetRendererInfo for C documentation.

datadata RendererInfo

Information about an instantiated Renderer.

Constructors

RendererInfo
- rendererInfoName :: Text
  The name of the renderer
- rendererInfoFlags :: RendererConfig
  Supported renderer features
- rendererInfoNumTextureFormats :: Word32
  The number of available texture formats
- rendererInfoTextureFormats :: [PixelFormat]
  The available texture formats
- rendererInfoMaxTextureWidth :: CInt
  The maximum texture width
- rendererInfoMaxTextureHeight :: CInt
  The maximum texture height

Instances6Eq, Ord, Read, Show, Generic, Rep

Eq RendererInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Ord RendererInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Read RendererInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Show RendererInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
Generic RendererInfoDefined in sdl2-2.5.5.0 · SDL.Video.Renderer
type Rep RendererInfo = D1 ('MetaData "RendererInfo" "SDL.Video.Renderer" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "RendererInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rendererInfoName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rendererInfoFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RendererConfig) :*: S1 ('MetaSel ('Just "rendererInfoNumTextureFormats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))) :*: (S1 ('MetaSel ('Just "rendererInfoTextureFormats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PixelFormat]) :*: (S1 ('MetaSel ('Just "rendererInfoMaxTextureWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt) :*: S1 ('MetaSel ('Just "rendererInfoMaxTextureHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt)))))Defined in sdl2-2.5.5.0 · SDL.Video.Renderer

valuegetRenderDriverInfo :: MonadIO m => m [RendererInfo]

Enumerate all known render drivers on the system, and determine their supported features.

See SDL_GetRenderDriverInfo for C documentation.