Safe Haskell	None
Language	GHC2021

SDL3.Sys.Surface

Contents

Typed constants
Function aliases
C shims

Description

SDL surfaces are buffers of pixels in system RAM. These are useful for passing around and manipulating images that are not stored in GPU memory.

SDL_Surface makes serious efforts to manage images in various formats, and provides a reasonable toolbox for transforming the data, including copying between surfaces, filling rectangles in the image data, etc.

There is also a simple .bmp loader, loadBMP, and a simple .png loader, loadPNG. SDL itself does not provide loaders for other file formats, but there are several excellent external libraries that do, including its own satellite library, SDL_image In general these functions are thread-safe in that they can be called on different threads with different surfaces. You should not try to modify any surface from two threads simultaneously. The flags on an SDL_Surface.

These are generally considered read-only.

FFI conventions

Unsuffixed aliases are unsafe foreign imports; aliases suffixed Safe are safe. Functions whose callbacks fire during the call export only the Safe alias (the genuine unsafe import stays reachable under SDL3.Sys.Bindgen.Surface.Unsafe); functions curated unsafe-only export only the unsuffixed one. Each alias's documentation records its flavor and rationale.

The C shims are functions this package defines in C over what the FFI cannot call directly (variadic functions, function-like macros), each named after what it wraps; the same flavor rules apply. Their raw imports live under SDL3.Sys.Bindgen.SurfaceShims.

Full conventions: SDL3.Sys.

Since: 3.2.0

Synopsis

module SDL3.Sys.Bindgen.Surface
pattern SDL_SURFACE_PREALLOCATED :: SDL_SurfaceFlags
pattern SDL_SURFACE_LOCK_NEEDED :: SDL_SurfaceFlags
pattern SDL_SURFACE_LOCKED :: SDL_SurfaceFlags
pattern SDL_SURFACE_SIMD_ALIGNED :: SDL_SurfaceFlags
createSurface :: Int32 -> Int32 -> SDL_PixelFormat -> IO (Ptr SDL_Surface)
createSurfaceSafe :: Int32 -> Int32 -> SDL_PixelFormat -> IO (Ptr SDL_Surface)
createSurfaceFrom :: Int32 -> Int32 -> SDL_PixelFormat -> Ptr Void -> Int32 -> IO (Ptr SDL_Surface)
createSurfaceFromSafe :: Int32 -> Int32 -> SDL_PixelFormat -> Ptr Void -> Int32 -> IO (Ptr SDL_Surface)
destroySurface :: Ptr SDL_Surface -> IO ()
destroySurfaceSafe :: Ptr SDL_Surface -> IO ()
getSurfaceProperties :: Ptr SDL_Surface -> IO SDL_PropertiesID
getSurfacePropertiesSafe :: Ptr SDL_Surface -> IO SDL_PropertiesID
setSurfaceColorspace :: Ptr SDL_Surface -> SDL_Colorspace -> IO Bool
setSurfaceColorspaceSafe :: Ptr SDL_Surface -> SDL_Colorspace -> IO Bool
getSurfaceColorspace :: Ptr SDL_Surface -> IO SDL_Colorspace
getSurfaceColorspaceSafe :: Ptr SDL_Surface -> IO SDL_Colorspace
createSurfacePalette :: Ptr SDL_Surface -> IO (Ptr SDL_Palette)
createSurfacePaletteSafe :: Ptr SDL_Surface -> IO (Ptr SDL_Palette)
setSurfacePalette :: Ptr SDL_Surface -> Ptr SDL_Palette -> IO Bool
setSurfacePaletteSafe :: Ptr SDL_Surface -> Ptr SDL_Palette -> IO Bool
getSurfacePalette :: Ptr SDL_Surface -> IO (Ptr SDL_Palette)
getSurfacePaletteSafe :: Ptr SDL_Surface -> IO (Ptr SDL_Palette)
addSurfaceAlternateImage :: Ptr SDL_Surface -> Ptr SDL_Surface -> IO Bool
addSurfaceAlternateImageSafe :: Ptr SDL_Surface -> Ptr SDL_Surface -> IO Bool
surfaceHasAlternateImages :: Ptr SDL_Surface -> IO Bool
surfaceHasAlternateImagesSafe :: Ptr SDL_Surface -> IO Bool
getSurfaceImages :: Ptr SDL_Surface -> Ptr CInt -> IO (Ptr (Ptr SDL_Surface))
getSurfaceImagesSafe :: Ptr SDL_Surface -> Ptr CInt -> IO (Ptr (Ptr SDL_Surface))
removeSurfaceAlternateImages :: Ptr SDL_Surface -> IO ()
removeSurfaceAlternateImagesSafe :: Ptr SDL_Surface -> IO ()
lockSurface :: Ptr SDL_Surface -> IO Bool
lockSurfaceSafe :: Ptr SDL_Surface -> IO Bool
unlockSurface :: Ptr SDL_Surface -> IO ()
unlockSurfaceSafe :: Ptr SDL_Surface -> IO ()
loadSurfaceIO :: Ptr SDL_IOStream -> Bool -> IO (Ptr SDL_Surface)
loadSurfaceIOSafe :: Ptr SDL_IOStream -> Bool -> IO (Ptr SDL_Surface)
loadSurface :: PtrConst CChar -> IO (Ptr SDL_Surface)
loadSurfaceSafe :: PtrConst CChar -> IO (Ptr SDL_Surface)
loadBMPIO :: Ptr SDL_IOStream -> Bool -> IO (Ptr SDL_Surface)
loadBMPIOSafe :: Ptr SDL_IOStream -> Bool -> IO (Ptr SDL_Surface)
loadBMP :: PtrConst CChar -> IO (Ptr SDL_Surface)
loadBMPSafe :: PtrConst CChar -> IO (Ptr SDL_Surface)
saveBMPIO :: Ptr SDL_Surface -> Ptr SDL_IOStream -> Bool -> IO Bool
saveBMPIOSafe :: Ptr SDL_Surface -> Ptr SDL_IOStream -> Bool -> IO Bool
saveBMP :: Ptr SDL_Surface -> PtrConst CChar -> IO Bool
saveBMPSafe :: Ptr SDL_Surface -> PtrConst CChar -> IO Bool
loadPNGIO :: Ptr SDL_IOStream -> Bool -> IO (Ptr SDL_Surface)
loadPNGIOSafe :: Ptr SDL_IOStream -> Bool -> IO (Ptr SDL_Surface)
loadPNG :: PtrConst CChar -> IO (Ptr SDL_Surface)
loadPNGSafe :: PtrConst CChar -> IO (Ptr SDL_Surface)
savePNGIO :: Ptr SDL_Surface -> Ptr SDL_IOStream -> Bool -> IO Bool
savePNGIOSafe :: Ptr SDL_Surface -> Ptr SDL_IOStream -> Bool -> IO Bool
savePNG :: Ptr SDL_Surface -> PtrConst CChar -> IO Bool
savePNGSafe :: Ptr SDL_Surface -> PtrConst CChar -> IO Bool
setSurfaceRLE :: Ptr SDL_Surface -> Bool -> IO Bool
setSurfaceRLESafe :: Ptr SDL_Surface -> Bool -> IO Bool
surfaceHasRLE :: Ptr SDL_Surface -> IO Bool
surfaceHasRLESafe :: Ptr SDL_Surface -> IO Bool
setSurfaceColorKey :: Ptr SDL_Surface -> Bool -> Word32 -> IO Bool
setSurfaceColorKeySafe :: Ptr SDL_Surface -> Bool -> Word32 -> IO Bool
surfaceHasColorKey :: Ptr SDL_Surface -> IO Bool
surfaceHasColorKeySafe :: Ptr SDL_Surface -> IO Bool
getSurfaceColorKey :: Ptr SDL_Surface -> Ptr Uint32 -> IO Bool
getSurfaceColorKeySafe :: Ptr SDL_Surface -> Ptr Uint32 -> IO Bool
setSurfaceColorMod :: Ptr SDL_Surface -> Word8 -> Word8 -> Word8 -> IO Bool
setSurfaceColorModSafe :: Ptr SDL_Surface -> Word8 -> Word8 -> Word8 -> IO Bool
getSurfaceColorMod :: Ptr SDL_Surface -> Ptr Uint8 -> Ptr Uint8 -> Ptr Uint8 -> IO Bool
getSurfaceColorModSafe :: Ptr SDL_Surface -> Ptr Uint8 -> Ptr Uint8 -> Ptr Uint8 -> IO Bool
setSurfaceAlphaMod :: Ptr SDL_Surface -> Word8 -> IO Bool
setSurfaceAlphaModSafe :: Ptr SDL_Surface -> Word8 -> IO Bool
getSurfaceAlphaMod :: Ptr SDL_Surface -> Ptr Uint8 -> IO Bool
getSurfaceAlphaModSafe :: Ptr SDL_Surface -> Ptr Uint8 -> IO Bool
setSurfaceBlendMode :: Ptr SDL_Surface -> SDL_BlendMode -> IO Bool
setSurfaceBlendModeSafe :: Ptr SDL_Surface -> SDL_BlendMode -> IO Bool
getSurfaceBlendMode :: Ptr SDL_Surface -> Ptr SDL_BlendMode -> IO Bool
getSurfaceBlendModeSafe :: Ptr SDL_Surface -> Ptr SDL_BlendMode -> IO Bool
setSurfaceClipRect :: Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
setSurfaceClipRectSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
getSurfaceClipRect :: Ptr SDL_Surface -> Ptr SDL_Rect -> IO Bool
getSurfaceClipRectSafe :: Ptr SDL_Surface -> Ptr SDL_Rect -> IO Bool
flipSurface :: Ptr SDL_Surface -> SDL_FlipMode -> IO Bool
flipSurfaceSafe :: Ptr SDL_Surface -> SDL_FlipMode -> IO Bool
rotateSurface :: Ptr SDL_Surface -> Float -> IO (Ptr SDL_Surface)
rotateSurfaceSafe :: Ptr SDL_Surface -> Float -> IO (Ptr SDL_Surface)
duplicateSurface :: Ptr SDL_Surface -> IO (Ptr SDL_Surface)
duplicateSurfaceSafe :: Ptr SDL_Surface -> IO (Ptr SDL_Surface)
scaleSurface :: Ptr SDL_Surface -> Int32 -> Int32 -> SDL_ScaleMode -> IO (Ptr SDL_Surface)
scaleSurfaceSafe :: Ptr SDL_Surface -> Int32 -> Int32 -> SDL_ScaleMode -> IO (Ptr SDL_Surface)
convertSurface :: Ptr SDL_Surface -> SDL_PixelFormat -> IO (Ptr SDL_Surface)
convertSurfaceSafe :: Ptr SDL_Surface -> SDL_PixelFormat -> IO (Ptr SDL_Surface)
convertSurfaceAndColorspace :: Ptr SDL_Surface -> SDL_PixelFormat -> Ptr SDL_Palette -> SDL_Colorspace -> SDL_PropertiesID -> IO (Ptr SDL_Surface)
convertSurfaceAndColorspaceSafe :: Ptr SDL_Surface -> SDL_PixelFormat -> Ptr SDL_Palette -> SDL_Colorspace -> SDL_PropertiesID -> IO (Ptr SDL_Surface)
convertPixels :: Int32 -> Int32 -> SDL_PixelFormat -> PtrConst Void -> Int32 -> SDL_PixelFormat -> Ptr Void -> Int32 -> IO Bool
convertPixelsSafe :: Int32 -> Int32 -> SDL_PixelFormat -> PtrConst Void -> Int32 -> SDL_PixelFormat -> Ptr Void -> Int32 -> IO Bool
convertPixelsAndColorspace :: Int32 -> Int32 -> SDL_PixelFormat -> SDL_Colorspace -> SDL_PropertiesID -> PtrConst Void -> Int32 -> SDL_PixelFormat -> SDL_Colorspace -> SDL_PropertiesID -> Ptr Void -> Int32 -> IO Bool
convertPixelsAndColorspaceSafe :: Int32 -> Int32 -> SDL_PixelFormat -> SDL_Colorspace -> SDL_PropertiesID -> PtrConst Void -> Int32 -> SDL_PixelFormat -> SDL_Colorspace -> SDL_PropertiesID -> Ptr Void -> Int32 -> IO Bool
premultiplyAlpha :: Int32 -> Int32 -> SDL_PixelFormat -> PtrConst Void -> Int32 -> SDL_PixelFormat -> Ptr Void -> Int32 -> Bool -> IO Bool
premultiplyAlphaSafe :: Int32 -> Int32 -> SDL_PixelFormat -> PtrConst Void -> Int32 -> SDL_PixelFormat -> Ptr Void -> Int32 -> Bool -> IO Bool
premultiplySurfaceAlpha :: Ptr SDL_Surface -> Bool -> IO Bool
premultiplySurfaceAlphaSafe :: Ptr SDL_Surface -> Bool -> IO Bool
clearSurface :: Ptr SDL_Surface -> Float -> Float -> Float -> Float -> IO Bool
clearSurfaceSafe :: Ptr SDL_Surface -> Float -> Float -> Float -> Float -> IO Bool
fillSurfaceRect :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Word32 -> IO Bool
fillSurfaceRectSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Word32 -> IO Bool
fillSurfaceRects :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Int32 -> Word32 -> IO Bool
fillSurfaceRectsSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Int32 -> Word32 -> IO Bool
blitSurface :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurfaceSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurfaceUnchecked :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurfaceUncheckedSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurfaceScaled :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> SDL_ScaleMode -> IO Bool
blitSurfaceScaledSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> SDL_ScaleMode -> IO Bool
blitSurfaceUncheckedScaled :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> SDL_ScaleMode -> IO Bool
blitSurfaceUncheckedScaledSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> SDL_ScaleMode -> IO Bool
stretchSurface :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> SDL_ScaleMode -> IO Bool
stretchSurfaceSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> SDL_ScaleMode -> IO Bool
blitSurfaceTiled :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurfaceTiledSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurfaceTiledWithScale :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Float -> SDL_ScaleMode -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurfaceTiledWithScaleSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Float -> SDL_ScaleMode -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurface9Grid :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Int32 -> Int32 -> Int32 -> Int32 -> Float -> SDL_ScaleMode -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
blitSurface9GridSafe :: Ptr SDL_Surface -> PtrConst SDL_Rect -> Int32 -> Int32 -> Int32 -> Int32 -> Float -> SDL_ScaleMode -> Ptr SDL_Surface -> PtrConst SDL_Rect -> IO Bool
mapSurfaceRGB :: Ptr SDL_Surface -> Word8 -> Word8 -> Word8 -> IO Word32
mapSurfaceRGBSafe :: Ptr SDL_Surface -> Word8 -> Word8 -> Word8 -> IO Word32
mapSurfaceRGBA :: Ptr SDL_Surface -> Word8 -> Word8 -> Word8 -> Word8 -> IO Word32
mapSurfaceRGBASafe :: Ptr SDL_Surface -> Word8 -> Word8 -> Word8 -> Word8 -> IO Word32
readSurfacePixel :: Ptr SDL_Surface -> Int32 -> Int32 -> Ptr Uint8 -> Ptr Uint8 -> Ptr Uint8 -> Ptr Uint8 -> IO Bool
readSurfacePixelSafe :: Ptr SDL_Surface -> Int32 -> Int32 -> Ptr Uint8 -> Ptr Uint8 -> Ptr Uint8 -> Ptr Uint8 -> IO Bool
readSurfacePixelFloat :: Ptr SDL_Surface -> Int32 -> Int32 -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> IO Bool
readSurfacePixelFloatSafe :: Ptr SDL_Surface -> Int32 -> Int32 -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> IO Bool
writeSurfacePixel :: Ptr SDL_Surface -> Int32 -> Int32 -> Word8 -> Word8 -> Word8 -> Word8 -> IO Bool
writeSurfacePixelSafe :: Ptr SDL_Surface -> Int32 -> Int32 -> Word8 -> Word8 -> Word8 -> Word8 -> IO Bool
writeSurfacePixelFloat :: Ptr SDL_Surface -> Int32 -> Int32 -> Float -> Float -> Float -> Float -> IO Bool
writeSurfacePixelFloatSafe :: Ptr SDL_Surface -> Int32 -> Int32 -> Float -> Float -> Float -> Float -> IO Bool
mustLock :: Ptr SDL_Surface -> IO Bool

Documentation

module SDL3.Sys.Bindgen.Surface

Typed constants

pattern SDL_SURFACE_PREALLOCATED :: SDL_SurfaceFlags Source #

Typed constant for macro SDL_SURFACE_PREALLOCATED. Combine with .|. from Data.Bits.

pattern SDL_SURFACE_LOCK_NEEDED :: SDL_SurfaceFlags Source #

Typed constant for macro SDL_SURFACE_LOCK_NEEDED. Combine with .|. from Data.Bits.

pattern SDL_SURFACE_LOCKED :: SDL_SurfaceFlags Source #

Typed constant for macro SDL_SURFACE_LOCKED. Combine with .|. from Data.Bits.

pattern SDL_SURFACE_SIMD_ALIGNED :: SDL_SurfaceFlags Source #

Typed constant for macro SDL_SURFACE_SIMD_ALIGNED. Combine with .|. from Data.Bits.

Function aliases

createSurface Source #

Arguments

:: Int32	`width` the width of the surface.
-> Int32	`height` the height of the surface.
-> SDL_PixelFormat	`format` the SDL_PixelFormat for the new surface's pixel format.
-> IO (Ptr SDL_Surface)

Allocate a new surface with a specific pixel format.

The pixels of the new surface are initialized to zero.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: createSurfaceFrom, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_CreateSurface. The safe flavor is createSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_CreateSurface, defined at SDL3/SDL_surface.h 173:43

Since: 3.2.0

createSurfaceSafe Source #

Arguments

:: Int32	`width` the width of the surface.
-> Int32	`height` the height of the surface.
-> SDL_PixelFormat	`format` the SDL_PixelFormat for the new surface's pixel format.
-> IO (Ptr SDL_Surface)

Allocate a new surface with a specific pixel format.

The pixels of the new surface are initialized to zero.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: createSurfaceFrom, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_CreateSurface. The unsafe flavor is createSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_CreateSurface, defined at SDL3/SDL_surface.h 173:43

Since: 3.2.0

createSurfaceFrom Source #

Arguments

:: Int32	`width` the width of the surface.
-> Int32	`height` the height of the surface.
-> SDL_PixelFormat	`format` the SDL_PixelFormat for the new surface's pixel format.
-> Ptr Void	`pixels` a pointer to existing pixel data.
-> Int32	`pitch` the number of bytes between each row, including padding.
-> IO (Ptr SDL_Surface)

Allocate a new surface with a specific pixel format and existing pixel data.

No copy is made of the pixel data. Pixel data is not managed automatically; you must free the surface before you free the pixel data.

Pitch is the offset in bytes from one row of pixels to the next, e.g. width*4 for SDL_PIXELFORMAT_RGBA8888.

You may pass NULL for pixels and 0 for pitch to create a surface that you will fill in with valid values later.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: createSurface, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_CreateSurfaceFrom. The safe flavor is createSurfaceFromSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_CreateSurfaceFrom, defined at SDL3/SDL_surface.h 203:43

Since: 3.2.0

createSurfaceFromSafe Source #

Arguments

:: Int32	`width` the width of the surface.
-> Int32	`height` the height of the surface.
-> SDL_PixelFormat	`format` the SDL_PixelFormat for the new surface's pixel format.
-> Ptr Void	`pixels` a pointer to existing pixel data.
-> Int32	`pitch` the number of bytes between each row, including padding.
-> IO (Ptr SDL_Surface)

Allocate a new surface with a specific pixel format and existing pixel data.

No copy is made of the pixel data. Pixel data is not managed automatically; you must free the surface before you free the pixel data.

Pitch is the offset in bytes from one row of pixels to the next, e.g. width*4 for SDL_PIXELFORMAT_RGBA8888.

You may pass NULL for pixels and 0 for pitch to create a surface that you will fill in with valid values later.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: createSurface, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_CreateSurfaceFrom. The unsafe flavor is createSurfaceFrom .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_CreateSurfaceFrom, defined at SDL3/SDL_surface.h 203:43

Since: 3.2.0

destroySurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` to free.
-> IO ()

Free a surface.

It is safe to pass NULL to this function.

Thread safety: No other thread should be using the surface when it is freed.
See also: createSurface, createSurfaceFrom

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_DestroySurface. The safe flavor is destroySurfaceSafe .
C declaration: SDL_DestroySurface, defined at SDL3/SDL_surface.h 219:34

Since: 3.2.0

destroySurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` to free.
-> IO ()

Free a surface.

It is safe to pass NULL to this function.

Thread safety: No other thread should be using the surface when it is freed.
See also: createSurface, createSurfaceFrom

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_DestroySurface. The unsafe flavor is destroySurface .
C declaration: SDL_DestroySurface, defined at SDL3/SDL_surface.h 219:34

Since: 3.2.0

getSurfaceProperties Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO SDL_PropertiesID

Get the properties associated with a surface.

The following properties are understood by SDL:

sDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT: for HDR10 and floating point surfaces, this defines the value of 100% diffuse white, with higher values being displayed in the High Dynamic Range headroom. This defaults to 203 for HDR10 surfaces and 1.0 for floating point surfaces.
sDL_PROP_SURFACE_HDR_HEADROOM_FLOAT: for HDR10 and floating point surfaces, this defines the maximum dynamic range used by the content, in terms of the SDR white point. This defaults to 0.0, which disables tone mapping.
sDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING: the tone mapping operator used when compressing from a surface with high dynamic range to another with lower dynamic range. Currently this supports "chrome", which uses the same tone mapping that Chrome uses for HDR content, the form "*=N", where N is a floating point scale factor applied in linear space, and "none", which disables tone mapping. This defaults to "chrome".
sDL_PROP_SURFACE_HOTSPOT_X_NUMBER: the hotspot pixel offset from the left edge of the image, if this surface is being used as a cursor.
sDL_PROP_SURFACE_HOTSPOT_Y_NUMBER: the hotspot pixel offset from the top edge of the image, if this surface is being used as a cursor.
sDL_PROP_SURFACE_ROTATION_FLOAT: the number of degrees a surface's data is meant to be rotated clockwise to make the image right-side up. Default 1. This is used by the camera API, if a mobile device is oriented differently than what its camera provides (i.e. - the camera always provides portrait images but the phone is being held in landscape orientation). Since SDL 3.4.0.

Returns: a valid property ID on success or 0 on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceProperties. The safe flavor is getSurfacePropertiesSafe .
C declaration: SDL_GetSurfaceProperties, defined at SDL3/SDL_surface.h 259:46

Since: 3.2.0

getSurfacePropertiesSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO SDL_PropertiesID

Get the properties associated with a surface.

The following properties are understood by SDL:

sDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT: for HDR10 and floating point surfaces, this defines the value of 100% diffuse white, with higher values being displayed in the High Dynamic Range headroom. This defaults to 203 for HDR10 surfaces and 1.0 for floating point surfaces.
sDL_PROP_SURFACE_HDR_HEADROOM_FLOAT: for HDR10 and floating point surfaces, this defines the maximum dynamic range used by the content, in terms of the SDR white point. This defaults to 0.0, which disables tone mapping.
sDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING: the tone mapping operator used when compressing from a surface with high dynamic range to another with lower dynamic range. Currently this supports "chrome", which uses the same tone mapping that Chrome uses for HDR content, the form "*=N", where N is a floating point scale factor applied in linear space, and "none", which disables tone mapping. This defaults to "chrome".
sDL_PROP_SURFACE_HOTSPOT_X_NUMBER: the hotspot pixel offset from the left edge of the image, if this surface is being used as a cursor.
sDL_PROP_SURFACE_HOTSPOT_Y_NUMBER: the hotspot pixel offset from the top edge of the image, if this surface is being used as a cursor.
sDL_PROP_SURFACE_ROTATION_FLOAT: the number of degrees a surface's data is meant to be rotated clockwise to make the image right-side up. Default 1. This is used by the camera API, if a mobile device is oriented differently than what its camera provides (i.e. - the camera always provides portrait images but the phone is being held in landscape orientation). Since SDL 3.4.0.

Returns: a valid property ID on success or 0 on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceProperties. The unsafe flavor is getSurfaceProperties .
C declaration: SDL_GetSurfaceProperties, defined at SDL3/SDL_surface.h 259:46

Since: 3.2.0

setSurfaceColorspace Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> SDL_Colorspace	`colorspace` an SDL_Colorspace value describing the surface colorspace.
-> IO Bool

Set the colorspace used by a surface.

Setting the colorspace doesn't change the pixels, only how they are interpreted in color operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceColorspace

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfaceColorspace. The safe flavor is setSurfaceColorspaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceColorspace, defined at SDL3/SDL_surface.h 287:34

Since: 3.2.0

setSurfaceColorspaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> SDL_Colorspace	`colorspace` an SDL_Colorspace value describing the surface colorspace.
-> IO Bool

Set the colorspace used by a surface.

Setting the colorspace doesn't change the pixels, only how they are interpreted in color operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceColorspace

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfaceColorspace. The unsafe flavor is setSurfaceColorspace .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceColorspace, defined at SDL3/SDL_surface.h 287:34

Since: 3.2.0

getSurfaceColorspace Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO SDL_Colorspace

Get the colorspace used by a surface.

The colorspace defaults to SDL_COLORSPACE_SRGB_LINEAR for floating point formats, SDL_COLORSPACE_HDR10 for 10-bit formats, SDL_COLORSPACE_SRGB for other RGB surfaces and SDL_COLORSPACE_BT709_FULL for YUV textures.

Returns: the colorspace used by the surface, or SDL_COLORSPACE_UNKNOWN if the surface is NULL.
Thread safety: This function can be called on different threads with different surfaces.
See also: setSurfaceColorspace

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceColorspace. The safe flavor is getSurfaceColorspaceSafe .
C declaration: SDL_GetSurfaceColorspace, defined at SDL3/SDL_surface.h 307:44

Since: 3.2.0

getSurfaceColorspaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO SDL_Colorspace

Get the colorspace used by a surface.

The colorspace defaults to SDL_COLORSPACE_SRGB_LINEAR for floating point formats, SDL_COLORSPACE_HDR10 for 10-bit formats, SDL_COLORSPACE_SRGB for other RGB surfaces and SDL_COLORSPACE_BT709_FULL for YUV textures.

Returns: the colorspace used by the surface, or SDL_COLORSPACE_UNKNOWN if the surface is NULL.
Thread safety: This function can be called on different threads with different surfaces.
See also: setSurfaceColorspace

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceColorspace. The unsafe flavor is getSurfaceColorspace .
C declaration: SDL_GetSurfaceColorspace, defined at SDL3/SDL_surface.h 307:44

Since: 3.2.0

createSurfacePalette Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> IO (Ptr SDL_Palette)

Create a palette and associate it with a surface.

This function creates a palette compatible with the provided surface. The palette is then returned for you to modify, and the surface will automatically use the new palette in future operations. You do not need to destroy the returned palette, it will be freed when the reference count reaches 0, usually when the surface is destroyed.

Bitmap surfaces (with format SDL_PIXELFORMAT_INDEX1LSB or SDL_PIXELFORMAT_INDEX1MSB) will have the palette initialized with 0 as white and 1 as black. Other surfaces will get a palette initialized with white in every entry.

If this function is called for a surface that already has a palette, a new palette will be created to replace it.

Returns: a new SDL_Palette structure on success or NULL on failure (e.g. if the surface didn't have an index format); call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: setPaletteColors

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_CreateSurfacePalette. The safe flavor is createSurfacePaletteSafe .
C declaration: SDL_CreateSurfacePalette, defined at SDL3/SDL_surface.h 338:43

Since: 3.2.0

createSurfacePaletteSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> IO (Ptr SDL_Palette)

Create a palette and associate it with a surface.

This function creates a palette compatible with the provided surface. The palette is then returned for you to modify, and the surface will automatically use the new palette in future operations. You do not need to destroy the returned palette, it will be freed when the reference count reaches 0, usually when the surface is destroyed.

Bitmap surfaces (with format SDL_PIXELFORMAT_INDEX1LSB or SDL_PIXELFORMAT_INDEX1MSB) will have the palette initialized with 0 as white and 1 as black. Other surfaces will get a palette initialized with white in every entry.

If this function is called for a surface that already has a palette, a new palette will be created to replace it.

Returns: a new SDL_Palette structure on success or NULL on failure (e.g. if the surface didn't have an index format); call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: setPaletteColors

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_CreateSurfacePalette. The unsafe flavor is createSurfacePalette .
C declaration: SDL_CreateSurfacePalette, defined at SDL3/SDL_surface.h 338:43

Since: 3.2.0

setSurfacePalette Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Ptr SDL_Palette	`palette` the SDL_Palette structure to use.
-> IO Bool

Set the palette used by a surface.

Setting the palette keeps an internal reference to the palette, which can be safely destroyed afterwards.

A single palette can be shared with many surfaces.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: createPalette, getSurfacePalette

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfacePalette. The safe flavor is setSurfacePaletteSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfacePalette, defined at SDL3/SDL_surface.h 361:34

Since: 3.2.0

setSurfacePaletteSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Ptr SDL_Palette	`palette` the SDL_Palette structure to use.
-> IO Bool

Set the palette used by a surface.

Setting the palette keeps an internal reference to the palette, which can be safely destroyed afterwards.

A single palette can be shared with many surfaces.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: createPalette, getSurfacePalette

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfacePalette. The unsafe flavor is setSurfacePalette .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfacePalette, defined at SDL3/SDL_surface.h 361:34

Since: 3.2.0

getSurfacePalette Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO (Ptr SDL_Palette)

Get the palette used by a surface.

Returns: a pointer to the palette used by the surface, or NULL if there is no palette used.
Thread safety: It is safe to call this function from any thread.
See also: setSurfacePalette

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfacePalette. The safe flavor is getSurfacePaletteSafe .
C declaration: SDL_GetSurfacePalette, defined at SDL3/SDL_surface.h 376:43

Since: 3.2.0

getSurfacePaletteSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO (Ptr SDL_Palette)

Get the palette used by a surface.

Returns: a pointer to the palette used by the surface, or NULL if there is no palette used.
Thread safety: It is safe to call this function from any thread.
See also: setSurfacePalette

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfacePalette. The unsafe flavor is getSurfacePalette .
C declaration: SDL_GetSurfacePalette, defined at SDL3/SDL_surface.h 376:43

Since: 3.2.0

addSurfaceAlternateImage Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Ptr SDL_Surface	`image` a pointer to an alternate `SDL_Surface` to associate with this surface.
-> IO Bool

Add an alternate version of a surface.

This function adds an alternate version of this surface, usually used for content with high DPI representations like cursors or icons. The size, format, and content do not need to match the original surface, and these alternate versions will not be updated when the original surface changes.

This function adds a reference to the alternate version, so you should call destroySurface on the image after this call.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: removeSurfaceAlternateImages, getSurfaceImages, surfaceHasAlternateImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_AddSurfaceAlternateImage. The safe flavor is addSurfaceAlternateImageSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_AddSurfaceAlternateImage, defined at SDL3/SDL_surface.h 404:34

Since: 3.2.0

addSurfaceAlternateImageSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Ptr SDL_Surface	`image` a pointer to an alternate `SDL_Surface` to associate with this surface.
-> IO Bool

Add an alternate version of a surface.

This function adds an alternate version of this surface, usually used for content with high DPI representations like cursors or icons. The size, format, and content do not need to match the original surface, and these alternate versions will not be updated when the original surface changes.

This function adds a reference to the alternate version, so you should call destroySurface on the image after this call.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: removeSurfaceAlternateImages, getSurfaceImages, surfaceHasAlternateImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_AddSurfaceAlternateImage. The unsafe flavor is addSurfaceAlternateImage .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_AddSurfaceAlternateImage, defined at SDL3/SDL_surface.h 404:34

Since: 3.2.0

surfaceHasAlternateImages Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO Bool

Return whether a surface has alternate versions available.

Returns: true if alternate versions are available or false otherwise.
Thread safety: It is safe to call this function from any thread.
See also: addSurfaceAlternateImage, removeSurfaceAlternateImages, getSurfaceImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SurfaceHasAlternateImages. The safe flavor is surfaceHasAlternateImagesSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SurfaceHasAlternateImages, defined at SDL3/SDL_surface.h 420:34

Since: 3.2.0

surfaceHasAlternateImagesSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO Bool

Return whether a surface has alternate versions available.

Returns: true if alternate versions are available or false otherwise.
Thread safety: It is safe to call this function from any thread.
See also: addSurfaceAlternateImage, removeSurfaceAlternateImages, getSurfaceImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SurfaceHasAlternateImages. The unsafe flavor is surfaceHasAlternateImages .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SurfaceHasAlternateImages, defined at SDL3/SDL_surface.h 420:34

Since: 3.2.0

getSurfaceImages Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr CInt	`count` a pointer filled in with the number of surface pointers returned, may be NULL.
-> IO (Ptr (Ptr SDL_Surface))

Get an array including all versions of a surface.

This returns all versions of a surface, with the surface being queried as the first element in the returned array.

Freeing the array of surfaces does not affect the surfaces in the array. They are still referenced by the surface being queried and will be cleaned up normally.

Returns: a NULL terminated array of SDL_Surface pointers or NULL on failure; call getError for more information. This should be freed with free when it is no longer needed.
Thread safety: This function can be called on different threads with different surfaces.
See also: addSurfaceAlternateImage, removeSurfaceAlternateImages, surfaceHasAlternateImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceImages. The safe flavor is getSurfaceImagesSafe .
C declaration: SDL_GetSurfaceImages, defined at SDL3/SDL_surface.h 448:44

Since: 3.2.0

getSurfaceImagesSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr CInt	`count` a pointer filled in with the number of surface pointers returned, may be NULL.
-> IO (Ptr (Ptr SDL_Surface))

Get an array including all versions of a surface.

This returns all versions of a surface, with the surface being queried as the first element in the returned array.

Freeing the array of surfaces does not affect the surfaces in the array. They are still referenced by the surface being queried and will be cleaned up normally.

Returns: a NULL terminated array of SDL_Surface pointers or NULL on failure; call getError for more information. This should be freed with free when it is no longer needed.
Thread safety: This function can be called on different threads with different surfaces.
See also: addSurfaceAlternateImage, removeSurfaceAlternateImages, surfaceHasAlternateImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceImages. The unsafe flavor is getSurfaceImages .
C declaration: SDL_GetSurfaceImages, defined at SDL3/SDL_surface.h 448:44

Since: 3.2.0

removeSurfaceAlternateImages Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> IO ()

Remove all alternate versions of a surface.

This function removes a reference from all the alternative versions, destroying them if this is the last reference to them.

Thread safety: This function can be called on different threads with different surfaces.
See also: addSurfaceAlternateImage, getSurfaceImages, surfaceHasAlternateImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_RemoveSurfaceAlternateImages. The safe flavor is removeSurfaceAlternateImagesSafe .
C declaration: SDL_RemoveSurfaceAlternateImages, defined at SDL3/SDL_surface.h 467:34

Since: 3.2.0

removeSurfaceAlternateImagesSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> IO ()

Remove all alternate versions of a surface.

This function removes a reference from all the alternative versions, destroying them if this is the last reference to them.

Thread safety: This function can be called on different threads with different surfaces.
See also: addSurfaceAlternateImage, getSurfaceImages, surfaceHasAlternateImages

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_RemoveSurfaceAlternateImages. The unsafe flavor is removeSurfaceAlternateImages .
C declaration: SDL_RemoveSurfaceAlternateImages, defined at SDL3/SDL_surface.h 467:34

Since: 3.2.0

lockSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to be locked.
-> IO Bool

Set up a surface for directly accessing the pixels.

Between calls to lockSurface / unlockSurface, you can write to and read from surface->pixels, using the pixel format stored in surface->format. Once you are done accessing the surface, you should use unlockSurface to release it.

Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates to 0, then you can read and write to the surface at any time, and the pixel format of the surface will not change.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces. The locking referred to by this function is making the pixels available for direct access, not thread-safe locking.
See also: mustLock, unlockSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_LockSurface. The safe flavor is lockSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LockSurface, defined at SDL3/SDL_surface.h 495:34

Since: 3.2.0

lockSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to be locked.
-> IO Bool

Set up a surface for directly accessing the pixels.

Between calls to lockSurface / unlockSurface, you can write to and read from surface->pixels, using the pixel format stored in surface->format. Once you are done accessing the surface, you should use unlockSurface to release it.

Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates to 0, then you can read and write to the surface at any time, and the pixel format of the surface will not change.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces. The locking referred to by this function is making the pixels available for direct access, not thread-safe locking.
See also: mustLock, unlockSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_LockSurface. The unsafe flavor is lockSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LockSurface, defined at SDL3/SDL_surface.h 495:34

Since: 3.2.0

unlockSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to be unlocked.
-> IO ()

Release a surface after directly accessing the pixels.

Thread safety: This function is not thread safe. The locking referred to by this function is making the pixels available for direct access, not thread-safe locking.
See also: lockSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_UnlockSurface. The safe flavor is unlockSurfaceSafe .
C declaration: SDL_UnlockSurface, defined at SDL3/SDL_surface.h 510:34

Since: 3.2.0

unlockSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to be unlocked.
-> IO ()

Release a surface after directly accessing the pixels.

Thread safety: This function is not thread safe. The locking referred to by this function is making the pixels available for direct access, not thread-safe locking.
See also: lockSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_UnlockSurface. The unsafe flavor is unlockSurface .
C declaration: SDL_UnlockSurface, defined at SDL3/SDL_surface.h 510:34

Since: 3.2.0

loadSurfaceIO Source #

Arguments

:: Ptr SDL_IOStream	`src` the data stream for the surface.
-> Bool	`closeio` if true, calls `closeIO` on `src` before returning, even in the case of an error.
-> IO (Ptr SDL_Surface)

Load a BMP or PNG image from a seekable SDL data stream.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_LoadSurface_IO. The safe flavor is loadSurfaceIOSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LoadSurface_IO, defined at SDL3/SDL_surface.h 531:43

Since: 3.4.0

loadSurfaceIOSafe Source #

Arguments

:: Ptr SDL_IOStream	`src` the data stream for the surface.
-> Bool	`closeio` if true, calls `closeIO` on `src` before returning, even in the case of an error.
-> IO (Ptr SDL_Surface)

Load a BMP or PNG image from a seekable SDL data stream.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_LoadSurface_IO. The unsafe flavor is loadSurfaceIO .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LoadSurface_IO, defined at SDL3/SDL_surface.h 531:43

Since: 3.4.0

loadSurface Source #

Arguments

:: PtrConst CChar	`file` the file to load.
-> IO (Ptr SDL_Surface)

Load a BMP or PNG image from a file.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadSurfaceIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_LoadSurface. The safe flavor is loadSurfaceSafe .
C declaration: SDL_LoadSurface, defined at SDL3/SDL_surface.h 550:43

Since: 3.4.0

loadSurfaceSafe Source #

Arguments

:: PtrConst CChar	`file` the file to load.
-> IO (Ptr SDL_Surface)

Load a BMP or PNG image from a file.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadSurfaceIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_LoadSurface. The unsafe flavor is loadSurface .
C declaration: SDL_LoadSurface, defined at SDL3/SDL_surface.h 550:43

Since: 3.4.0

loadBMPIO Source #

Arguments

:: Ptr SDL_IOStream	`src` the data stream for the surface.
-> Bool	`closeio` if true, calls `closeIO` on `src` before returning, even in the case of an error.
-> IO (Ptr SDL_Surface)

Load a BMP image from a seekable SDL data stream.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadBMP, saveBMPIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_LoadBMP_IO. The safe flavor is loadBMPIOSafe : reads the whole stream; a Haskell SDL_IOStreamInterface re-enters synchronously.
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LoadBMP_IO, defined at SDL3/SDL_surface.h 572:43

Since: 3.2.0

loadBMPIOSafe Source #

Arguments

:: Ptr SDL_IOStream	`src` the data stream for the surface.
-> Bool	`closeio` if true, calls `closeIO` on `src` before returning, even in the case of an error.
-> IO (Ptr SDL_Surface)

Load a BMP image from a seekable SDL data stream.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadBMP, saveBMPIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_LoadBMP_IO. The unsafe flavor is loadBMPIO : reads the whole stream; a Haskell SDL_IOStreamInterface re-enters synchronously.
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LoadBMP_IO, defined at SDL3/SDL_surface.h 572:43

Since: 3.2.0

loadBMP Source #

Arguments

:: PtrConst CChar	`file` the BMP file to load.
-> IO (Ptr SDL_Surface)

Load a BMP image from a file.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadBMPIO, saveBMP

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_LoadBMP. The safe flavor is loadBMPSafe : blocks on whole-file I/O.
C declaration: SDL_LoadBMP, defined at SDL3/SDL_surface.h 592:43

Since: 3.2.0

loadBMPSafe Source #

Arguments

:: PtrConst CChar	`file` the BMP file to load.
-> IO (Ptr SDL_Surface)

Load a BMP image from a file.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadBMPIO, saveBMP

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_LoadBMP. The unsafe flavor is loadBMP : blocks on whole-file I/O.
C declaration: SDL_LoadBMP, defined at SDL3/SDL_surface.h 592:43

Since: 3.2.0

saveBMPIO Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> Ptr SDL_IOStream	`dst` a data stream to save to.
-> Bool	`closeio` if true, calls `closeIO` on `dst` before returning, even in the case of an error.
-> IO Bool

Save a surface to a seekable SDL data stream in BMP format.

Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadBMPIO, saveBMP

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SaveBMP_IO. The safe flavor is saveBMPIOSafe : writes the whole stream; a Haskell SDL_IOStreamInterface re-enters synchronously.
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SaveBMP_IO, defined at SDL3/SDL_surface.h 618:34

Since: 3.2.0

saveBMPIOSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> Ptr SDL_IOStream	`dst` a data stream to save to.
-> Bool	`closeio` if true, calls `closeIO` on `dst` before returning, even in the case of an error.
-> IO Bool

Save a surface to a seekable SDL data stream in BMP format.

Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadBMPIO, saveBMP

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SaveBMP_IO. The unsafe flavor is saveBMPIO : writes the whole stream; a Haskell SDL_IOStreamInterface re-enters synchronously.
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SaveBMP_IO, defined at SDL3/SDL_surface.h 618:34

Since: 3.2.0

saveBMP Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> PtrConst CChar	`file` a file to save to.
-> IO Bool

Save a surface to a file in BMP format.

Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadBMP, saveBMPIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SaveBMP. The safe flavor is saveBMPSafe : blocks on whole-file I/O.
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SaveBMP, defined at SDL3/SDL_surface.h 642:34

Since: 3.2.0

saveBMPSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> PtrConst CChar	`file` a file to save to.
-> IO Bool

Save a surface to a file in BMP format.

Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadBMP, saveBMPIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SaveBMP. The unsafe flavor is saveBMP : blocks on whole-file I/O.
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SaveBMP, defined at SDL3/SDL_surface.h 642:34

Since: 3.2.0

loadPNGIO Source #

Arguments

:: Ptr SDL_IOStream	`src` the data stream for the surface.
-> Bool	`closeio` if true, calls `closeIO` on `src` before returning, even in the case of an error.
-> IO (Ptr SDL_Surface)

Load a PNG image from a seekable SDL data stream.

This is intended as a convenience function for loading images from trusted sources. If you want to load arbitrary images you should use libpng or another image loading library designed with security in mind.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadPNG, savePNGIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_LoadPNG_IO. The safe flavor is loadPNGIOSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LoadPNG_IO, defined at SDL3/SDL_surface.h 668:43

Since: 3.4.0

loadPNGIOSafe Source #

Arguments

:: Ptr SDL_IOStream	`src` the data stream for the surface.
-> Bool	`closeio` if true, calls `closeIO` on `src` before returning, even in the case of an error.
-> IO (Ptr SDL_Surface)

Load a PNG image from a seekable SDL data stream.

This is intended as a convenience function for loading images from trusted sources. If you want to load arbitrary images you should use libpng or another image loading library designed with security in mind.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadPNG, savePNGIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_LoadPNG_IO. The unsafe flavor is loadPNGIO .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_LoadPNG_IO, defined at SDL3/SDL_surface.h 668:43

Since: 3.4.0

loadPNG Source #

Arguments

:: PtrConst CChar	`file` the PNG file to load.
-> IO (Ptr SDL_Surface)

Load a PNG image from a file.

This is intended as a convenience function for loading images from trusted sources. If you want to load arbitrary images you should use libpng or another image loading library designed with security in mind.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadPNGIO, savePNG

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_LoadPNG. The safe flavor is loadPNGSafe .
C declaration: SDL_LoadPNG, defined at SDL3/SDL_surface.h 692:43

Since: 3.4.0

loadPNGSafe Source #

Arguments

:: PtrConst CChar	`file` the PNG file to load.
-> IO (Ptr SDL_Surface)

Load a PNG image from a file.

This is intended as a convenience function for loading images from trusted sources. If you want to load arbitrary images you should use libpng or another image loading library designed with security in mind.

The new surface should be freed with destroySurface. Not doing so will result in a memory leak.

Returns: a pointer to a new SDL_Surface structure or NULL on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: destroySurface, loadPNGIO, savePNG

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_LoadPNG. The unsafe flavor is loadPNG .
C declaration: SDL_LoadPNG, defined at SDL3/SDL_surface.h 692:43

Since: 3.4.0

savePNGIO Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> Ptr SDL_IOStream	`dst` a data stream to save to.
-> Bool	`closeio` if true, calls `closeIO` on `dst` before returning, even in the case of an error.
-> IO Bool

Save a surface to a seekable SDL data stream in PNG format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadPNGIO, savePNG

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SavePNG_IO. The safe flavor is savePNGIOSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SavePNG_IO, defined at SDL3/SDL_surface.h 712:34

Since: 3.4.0

savePNGIOSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> Ptr SDL_IOStream	`dst` a data stream to save to.
-> Bool	`closeio` if true, calls `closeIO` on `dst` before returning, even in the case of an error.
-> IO Bool

Save a surface to a seekable SDL data stream in PNG format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadPNGIO, savePNG

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SavePNG_IO. The unsafe flavor is savePNGIO .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SavePNG_IO, defined at SDL3/SDL_surface.h 712:34

Since: 3.4.0

savePNG Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> PtrConst CChar	`file` a file to save to.
-> IO Bool

Save a surface to a file in PNG format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadPNG, savePNGIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SavePNG. The safe flavor is savePNGSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SavePNG, defined at SDL3/SDL_surface.h 730:34

Since: 3.4.0

savePNGSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure containing the image to be saved.
-> PtrConst CChar	`file` a file to save to.
-> IO Bool

Save a surface to a file in PNG format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: loadPNG, savePNGIO

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SavePNG. The unsafe flavor is savePNG .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SavePNG, defined at SDL3/SDL_surface.h 730:34

Since: 3.4.0

setSurfaceRLE Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to optimize.
-> Bool	`enabled` true to enable RLE acceleration, false to disable it.
-> IO Bool

Set the RLE acceleration hint for a surface.

If RLE is enabled, color key and alpha blending blits are much faster, but the surface must be locked before directly accessing the pixels.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: blitSurface, lockSurface, unlockSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfaceRLE. The safe flavor is setSurfaceRLESafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceRLE, defined at SDL3/SDL_surface.h 752:34

Since: 3.2.0

setSurfaceRLESafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to optimize.
-> Bool	`enabled` true to enable RLE acceleration, false to disable it.
-> IO Bool

Set the RLE acceleration hint for a surface.

If RLE is enabled, color key and alpha blending blits are much faster, but the surface must be locked before directly accessing the pixels.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: blitSurface, lockSurface, unlockSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfaceRLE. The unsafe flavor is setSurfaceRLE .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceRLE, defined at SDL3/SDL_surface.h 752:34

Since: 3.2.0

surfaceHasRLE Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO Bool

Returns whether the surface is RLE enabled.

It is safe to pass a NULL surface here; it will return false.

Returns: true if the surface is RLE enabled, false otherwise.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceRLE

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SurfaceHasRLE. The safe flavor is surfaceHasRLESafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SurfaceHasRLE, defined at SDL3/SDL_surface.h 768:34

Since: 3.2.0

surfaceHasRLESafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO Bool

Returns whether the surface is RLE enabled.

It is safe to pass a NULL surface here; it will return false.

Returns: true if the surface is RLE enabled, false otherwise.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceRLE

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SurfaceHasRLE. The unsafe flavor is surfaceHasRLE .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SurfaceHasRLE, defined at SDL3/SDL_surface.h 768:34

Since: 3.2.0

setSurfaceColorKey Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Bool	`enabled` true to enable color key, false to disable color key.
-> Word32	`key` the transparent pixel.
-> IO Bool

Set the color key (transparent pixel) in a surface.

The color key defines a pixel value that will be treated as transparent in a blit. For example, one can use this to specify that cyan pixels should be considered transparent, and therefore not rendered.

It is a pixel of the format used by the surface, as generated by mapRGB.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceColorKey, setSurfaceRLE, surfaceHasColorKey

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfaceColorKey. The safe flavor is setSurfaceColorKeySafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceColorKey, defined at SDL3/SDL_surface.h 795:34

Since: 3.2.0

setSurfaceColorKeySafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Bool	`enabled` true to enable color key, false to disable color key.
-> Word32	`key` the transparent pixel.
-> IO Bool

Set the color key (transparent pixel) in a surface.

The color key defines a pixel value that will be treated as transparent in a blit. For example, one can use this to specify that cyan pixels should be considered transparent, and therefore not rendered.

It is a pixel of the format used by the surface, as generated by mapRGB.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceColorKey, setSurfaceRLE, surfaceHasColorKey

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfaceColorKey. The unsafe flavor is setSurfaceColorKey .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceColorKey, defined at SDL3/SDL_surface.h 795:34

Since: 3.2.0

surfaceHasColorKey Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO Bool

Returns whether the surface has a color key.

It is safe to pass a NULL surface here; it will return false.

Returns: true if the surface has a color key, false otherwise.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceColorKey, getSurfaceColorKey

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SurfaceHasColorKey. The safe flavor is surfaceHasColorKeySafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SurfaceHasColorKey, defined at SDL3/SDL_surface.h 812:34

Since: 3.2.0

surfaceHasColorKeySafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> IO Bool

Returns whether the surface has a color key.

It is safe to pass a NULL surface here; it will return false.

Returns: true if the surface has a color key, false otherwise.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceColorKey, getSurfaceColorKey

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SurfaceHasColorKey. The unsafe flavor is surfaceHasColorKey .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SurfaceHasColorKey, defined at SDL3/SDL_surface.h 812:34

Since: 3.2.0

getSurfaceColorKey Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr Uint32	`key` a pointer filled in with the transparent pixel.
-> IO Bool

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

The color key is a pixel of the format used by the surface, as generated by mapRGB.

If the surface doesn't have color key enabled this function returns false.

Returns: true on success or false on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceColorKey, surfaceHasColorKey

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceColorKey. The safe flavor is getSurfaceColorKeySafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceColorKey, defined at SDL3/SDL_surface.h 834:34

Since: 3.2.0

getSurfaceColorKeySafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr Uint32	`key` a pointer filled in with the transparent pixel.
-> IO Bool

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

The color key is a pixel of the format used by the surface, as generated by mapRGB.

If the surface doesn't have color key enabled this function returns false.

Returns: true on success or false on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceColorKey, surfaceHasColorKey

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceColorKey. The unsafe flavor is getSurfaceColorKey .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceColorKey, defined at SDL3/SDL_surface.h 834:34

Since: 3.2.0

setSurfaceColorMod Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Word8	`r` the red color value multiplied into blit operations.
-> Word8	`g` the green color value multiplied into blit operations.
-> Word8	`b` the blue color value multiplied into blit operations.
-> IO Bool

Set an additional color value multiplied into blit operations.

When this surface is blitted, during the blit operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * (color / 255)

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceColorMod, setSurfaceAlphaMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfaceColorMod. The safe flavor is setSurfaceColorModSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceColorMod, defined at SDL3/SDL_surface.h 860:34

Since: 3.2.0

setSurfaceColorModSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Word8	`r` the red color value multiplied into blit operations.
-> Word8	`g` the green color value multiplied into blit operations.
-> Word8	`b` the blue color value multiplied into blit operations.
-> IO Bool

Set an additional color value multiplied into blit operations.

When this surface is blitted, during the blit operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * (color / 255)

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceColorMod, setSurfaceAlphaMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfaceColorMod. The unsafe flavor is setSurfaceColorMod .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceColorMod, defined at SDL3/SDL_surface.h 860:34

Since: 3.2.0

getSurfaceColorMod Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr Uint8	`r` a pointer filled in with the current red color value.
-> Ptr Uint8	`g` a pointer filled in with the current green color value.
-> Ptr Uint8	`b` a pointer filled in with the current blue color value.
-> IO Bool

Get the additional color value multiplied into blit operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceAlphaMod, setSurfaceColorMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceColorMod. The safe flavor is getSurfaceColorModSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceColorMod, defined at SDL3/SDL_surface.h 881:34

Since: 3.2.0

getSurfaceColorModSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr Uint8	`r` a pointer filled in with the current red color value.
-> Ptr Uint8	`g` a pointer filled in with the current green color value.
-> Ptr Uint8	`b` a pointer filled in with the current blue color value.
-> IO Bool

Get the additional color value multiplied into blit operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceAlphaMod, setSurfaceColorMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceColorMod. The unsafe flavor is getSurfaceColorMod .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceColorMod, defined at SDL3/SDL_surface.h 881:34

Since: 3.2.0

setSurfaceAlphaMod Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Word8	`alpha` the alpha value multiplied into blit operations.
-> IO Bool

Set an additional alpha value used in blit operations.

When this surface is blitted, during the blit operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * (alpha / 255)

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceAlphaMod, setSurfaceColorMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfaceAlphaMod. The safe flavor is setSurfaceAlphaModSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceAlphaMod, defined at SDL3/SDL_surface.h 904:34

Since: 3.2.0

setSurfaceAlphaModSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> Word8	`alpha` the alpha value multiplied into blit operations.
-> IO Bool

Set an additional alpha value used in blit operations.

When this surface is blitted, during the blit operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * (alpha / 255)

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceAlphaMod, setSurfaceColorMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfaceAlphaMod. The unsafe flavor is setSurfaceAlphaMod .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceAlphaMod, defined at SDL3/SDL_surface.h 904:34

Since: 3.2.0

getSurfaceAlphaMod Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr Uint8	`alpha` a pointer filled in with the current alpha value.
-> IO Bool

Get the additional alpha value used in blit operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: getSurfaceColorMod, setSurfaceAlphaMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceAlphaMod. The safe flavor is getSurfaceAlphaModSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceAlphaMod, defined at SDL3/SDL_surface.h 921:34

Since: 3.2.0

getSurfaceAlphaModSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr Uint8	`alpha` a pointer filled in with the current alpha value.
-> IO Bool

Get the additional alpha value used in blit operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: getSurfaceColorMod, setSurfaceAlphaMod

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceAlphaMod. The unsafe flavor is getSurfaceAlphaMod .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceAlphaMod, defined at SDL3/SDL_surface.h 921:34

Since: 3.2.0

setSurfaceBlendMode Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> SDL_BlendMode	`blendMode` the SDL_BlendMode to use for blit blending.
-> IO Bool

Set the blend mode used for blit operations.

To copy a surface to another surface (or texture) without blending with the existing data, the blendmode of the SOURCE surface should be set to SDL_BLENDMODE_NONE.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceBlendMode

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfaceBlendMode. The safe flavor is setSurfaceBlendModeSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceBlendMode, defined at SDL3/SDL_surface.h 942:34

Since: 3.2.0

setSurfaceBlendModeSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to update.
-> SDL_BlendMode	`blendMode` the SDL_BlendMode to use for blit blending.
-> IO Bool

Set the blend mode used for blit operations.

To copy a surface to another surface (or texture) without blending with the existing data, the blendmode of the SOURCE surface should be set to SDL_BLENDMODE_NONE.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceBlendMode

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfaceBlendMode. The unsafe flavor is setSurfaceBlendMode .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceBlendMode, defined at SDL3/SDL_surface.h 942:34

Since: 3.2.0

getSurfaceBlendMode Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr SDL_BlendMode	`blendMode` a pointer filled in with the current SDL_BlendMode.
-> IO Bool

Get the blend mode used for blit operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceBlendMode

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceBlendMode. The safe flavor is getSurfaceBlendModeSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceBlendMode, defined at SDL3/SDL_surface.h 958:34

Since: 3.2.0

getSurfaceBlendModeSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to query.
-> Ptr SDL_BlendMode	`blendMode` a pointer filled in with the current SDL_BlendMode.
-> IO Bool

Get the blend mode used for blit operations.

Returns: true on success or false on failure; call getError for more information.
Thread safety: It is safe to call this function from any thread.
See also: setSurfaceBlendMode

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceBlendMode. The unsafe flavor is getSurfaceBlendMode .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceBlendMode, defined at SDL3/SDL_surface.h 958:34

Since: 3.2.0

setSurfaceClipRect Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to be clipped.
-> PtrConst SDL_Rect	`rect` the SDL_Rect structure representing the clipping rectangle, or NULL to disable clipping.
-> IO Bool

Set the clipping rectangle for a surface.

When surface is the destination of a blit, only the area within the clip rectangle is drawn into.

Note that blits are automatically clipped to the edges of the source and destination surfaces.

Returns: true if the rectangle intersects the surface, otherwise false and blits will be completely clipped.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceClipRect

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_SetSurfaceClipRect. The safe flavor is setSurfaceClipRectSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceClipRect, defined at SDL3/SDL_surface.h 982:34

Since: 3.2.0

setSurfaceClipRectSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure to be clipped.
-> PtrConst SDL_Rect	`rect` the SDL_Rect structure representing the clipping rectangle, or NULL to disable clipping.
-> IO Bool

Set the clipping rectangle for a surface.

When surface is the destination of a blit, only the area within the clip rectangle is drawn into.

Note that blits are automatically clipped to the edges of the source and destination surfaces.

Returns: true if the rectangle intersects the surface, otherwise false and blits will be completely clipped.
Thread safety: This function can be called on different threads with different surfaces.
See also: getSurfaceClipRect

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_SetSurfaceClipRect. The unsafe flavor is setSurfaceClipRect .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_SetSurfaceClipRect, defined at SDL3/SDL_surface.h 982:34

Since: 3.2.0

getSurfaceClipRect Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure representing the surface to be clipped.
-> Ptr SDL_Rect	`rect` an SDL_Rect structure filled in with the clipping rectangle for the surface.
-> IO Bool

Get the clipping rectangle for a surface.

When surface is the destination of a blit, only the area within the clip rectangle is drawn into.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: setSurfaceClipRect

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_GetSurfaceClipRect. The safe flavor is getSurfaceClipRectSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceClipRect, defined at SDL3/SDL_surface.h 1004:34

Since: 3.2.0

getSurfaceClipRectSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` structure representing the surface to be clipped.
-> Ptr SDL_Rect	`rect` an SDL_Rect structure filled in with the clipping rectangle for the surface.
-> IO Bool

Get the clipping rectangle for a surface.

When surface is the destination of a blit, only the area within the clip rectangle is drawn into.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: setSurfaceClipRect

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_GetSurfaceClipRect. The unsafe flavor is getSurfaceClipRect .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_GetSurfaceClipRect, defined at SDL3/SDL_surface.h 1004:34

Since: 3.2.0

flipSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to flip.
-> SDL_FlipMode	`flip` the direction to flip.
-> IO Bool

Flip a surface vertically or horizontally.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_FlipSurface. The safe flavor is flipSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_FlipSurface, defined at SDL3/SDL_surface.h 1019:34

Since: 3.2.0

flipSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to flip.
-> SDL_FlipMode	`flip` the direction to flip.
-> IO Bool

Flip a surface vertically or horizontally.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_FlipSurface. The unsafe flavor is flipSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_FlipSurface, defined at SDL3/SDL_surface.h 1019:34

Since: 3.2.0

rotateSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to rotate.
-> Float	`angle` the rotation angle, in degrees.
-> IO (Ptr SDL_Surface)

Return a copy of a surface rotated clockwise a number of degrees.

The angle of rotation can be negative for counter-clockwise rotation.

When the rotation isn't a multiple of 90 degrees, the resulting surface is larger than the original, with the background filled in with the colorkey, if available, or RGBA 255/255/255/0 if not.

If surface has the SDL_PROP_SURFACE_ROTATION_FLOAT property set on it, the new copy will have the adjusted value set: if the rotation property is 90 and angle was 30, the new surface will have a property value of 60 (that is: to be upright vs gravity, this surface needs to rotate 60 more degrees). However, note that further rotations on the new surface in this example will produce unexpected results, since the image will have resized and padded to accommodate the not-90 degree angle.

Returns: a rotated copy of the surface or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_RotateSurface. The safe flavor is rotateSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_RotateSurface, defined at SDL3/SDL_surface.h 1048:43

Since: 3.4.0

rotateSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to rotate.
-> Float	`angle` the rotation angle, in degrees.
-> IO (Ptr SDL_Surface)

Return a copy of a surface rotated clockwise a number of degrees.

The angle of rotation can be negative for counter-clockwise rotation.

When the rotation isn't a multiple of 90 degrees, the resulting surface is larger than the original, with the background filled in with the colorkey, if available, or RGBA 255/255/255/0 if not.

If surface has the SDL_PROP_SURFACE_ROTATION_FLOAT property set on it, the new copy will have the adjusted value set: if the rotation property is 90 and angle was 30, the new surface will have a property value of 60 (that is: to be upright vs gravity, this surface needs to rotate 60 more degrees). However, note that further rotations on the new surface in this example will produce unexpected results, since the image will have resized and padded to accommodate the not-90 degree angle.

Returns: a rotated copy of the surface or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_RotateSurface. The unsafe flavor is rotateSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_RotateSurface, defined at SDL3/SDL_surface.h 1048:43

Since: 3.4.0

duplicateSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to duplicate.
-> IO (Ptr SDL_Surface)

Creates a new surface identical to the existing surface.

If the original surface has alternate images, the new surface will have a reference to them as well.

The returned surface should be freed with destroySurface.

Returns: a copy of the surface or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_DuplicateSurface. The safe flavor is duplicateSurfaceSafe .
C declaration: SDL_DuplicateSurface, defined at SDL3/SDL_surface.h 1069:43

Since: 3.2.0

duplicateSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to duplicate.
-> IO (Ptr SDL_Surface)

Creates a new surface identical to the existing surface.

If the original surface has alternate images, the new surface will have a reference to them as well.

The returned surface should be freed with destroySurface.

Returns: a copy of the surface or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_DuplicateSurface. The unsafe flavor is duplicateSurface .
C declaration: SDL_DuplicateSurface, defined at SDL3/SDL_surface.h 1069:43

Since: 3.2.0

scaleSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to duplicate and scale.
-> Int32	`width` the width of the new surface.
-> Int32	`height` the height of the new surface.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO (Ptr SDL_Surface)

Creates a new surface identical to the existing surface, scaled to the desired size.

The returned surface should be freed with destroySurface.

Returns: a copy of the surface or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ScaleSurface. The safe flavor is scaleSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ScaleSurface, defined at SDL3/SDL_surface.h 1091:43

Since: 3.2.0

scaleSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to duplicate and scale.
-> Int32	`width` the width of the new surface.
-> Int32	`height` the height of the new surface.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO (Ptr SDL_Surface)

Creates a new surface identical to the existing surface, scaled to the desired size.

The returned surface should be freed with destroySurface.

Returns: a copy of the surface or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ScaleSurface. The unsafe flavor is scaleSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ScaleSurface, defined at SDL3/SDL_surface.h 1091:43

Since: 3.2.0

convertSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the existing `SDL_Surface` structure to convert.
-> SDL_PixelFormat	`format` the new pixel format.
-> IO (Ptr SDL_Surface)

Copy an existing surface to a new surface of the specified 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.

If you are converting to an indexed surface and want to map colors to a palette, you can use convertSurfaceAndColorspace instead.

If the original surface has alternate images, the new surface will have a reference to them as well.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: convertSurfaceAndColorspace, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ConvertSurface. The safe flavor is convertSurfaceSafe .
C declaration: SDL_ConvertSurface, defined at SDL3/SDL_surface.h 1120:43

Since: 3.2.0

convertSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the existing `SDL_Surface` structure to convert.
-> SDL_PixelFormat	`format` the new pixel format.
-> IO (Ptr SDL_Surface)

Copy an existing surface to a new surface of the specified 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.

If you are converting to an indexed surface and want to map colors to a palette, you can use convertSurfaceAndColorspace instead.

If the original surface has alternate images, the new surface will have a reference to them as well.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: convertSurfaceAndColorspace, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ConvertSurface. The unsafe flavor is convertSurface .
C declaration: SDL_ConvertSurface, defined at SDL3/SDL_surface.h 1120:43

Since: 3.2.0

convertSurfaceAndColorspace Source #

Arguments

:: Ptr SDL_Surface	`surface` the existing `SDL_Surface` structure to convert.
-> SDL_PixelFormat	`format` the new pixel format.
-> Ptr SDL_Palette	`palette` an optional palette to use for indexed formats, may be NULL.
-> SDL_Colorspace	`colorspace` the new colorspace.
-> SDL_PropertiesID	`props` an SDL_PropertiesID with additional color properties, or 0.
-> IO (Ptr SDL_Surface)

Copy an existing surface to a new surface of the specified format and colorspace.

This function converts an existing surface to a new format and colorspace and returns the new surface. This will perform any pixel format and colorspace conversion needed.

If the original surface has alternate images, the new surface will have a reference to them as well.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: convertSurface, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ConvertSurfaceAndColorspace. The safe flavor is convertSurfaceAndColorspaceSafe .
C declaration: SDL_ConvertSurfaceAndColorspace, defined at SDL3/SDL_surface.h 1149:43

Since: 3.2.0

convertSurfaceAndColorspaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the existing `SDL_Surface` structure to convert.
-> SDL_PixelFormat	`format` the new pixel format.
-> Ptr SDL_Palette	`palette` an optional palette to use for indexed formats, may be NULL.
-> SDL_Colorspace	`colorspace` the new colorspace.
-> SDL_PropertiesID	`props` an SDL_PropertiesID with additional color properties, or 0.
-> IO (Ptr SDL_Surface)

Copy an existing surface to a new surface of the specified format and colorspace.

This function converts an existing surface to a new format and colorspace and returns the new surface. This will perform any pixel format and colorspace conversion needed.

If the original surface has alternate images, the new surface will have a reference to them as well.

Returns: the new SDL_Surface structure that is created or NULL on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: convertSurface, destroySurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ConvertSurfaceAndColorspace. The unsafe flavor is convertSurfaceAndColorspace .
C declaration: SDL_ConvertSurfaceAndColorspace, defined at SDL3/SDL_surface.h 1149:43

Since: 3.2.0

convertPixels Source #

Arguments

:: Int32	`width` the width of the block to copy, in pixels.
-> Int32	`height` the height of the block to copy, in pixels.
-> SDL_PixelFormat	`src_format` an SDL_PixelFormat value of the `src` pixels format.
-> PtrConst Void	`src` a pointer to the source pixels.
-> Int32	`src_pitch` the pitch of the source pixels, in bytes.
-> SDL_PixelFormat	`dst_format` an SDL_PixelFormat value of the `dst` pixels format.
-> Ptr Void	`dst` a pointer to be filled in with new pixel data.
-> Int32	`dst_pitch` the pitch of the destination pixels, in bytes.
-> IO Bool

Copy a block of pixels of one format to another format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: The same destination pixels should not be used from two threads at once. It is safe to use the same source pixels from multiple threads.
See also: convertPixelsAndColorspace

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ConvertPixels. The safe flavor is convertPixelsSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ConvertPixels, defined at SDL3/SDL_surface.h 1173:34

Since: 3.2.0

convertPixelsSafe Source #

Arguments

:: Int32	`width` the width of the block to copy, in pixels.
-> Int32	`height` the height of the block to copy, in pixels.
-> SDL_PixelFormat	`src_format` an SDL_PixelFormat value of the `src` pixels format.
-> PtrConst Void	`src` a pointer to the source pixels.
-> Int32	`src_pitch` the pitch of the source pixels, in bytes.
-> SDL_PixelFormat	`dst_format` an SDL_PixelFormat value of the `dst` pixels format.
-> Ptr Void	`dst` a pointer to be filled in with new pixel data.
-> Int32	`dst_pitch` the pitch of the destination pixels, in bytes.
-> IO Bool

Copy a block of pixels of one format to another format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: The same destination pixels should not be used from two threads at once. It is safe to use the same source pixels from multiple threads.
See also: convertPixelsAndColorspace

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ConvertPixels. The unsafe flavor is convertPixels .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ConvertPixels, defined at SDL3/SDL_surface.h 1173:34

Since: 3.2.0

convertPixelsAndColorspace Source #

Arguments

:: Int32	`width` the width of the block to copy, in pixels.
-> Int32	`height` the height of the block to copy, in pixels.
-> SDL_PixelFormat	`src_format` an SDL_PixelFormat value of the `src` pixels format.
-> SDL_Colorspace	`src_colorspace` an SDL_Colorspace value describing the colorspace of the `src` pixels.
-> SDL_PropertiesID	`src_properties` an SDL_PropertiesID with additional source color properties, or 0.
-> PtrConst Void	`src` a pointer to the source pixels.
-> Int32	`src_pitch` the pitch of the source pixels, in bytes.
-> SDL_PixelFormat	`dst_format` an SDL_PixelFormat value of the `dst` pixels format.
-> SDL_Colorspace	`dst_colorspace` an SDL_Colorspace value describing the colorspace of the `dst` pixels.
-> SDL_PropertiesID	`dst_properties` an SDL_PropertiesID with additional destination color properties, or 0.
-> Ptr Void	`dst` a pointer to be filled in with new pixel data.
-> Int32	`dst_pitch` the pitch of the destination pixels, in bytes.
-> IO Bool

Copy a block of pixels of one format and colorspace to another format and colorspace.

Returns: true on success or false on failure; call getError for more information.
Thread safety: The same destination pixels should not be used from two threads at once. It is safe to use the same source pixels from multiple threads.
See also: convertPixels

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ConvertPixelsAndColorspace. The safe flavor is convertPixelsAndColorspaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ConvertPixelsAndColorspace, defined at SDL3/SDL_surface.h 1206:34

Since: 3.2.0

convertPixelsAndColorspaceSafe Source #

Arguments

:: Int32	`width` the width of the block to copy, in pixels.
-> Int32	`height` the height of the block to copy, in pixels.
-> SDL_PixelFormat	`src_format` an SDL_PixelFormat value of the `src` pixels format.
-> SDL_Colorspace	`src_colorspace` an SDL_Colorspace value describing the colorspace of the `src` pixels.
-> SDL_PropertiesID	`src_properties` an SDL_PropertiesID with additional source color properties, or 0.
-> PtrConst Void	`src` a pointer to the source pixels.
-> Int32	`src_pitch` the pitch of the source pixels, in bytes.
-> SDL_PixelFormat	`dst_format` an SDL_PixelFormat value of the `dst` pixels format.
-> SDL_Colorspace	`dst_colorspace` an SDL_Colorspace value describing the colorspace of the `dst` pixels.
-> SDL_PropertiesID	`dst_properties` an SDL_PropertiesID with additional destination color properties, or 0.
-> Ptr Void	`dst` a pointer to be filled in with new pixel data.
-> Int32	`dst_pitch` the pitch of the destination pixels, in bytes.
-> IO Bool

Copy a block of pixels of one format and colorspace to another format and colorspace.

Returns: true on success or false on failure; call getError for more information.
Thread safety: The same destination pixels should not be used from two threads at once. It is safe to use the same source pixels from multiple threads.
See also: convertPixels

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ConvertPixelsAndColorspace. The unsafe flavor is convertPixelsAndColorspace .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ConvertPixelsAndColorspace, defined at SDL3/SDL_surface.h 1206:34

Since: 3.2.0

premultiplyAlpha Source #

Arguments

:: Int32	`width` the width of the block to convert, in pixels.
-> Int32	`height` the height of the block to convert, in pixels.
-> SDL_PixelFormat	`src_format` an SDL_PixelFormat value of the `src` pixels format.
-> PtrConst Void	`src` a pointer to the source pixels.
-> Int32	`src_pitch` the pitch of the source pixels, in bytes.
-> SDL_PixelFormat	`dst_format` an SDL_PixelFormat value of the `dst` pixels format.
-> Ptr Void	`dst` a pointer to be filled in with premultiplied pixel data.
-> Int32	`dst_pitch` the pitch of the destination pixels, in bytes.
-> Bool	`linear` true to convert from sRGB to linear space for the alpha multiplication, false to do multiplication in sRGB space.
-> IO Bool

Premultiply the alpha on a block of pixels.

This is safe to use with src == dst, but not for other overlapping areas.

Returns: true on success or false on failure; call getError for more information.
Thread safety: The same destination pixels should not be used from two threads at once. It is safe to use the same source pixels from multiple threads.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_PremultiplyAlpha. The safe flavor is premultiplyAlphaSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_PremultiplyAlpha, defined at SDL3/SDL_surface.h 1232:34

Since: 3.2.0

premultiplyAlphaSafe Source #

Arguments

:: Int32	`width` the width of the block to convert, in pixels.
-> Int32	`height` the height of the block to convert, in pixels.
-> SDL_PixelFormat	`src_format` an SDL_PixelFormat value of the `src` pixels format.
-> PtrConst Void	`src` a pointer to the source pixels.
-> Int32	`src_pitch` the pitch of the source pixels, in bytes.
-> SDL_PixelFormat	`dst_format` an SDL_PixelFormat value of the `dst` pixels format.
-> Ptr Void	`dst` a pointer to be filled in with premultiplied pixel data.
-> Int32	`dst_pitch` the pitch of the destination pixels, in bytes.
-> Bool	`linear` true to convert from sRGB to linear space for the alpha multiplication, false to do multiplication in sRGB space.
-> IO Bool

Premultiply the alpha on a block of pixels.

This is safe to use with src == dst, but not for other overlapping areas.

Returns: true on success or false on failure; call getError for more information.
Thread safety: The same destination pixels should not be used from two threads at once. It is safe to use the same source pixels from multiple threads.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_PremultiplyAlpha. The unsafe flavor is premultiplyAlpha .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_PremultiplyAlpha, defined at SDL3/SDL_surface.h 1232:34

Since: 3.2.0

premultiplySurfaceAlpha Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to modify.
-> Bool	`linear` true to convert from sRGB to linear space for the alpha multiplication, false to do multiplication in sRGB space.
-> IO Bool

Premultiply the alpha in a surface.

This is safe to use with src == dst, but not for other overlapping areas.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_PremultiplySurfaceAlpha. The safe flavor is premultiplySurfaceAlphaSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_PremultiplySurfaceAlpha, defined at SDL3/SDL_surface.h 1250:34

Since: 3.2.0

premultiplySurfaceAlphaSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to modify.
-> Bool	`linear` true to convert from sRGB to linear space for the alpha multiplication, false to do multiplication in sRGB space.
-> IO Bool

Premultiply the alpha in a surface.

This is safe to use with src == dst, but not for other overlapping areas.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_PremultiplySurfaceAlpha. The unsafe flavor is premultiplySurfaceAlpha .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_PremultiplySurfaceAlpha, defined at SDL3/SDL_surface.h 1250:34

Since: 3.2.0

clearSurface Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` to clear.
-> Float	`r` the red component of the pixel, normally in the range 0-1.
-> Float	`g` the green component of the pixel, normally in the range 0-1.
-> Float	`b` the blue component of the pixel, normally in the range 0-1.
-> Float	`a` the alpha component of the pixel, normally in the range 0-1.
-> IO Bool

Clear a surface with a specific color, with floating point precision.

This function handles all surface formats, and ignores any clip rectangle.

If the surface is YUV, the color is assumed to be in the sRGB colorspace, otherwise the color is assumed to be in the colorspace of the surface.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ClearSurface. The safe flavor is clearSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ClearSurface, defined at SDL3/SDL_surface.h 1273:34

Since: 3.2.0

clearSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the `SDL_Surface` to clear.
-> Float	`r` the red component of the pixel, normally in the range 0-1.
-> Float	`g` the green component of the pixel, normally in the range 0-1.
-> Float	`b` the blue component of the pixel, normally in the range 0-1.
-> Float	`a` the alpha component of the pixel, normally in the range 0-1.
-> IO Bool

Clear a surface with a specific color, with floating point precision.

This function handles all surface formats, and ignores any clip rectangle.

If the surface is YUV, the color is assumed to be in the sRGB colorspace, otherwise the color is assumed to be in the colorspace of the surface.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ClearSurface. The unsafe flavor is clearSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ClearSurface, defined at SDL3/SDL_surface.h 1273:34

Since: 3.2.0

fillSurfaceRect Source #

Arguments

:: Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the drawing target.
-> PtrConst SDL_Rect	`rect` the SDL_Rect structure representing the rectangle to fill, or NULL to fill the entire surface.
-> Word32	`color` the color to fill with.
-> IO Bool

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

color should be a pixel of the format used by the surface, and can be generated by mapRGB or mapRGBA. If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place.

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

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: fillSurfaceRects

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_FillSurfaceRect. The safe flavor is fillSurfaceRectSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_FillSurfaceRect, defined at SDL3/SDL_surface.h 1301:34

Since: 3.2.0

fillSurfaceRectSafe Source #

Arguments

:: Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the drawing target.
-> PtrConst SDL_Rect	`rect` the SDL_Rect structure representing the rectangle to fill, or NULL to fill the entire surface.
-> Word32	`color` the color to fill with.
-> IO Bool

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

color should be a pixel of the format used by the surface, and can be generated by mapRGB or mapRGBA. If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place.

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

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: fillSurfaceRects

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_FillSurfaceRect. The unsafe flavor is fillSurfaceRect .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_FillSurfaceRect, defined at SDL3/SDL_surface.h 1301:34

Since: 3.2.0

fillSurfaceRects Source #

Arguments

:: Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the drawing target.
-> PtrConst SDL_Rect	`rects` an array of SDL_Rects representing the rectangles to fill.
-> Int32	`count` the number of rectangles in the array.
-> Word32	`color` the color to fill with.
-> IO Bool

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

color should be a pixel of the format used by the surface, and can be generated by mapRGB or mapRGBA. If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place.

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

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: fillSurfaceRect

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_FillSurfaceRects. The safe flavor is fillSurfaceRectsSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_FillSurfaceRects, defined at SDL3/SDL_surface.h 1329:34

Since: 3.2.0

fillSurfaceRectsSafe Source #

Arguments

:: Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the drawing target.
-> PtrConst SDL_Rect	`rects` an array of SDL_Rects representing the rectangles to fill.
-> Int32	`count` the number of rectangles in the array.
-> Word32	`color` the color to fill with.
-> IO Bool

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

color should be a pixel of the format used by the surface, and can be generated by mapRGB or mapRGBA. If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place.

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

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.
See also: fillSurfaceRect

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_FillSurfaceRects. The unsafe flavor is fillSurfaceRects .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_FillSurfaceRects, defined at SDL3/SDL_surface.h 1329:34

Since: 3.2.0

blitSurface Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the x and y position in the destination surface, or NULL for (0,0). The width and height are ignored, and are copied from `srcrect`. If you want a specific width and height, you should use `blitSurfaceScaled`.
-> IO Bool

Performs a fast blit from the source surface to the destination surface with clipping.

If either srcrect or dstrect are NULL, the entire surface (src or dst) is copied while ensuring clipping to dst->clip_rect.

The blit function should not be called on a locked surface.

The blit semantics for surfaces with and without blending and colorkey are defined as follows:

     RGBA->RGB:
       Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source alpha-channel and per-surface alpha)
        SDL_SRCCOLORKEY ignored.
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy RGB.
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        RGB values of the source color key, ignoring alpha in the
        comparison.

    RGB->RGBA:
      Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source per-surface alpha)
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy RGB, set destination alpha to source per-surface alpha value.
      both:
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        source color key.

    RGBA->RGBA:
      Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source alpha-channel and per-surface alpha)
        SDL_SRCCOLORKEY ignored.
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy all of RGBA to the destination.
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        RGB values of the source color key, ignoring alpha in the
        comparison.

    RGB->RGB:
      Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source per-surface alpha)
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy RGB.
      both:
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        source color key.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurfaceScaled

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_BlitSurface. The safe flavor is blitSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurface, defined at SDL3/SDL_surface.h 1402:34

Since: 3.2.0

blitSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the x and y position in the destination surface, or NULL for (0,0). The width and height are ignored, and are copied from `srcrect`. If you want a specific width and height, you should use `blitSurfaceScaled`.
-> IO Bool

Performs a fast blit from the source surface to the destination surface with clipping.

If either srcrect or dstrect are NULL, the entire surface (src or dst) is copied while ensuring clipping to dst->clip_rect.

The blit function should not be called on a locked surface.

The blit semantics for surfaces with and without blending and colorkey are defined as follows:

     RGBA->RGB:
       Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source alpha-channel and per-surface alpha)
        SDL_SRCCOLORKEY ignored.
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy RGB.
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        RGB values of the source color key, ignoring alpha in the
        comparison.

    RGB->RGBA:
      Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source per-surface alpha)
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy RGB, set destination alpha to source per-surface alpha value.
      both:
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        source color key.

    RGBA->RGBA:
      Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source alpha-channel and per-surface alpha)
        SDL_SRCCOLORKEY ignored.
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy all of RGBA to the destination.
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        RGB values of the source color key, ignoring alpha in the
        comparison.

    RGB->RGB:
      Source surface blend mode set to SDL_BLENDMODE_BLEND:
        alpha-blend (using the source per-surface alpha)
      Source surface blend mode set to SDL_BLENDMODE_NONE:
        copy RGB.
      both:
        if SDL_SRCCOLORKEY set, only copy the pixels that do not match the
        source color key.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurfaceScaled

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_BlitSurface. The unsafe flavor is blitSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurface, defined at SDL3/SDL_surface.h 1402:34

Since: 3.2.0

blitSurfaceUnchecked Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, may not be NULL.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, may not be NULL.
-> IO Bool

Perform low-level surface blitting only.

This is a semi-private blit function and it performs low-level surface blitting, assuming the input rectangles have already been clipped.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_BlitSurfaceUnchecked. The safe flavor is blitSurfaceUncheckedSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceUnchecked, defined at SDL3/SDL_surface.h 1426:34

Since: 3.2.0

blitSurfaceUncheckedSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, may not be NULL.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, may not be NULL.
-> IO Bool

Perform low-level surface blitting only.

This is a semi-private blit function and it performs low-level surface blitting, assuming the input rectangles have already been clipped.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_BlitSurfaceUnchecked. The unsafe flavor is blitSurfaceUnchecked .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceUnchecked, defined at SDL3/SDL_surface.h 1426:34

Since: 3.2.0

blitSurfaceScaled Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire destination surface.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO Bool

Perform a scaled blit to a destination surface, which may be of a different format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_BlitSurfaceScaled. The safe flavor is blitSurfaceScaledSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceScaled, defined at SDL3/SDL_surface.h 1450:34

Since: 3.2.0

blitSurfaceScaledSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire destination surface.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO Bool

Perform a scaled blit to a destination surface, which may be of a different format.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_BlitSurfaceScaled. The unsafe flavor is blitSurfaceScaled .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceScaled, defined at SDL3/SDL_surface.h 1450:34

Since: 3.2.0

blitSurfaceUncheckedScaled Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, may not be NULL.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, may not be NULL.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO Bool

Perform low-level surface scaled blitting only.

This is a semi-private function and it performs low-level surface blitting, assuming the input rectangles have already been clipped.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurfaceScaled

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_BlitSurfaceUncheckedScaled. The safe flavor is blitSurfaceUncheckedScaledSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceUncheckedScaled, defined at SDL3/SDL_surface.h 1475:34

Since: 3.2.0

blitSurfaceUncheckedScaledSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, may not be NULL.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, may not be NULL.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO Bool

Perform low-level surface scaled blitting only.

This is a semi-private function and it performs low-level surface blitting, assuming the input rectangles have already been clipped.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurfaceScaled

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_BlitSurfaceUncheckedScaled. The unsafe flavor is blitSurfaceUncheckedScaled .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceUncheckedScaled, defined at SDL3/SDL_surface.h 1475:34

Since: 3.2.0

stretchSurface Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire destination surface.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO Bool

Perform a stretched pixel copy from one surface to another.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurfaceScaled

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_StretchSurface. The safe flavor is stretchSurfaceSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_StretchSurface, defined at SDL3/SDL_surface.h 1498:34

Since: 3.4.0

stretchSurfaceSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire destination surface.
-> SDL_ScaleMode	`scaleMode` the `SDL_ScaleMode` to be used.
-> IO Bool

Perform a stretched pixel copy from one surface to another.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurfaceScaled

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_StretchSurface. The unsafe flavor is stretchSurface .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_StretchSurface, defined at SDL3/SDL_surface.h 1498:34

Since: 3.4.0

blitSurfaceTiled Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire surface.
-> IO Bool

Perform a tiled blit to a destination surface, which may be of a different format.

The pixels in srcrect will be repeated as many times as needed to completely fill dstrect.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_BlitSurfaceTiled. The safe flavor is blitSurfaceTiledSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceTiled, defined at SDL3/SDL_surface.h 1523:34

Since: 3.2.0

blitSurfaceTiledSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire surface.
-> IO Bool

Perform a tiled blit to a destination surface, which may be of a different format.

The pixels in srcrect will be repeated as many times as needed to completely fill dstrect.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_BlitSurfaceTiled. The unsafe flavor is blitSurfaceTiled .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceTiled, defined at SDL3/SDL_surface.h 1523:34

Since: 3.2.0

blitSurfaceTiledWithScale Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Float	`scale` the scale used to transform srcrect into the destination rectangle, e.g. a 32x32 texture with a scale of 2 would fill 64x64 tiles.
-> SDL_ScaleMode	`scaleMode` scale algorithm to be used.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire surface.
-> IO Bool

Perform a scaled and tiled blit to a destination surface, which may be of a different format.

The pixels in srcrect will be scaled and repeated as many times as needed to completely fill dstrect.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_BlitSurfaceTiledWithScale. The safe flavor is blitSurfaceTiledWithScaleSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceTiledWithScale, defined at SDL3/SDL_surface.h 1552:34

Since: 3.2.0

blitSurfaceTiledWithScaleSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface.
-> Float	`scale` the scale used to transform srcrect into the destination rectangle, e.g. a 32x32 texture with a scale of 2 would fill 64x64 tiles.
-> SDL_ScaleMode	`scaleMode` scale algorithm to be used.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire surface.
-> IO Bool

Perform a scaled and tiled blit to a destination surface, which may be of a different format.

The pixels in srcrect will be scaled and repeated as many times as needed to completely fill dstrect.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_BlitSurfaceTiledWithScale. The unsafe flavor is blitSurfaceTiledWithScale .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurfaceTiledWithScale, defined at SDL3/SDL_surface.h 1552:34

Since: 3.2.0

blitSurface9Grid Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be used for the 9-grid, or NULL to use the entire surface.
-> Int32	`left_width` the width, in pixels, of the left corners in `srcrect`.
-> Int32	`right_width` the width, in pixels, of the right corners in `srcrect`.
-> Int32	`top_height` the height, in pixels, of the top corners in `srcrect`.
-> Int32	`bottom_height` the height, in pixels, of the bottom corners in `srcrect`.
-> Float	`scale` the scale used to transform the corner of `srcrect` into the corner of `dstrect`, or 0.0f for an unscaled blit.
-> SDL_ScaleMode	`scaleMode` scale algorithm to be used.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire surface.
-> IO Bool

Perform a scaled blit using the 9-grid algorithm to a destination surface, which may be of a different format.

The pixels in the source surface are split into a 3x3 grid, using the different corner sizes for each corner, and the sides and center making up the remaining pixels. The corners are then scaled using scale and fit into the corners of the destination rectangle. The sides and center are then stretched into place to cover the remaining destination rectangle.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_BlitSurface9Grid. The safe flavor is blitSurface9GridSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurface9Grid, defined at SDL3/SDL_surface.h 1588:34

Since: 3.2.0

blitSurface9GridSafe Source #

Arguments

:: Ptr SDL_Surface	`src` the `SDL_Surface` structure to be copied from.
-> PtrConst SDL_Rect	`srcrect` the SDL_Rect structure representing the rectangle to be used for the 9-grid, or NULL to use the entire surface.
-> Int32	`left_width` the width, in pixels, of the left corners in `srcrect`.
-> Int32	`right_width` the width, in pixels, of the right corners in `srcrect`.
-> Int32	`top_height` the height, in pixels, of the top corners in `srcrect`.
-> Int32	`bottom_height` the height, in pixels, of the bottom corners in `srcrect`.
-> Float	`scale` the scale used to transform the corner of `srcrect` into the corner of `dstrect`, or 0.0f for an unscaled blit.
-> SDL_ScaleMode	`scaleMode` scale algorithm to be used.
-> Ptr SDL_Surface	`dst` the `SDL_Surface` structure that is the blit target.
-> PtrConst SDL_Rect	`dstrect` the SDL_Rect structure representing the target rectangle in the destination surface, or NULL to fill the entire surface.
-> IO Bool

Perform a scaled blit using the 9-grid algorithm to a destination surface, which may be of a different format.

The pixels in the source surface are split into a 3x3 grid, using the different corner sizes for each corner, and the sides and center making up the remaining pixels. The corners are then scaled using scale and fit into the corners of the destination rectangle. The sides and center are then stretched into place to cover the remaining destination rectangle.

Returns: true on success or false on failure; call getError for more information.
Thread safety: Only one thread should be using the src and dst surfaces at any given time.
See also: blitSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_BlitSurface9Grid. The unsafe flavor is blitSurface9Grid .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_BlitSurface9Grid, defined at SDL3/SDL_surface.h 1588:34

Since: 3.2.0

mapSurfaceRGB Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to use for the pixel format and palette.
-> Word8	`r` the red component of the pixel in the range 0-255.
-> Word8	`g` the green component of the pixel in the range 0-255.
-> Word8	`b` the blue component of the pixel in the range 0-255.
-> IO Word32

Map an RGB triple to an opaque pixel value for a surface.

This function maps the RGB color value to the specified pixel format and returns the pixel value best approximating the given RGB color value for the given pixel format.

If the surface has a palette, the index of the closest matching color in the palette will be returned.

If the surface pixel format has an alpha component it will be returned as all 1 bits (fully opaque).

If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).

Returns: a pixel value.
Thread safety: This function can be called on different threads with different surfaces.
See also: mapSurfaceRGBA

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_MapSurfaceRGB. The safe flavor is mapSurfaceRGBSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_MapSurfaceRGB, defined at SDL3/SDL_surface.h 1621:36

Since: 3.2.0

mapSurfaceRGBSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to use for the pixel format and palette.
-> Word8	`r` the red component of the pixel in the range 0-255.
-> Word8	`g` the green component of the pixel in the range 0-255.
-> Word8	`b` the blue component of the pixel in the range 0-255.
-> IO Word32

Map an RGB triple to an opaque pixel value for a surface.

This function maps the RGB color value to the specified pixel format and returns the pixel value best approximating the given RGB color value for the given pixel format.

If the surface has a palette, the index of the closest matching color in the palette will be returned.

If the surface pixel format has an alpha component it will be returned as all 1 bits (fully opaque).

If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).

Returns: a pixel value.
Thread safety: This function can be called on different threads with different surfaces.
See also: mapSurfaceRGBA

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_MapSurfaceRGB. The unsafe flavor is mapSurfaceRGB .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_MapSurfaceRGB, defined at SDL3/SDL_surface.h 1621:36

Since: 3.2.0

mapSurfaceRGBA Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to use for the pixel format and palette.
-> Word8	`r` the red component of the pixel in the range 0-255.
-> Word8	`g` the green component of the pixel in the range 0-255.
-> Word8	`b` the blue component of the pixel in the range 0-255.
-> Word8	`a` the alpha component of the pixel in the range 0-255.
-> IO Word32

Map an RGBA quadruple to a pixel value for a surface.

This function maps the RGBA color value to the specified pixel format and returns the pixel value best approximating the given RGBA color value for the given pixel format.

If the surface pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette).

If the surface has a palette, the index of the closest matching color in the palette will be returned.

If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).

Returns: a pixel value.
Thread safety: This function can be called on different threads with different surfaces.
See also: mapSurfaceRGB

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_MapSurfaceRGBA. The safe flavor is mapSurfaceRGBASafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_MapSurfaceRGBA, defined at SDL3/SDL_surface.h 1655:36

Since: 3.2.0

mapSurfaceRGBASafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to use for the pixel format and palette.
-> Word8	`r` the red component of the pixel in the range 0-255.
-> Word8	`g` the green component of the pixel in the range 0-255.
-> Word8	`b` the blue component of the pixel in the range 0-255.
-> Word8	`a` the alpha component of the pixel in the range 0-255.
-> IO Word32

Map an RGBA quadruple to a pixel value for a surface.

This function maps the RGBA color value to the specified pixel format and returns the pixel value best approximating the given RGBA color value for the given pixel format.

If the surface pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette).

If the surface has a palette, the index of the closest matching color in the palette will be returned.

If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).

Returns: a pixel value.
Thread safety: This function can be called on different threads with different surfaces.
See also: mapSurfaceRGB

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_MapSurfaceRGBA. The unsafe flavor is mapSurfaceRGBA .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_MapSurfaceRGBA, defined at SDL3/SDL_surface.h 1655:36

Since: 3.2.0

readSurfacePixel Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to read.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Ptr Uint8	`r` a pointer filled in with the red channel, 0-255, or NULL to ignore this channel.
-> Ptr Uint8	`g` a pointer filled in with the green channel, 0-255, or NULL to ignore this channel.
-> Ptr Uint8	`b` a pointer filled in with the blue channel, 0-255, or NULL to ignore this channel.
-> Ptr Uint8	`a` a pointer filled in with the alpha channel, 0-255, or NULL to ignore this channel.
-> IO Bool

Retrieves a single pixel from a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Like getRGBA, this uses the entire 0..255 range when converting color components from pixel formats with less than 8 bits per RGB component.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ReadSurfacePixel. The safe flavor is readSurfacePixelSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ReadSurfacePixel, defined at SDL3/SDL_surface.h 1685:34

Since: 3.2.0

readSurfacePixelSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to read.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Ptr Uint8	`r` a pointer filled in with the red channel, 0-255, or NULL to ignore this channel.
-> Ptr Uint8	`g` a pointer filled in with the green channel, 0-255, or NULL to ignore this channel.
-> Ptr Uint8	`b` a pointer filled in with the blue channel, 0-255, or NULL to ignore this channel.
-> Ptr Uint8	`a` a pointer filled in with the alpha channel, 0-255, or NULL to ignore this channel.
-> IO Bool

Retrieves a single pixel from a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Like getRGBA, this uses the entire 0..255 range when converting color components from pixel formats with less than 8 bits per RGB component.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ReadSurfacePixel. The unsafe flavor is readSurfacePixel .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ReadSurfacePixel, defined at SDL3/SDL_surface.h 1685:34

Since: 3.2.0

readSurfacePixelFloat Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to read.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Ptr CFloat	`r` a pointer filled in with the red channel, normally in the range 0-1, or NULL to ignore this channel.
-> Ptr CFloat	`g` a pointer filled in with the green channel, normally in the range 0-1, or NULL to ignore this channel.
-> Ptr CFloat	`b` a pointer filled in with the blue channel, normally in the range 0-1, or NULL to ignore this channel.
-> Ptr CFloat	`a` a pointer filled in with the alpha channel, normally in the range 0-1, or NULL to ignore this channel.
-> IO Bool

Retrieves a single pixel from a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_ReadSurfacePixelFloat. The safe flavor is readSurfacePixelFloatSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ReadSurfacePixelFloat, defined at SDL3/SDL_surface.h 1712:34

Since: 3.2.0

readSurfacePixelFloatSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to read.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Ptr CFloat	`r` a pointer filled in with the red channel, normally in the range 0-1, or NULL to ignore this channel.
-> Ptr CFloat	`g` a pointer filled in with the green channel, normally in the range 0-1, or NULL to ignore this channel.
-> Ptr CFloat	`b` a pointer filled in with the blue channel, normally in the range 0-1, or NULL to ignore this channel.
-> Ptr CFloat	`a` a pointer filled in with the alpha channel, normally in the range 0-1, or NULL to ignore this channel.
-> IO Bool

Retrieves a single pixel from a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_ReadSurfacePixelFloat. The unsafe flavor is readSurfacePixelFloat .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_ReadSurfacePixelFloat, defined at SDL3/SDL_surface.h 1712:34

Since: 3.2.0

writeSurfacePixel Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to write.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Word8	`r` the red channel value, 0-255.
-> Word8	`g` the green channel value, 0-255.
-> Word8	`b` the blue channel value, 0-255.
-> Word8	`a` the alpha channel value, 0-255.
-> IO Bool

Writes a single pixel to a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Like mapRGBA, this uses the entire 0..255 range when converting color components from pixel formats with less than 8 bits per RGB component.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_WriteSurfacePixel. The safe flavor is writeSurfacePixelSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_WriteSurfacePixel, defined at SDL3/SDL_surface.h 1738:34

Since: 3.2.0

writeSurfacePixelSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to write.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Word8	`r` the red channel value, 0-255.
-> Word8	`g` the green channel value, 0-255.
-> Word8	`b` the blue channel value, 0-255.
-> Word8	`a` the alpha channel value, 0-255.
-> IO Bool

Writes a single pixel to a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Like mapRGBA, this uses the entire 0..255 range when converting color components from pixel formats with less than 8 bits per RGB component.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_WriteSurfacePixel. The unsafe flavor is writeSurfacePixel .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_WriteSurfacePixel, defined at SDL3/SDL_surface.h 1738:34

Since: 3.2.0

writeSurfacePixelFloat Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to write.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Float	`r` the red channel value, normally in the range 0-1.
-> Float	`g` the green channel value, normally in the range 0-1.
-> Float	`b` the blue channel value, normally in the range 0-1.
-> Float	`a` the alpha channel value, normally in the range 0-1.
-> IO Bool

Writes a single pixel to a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of SDL_WriteSurfacePixelFloat. The safe flavor is writeSurfacePixelFloatSafe .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_WriteSurfacePixelFloat, defined at SDL3/SDL_surface.h 1761:34

Since: 3.2.0

writeSurfacePixelFloatSafe Source #

Arguments

:: Ptr SDL_Surface	`surface` the surface to write.
-> Int32	`x` the horizontal coordinate, 0 <= x < width.
-> Int32	`y` the vertical coordinate, 0 <= y < height.
-> Float	`r` the red channel value, normally in the range 0-1.
-> Float	`g` the green channel value, normally in the range 0-1.
-> Float	`b` the blue channel value, normally in the range 0-1.
-> Float	`a` the alpha channel value, normally in the range 0-1.
-> IO Bool

Writes a single pixel to a surface.

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

Returns: true on success or false on failure; call getError for more information.
Thread safety: This function can be called on different threads with different surfaces.

`sdl3-bindgen-sys` notes

Expand

FFI safety: Safe foreign import of SDL_WriteSurfacePixelFloat. The unsafe flavor is writeSurfacePixelFloat .
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: SDL_WriteSurfacePixelFloat, defined at SDL3/SDL_surface.h 1761:34

Since: 3.2.0

C shims

mustLock Source #

Arguments

:: Ptr SDL_Surface	`surface` the SDL_Surface to check.
-> IO Bool

Determine whether a surface needs to be locked before its pixels are accessed.

The SDL_MUSTLOCK macro as a function.

Returns: true if the surface must be locked with lockSurface before its pixels are read or written, false otherwise.
See also: lockSurface, unlockSurface

`sdl3-bindgen-sys` notes

Expand

FFI safety: Unsafe foreign import of lithon_SDL_MUSTLOCK. The safe import is not exported : reads one field of the caller's surface; cannot block, lock, or call back.
Scalars: The binding generation has mapped C scalars to native Haskell scalars for this function. Pointers and structs are untouched by this best-effort mapping. Higher-level bindings are expected to map structs and pointers as appropriate.
C declaration: lithon_SDL_MUSTLOCK, defined at sdl3-bindgen-sys/SDL_surface_shims.h 39:24

Since: 3.2.0

FFI conventions

Documentation

Typed constants

Function aliases

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

sdl3-bindgen-sys notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes

`sdl3-bindgen-sys` notes