surface topic

CategorySurface

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, SDL_LoadBMP(). SDL itself does not provide loaders for various other file formats, but there are several excellent external libraries that do, including its own satellite library, SDL_image :

https://github.com/libsdl-org/SDL_image

Functions

sdlAddSurfaceAlternateImage(Pointer<SdlSurface> surface, Pointer<SdlSurface> image) → bool surface
Add an alternate version of a surface.
sdlBlitSurface(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect) → bool surface
Performs a fast blit from the source surface to the destination surface with clipping.
sdlBlitSurface9Grid(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, int leftWidth, int rightWidth, int topHeight, int bottomHeight, double scale, int scaleMode, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect) → bool surface
Perform a scaled blit using the 9-grid algorithm to a destination surface, which may be of a different format.
sdlBlitSurfaceScaled(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect, int scaleMode) → bool surface
Perform a scaled blit to a destination surface, which may be of a different format.
sdlBlitSurfaceTiled(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect) → bool surface
Perform a tiled blit to a destination surface, which may be of a different format.
sdlBlitSurfaceTiledWithScale(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, double scale, int scaleMode, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect) → bool surface
Perform a scaled and tiled blit to a destination surface, which may be of a different format.
sdlBlitSurfaceUnchecked(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect) → bool surface
Perform low-level surface blitting only.
sdlBlitSurfaceUncheckedScaled(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect, int scaleMode) → bool surface
Perform low-level surface scaled blitting only.
sdlClearSurface(Pointer<SdlSurface> surface, double r, double g, double b, double a) → bool surface
Clear a surface with a specific color, with floating point precision.
sdlConvertPixels(int width, int height, int srcFormat, Pointer<NativeType> src, int srcPitch, int dstFormat, Pointer<NativeType> dst, int dstPitch) → bool surface
Copy a block of pixels of one format to another format.
sdlConvertPixelsAndColorspace(int width, int height, int srcFormat, int srcColorspace, int srcProperties, Pointer<NativeType> src, int srcPitch, int dstFormat, int dstColorspace, int dstProperties, Pointer<NativeType> dst, int dstPitch) → bool surface
Copy a block of pixels of one format and colorspace to another format and colorspace.
sdlConvertSurface(Pointer<SdlSurface> surface, int format) → Pointer<SdlSurface> surface
Copy an existing surface to a new surface of the specified format.
sdlConvertSurfaceAndColorspace(Pointer<SdlSurface> surface, int format, Pointer<SdlPalette> palette, int colorspace, int props) → Pointer<SdlSurface> surface
Copy an existing surface to a new surface of the specified format and colorspace.
sdlCreateSurface(int width, int height, int format) → Pointer<SdlSurface> surface
Allocate a new surface with a specific pixel format.
sdlCreateSurfaceFrom(int width, int height, int format, Pointer<NativeType> pixels, int pitch) → Pointer<SdlSurface> surface
Allocate a new surface with a specific pixel format and existing pixel data.
sdlCreateSurfacePalette(Pointer<SdlSurface> surface) → Pointer<SdlPalette> surface
Create a palette and associate it with a surface.
sdlDestroySurface(Pointer<SdlSurface> surface) → void surface
Free a surface.
sdlDuplicateSurface(Pointer<SdlSurface> surface) → Pointer<SdlSurface> surface
Creates a new surface identical to the existing surface.
sdlFillSurfaceRect(Pointer<SdlSurface> dst, Pointer<SdlRect> rect, int color) → bool surface
Perform a fast fill of a rectangle with a specific color.
sdlFillSurfaceRects(Pointer<SdlSurface> dst, Pointer<SdlRect> rects, int count, int color) → bool surface
Perform a fast fill of a set of rectangles with a specific color.
sdlFlipSurface(Pointer<SdlSurface> surface, int flip) → bool surface
Flip a surface vertically or horizontally.
sdlGetSurfaceAlphaMod(Pointer<SdlSurface> surface, Pointer<Uint8> alpha) → bool surface
Get the additional alpha value used in blit operations.
sdlGetSurfaceBlendMode(Pointer<SdlSurface> surface, Pointer<Uint32> blendMode) → bool surface
Get the blend mode used for blit operations.
sdlGetSurfaceClipRect(Pointer<SdlSurface> surface, Pointer<SdlRect> rect) → bool surface
Get the clipping rectangle for a surface.
sdlGetSurfaceColorKey(Pointer<SdlSurface> surface, Pointer<Uint32> key) → bool surface
Get the color key (transparent pixel) for a surface.
sdlGetSurfaceColorMod(Pointer<SdlSurface> surface, Pointer<Uint8> r, Pointer<Uint8> g, Pointer<Uint8> b) → bool surface
Get the additional color value multiplied into blit operations.
sdlGetSurfaceColorspace(Pointer<SdlSurface> surface) → int surface
Get the colorspace used by a surface.
sdlGetSurfaceImages(Pointer<SdlSurface> surface, Pointer<Int32> count) → Pointer<Pointer<SdlSurface>> surface
Get an array including all versions of a surface.
sdlGetSurfacePalette(Pointer<SdlSurface> surface) → Pointer<SdlPalette> surface
Get the palette used by a surface.
sdlGetSurfaceProperties(Pointer<SdlSurface> surface) → int surface
Get the properties associated with a surface.
sdlLoadBmp(String? file) → Pointer<SdlSurface> surface
Load a BMP image from a file.
sdlLoadBmpIo(Pointer<SdlIoStream> src, bool closeio) → Pointer<SdlSurface> surface
Load a BMP image from a seekable SDL data stream.
sdlLoadPng(String? file) → Pointer<SdlSurface> surface
Load a PNG image from a file.
sdlLoadPngIo(Pointer<SdlIoStream> src, bool closeio) → Pointer<SdlSurface> surface
Load a PNG image from a seekable SDL data stream.
sdlLockSurface(Pointer<SdlSurface> surface) → bool surface
Set up a surface for directly accessing the pixels.
sdlMapSurfaceRgb(Pointer<SdlSurface> surface, int r, int g, int b) → int surface
Map an RGB triple to an opaque pixel value for a surface.
sdlMapSurfaceRgba(Pointer<SdlSurface> surface, int r, int g, int b, int a) → int surface
Map an RGBA quadruple to a pixel value for a surface.
sdlPremultiplyAlpha(int width, int height, int srcFormat, Pointer<NativeType> src, int srcPitch, int dstFormat, Pointer<NativeType> dst, int dstPitch, bool linear) → bool surface
Premultiply the alpha on a block of pixels.
sdlPremultiplySurfaceAlpha(Pointer<SdlSurface> surface, bool linear) → bool surface
Premultiply the alpha in a surface.
sdlReadSurfacePixel(Pointer<SdlSurface> surface, int x, int y, Pointer<Uint8> r, Pointer<Uint8> g, Pointer<Uint8> b, Pointer<Uint8> a) → bool surface
Retrieves a single pixel from a surface.
sdlReadSurfacePixelFloat(Pointer<SdlSurface> surface, int x, int y, Pointer<Float> r, Pointer<Float> g, Pointer<Float> b, Pointer<Float> a) → bool surface
Retrieves a single pixel from a surface.
sdlRemoveSurfaceAlternateImages(Pointer<SdlSurface> surface) → void surface
Remove all alternate versions of a surface.
sdlSaveBmp(Pointer<SdlSurface> surface, String? file) → bool surface
Save a surface to a file in BMP format.
sdlSaveBmpIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio) → bool surface
Save a surface to a seekable SDL data stream in BMP format.
sdlSavePng(Pointer<SdlSurface> surface, String? file) → bool surface
Save a surface to a file in PNG format.
sdlSavePngIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio) → bool surface
Save a surface to a seekable SDL data stream in PNG format.
sdlScaleSurface(Pointer<SdlSurface> surface, int width, int height, int scaleMode) → Pointer<SdlSurface> surface
Creates a new surface identical to the existing surface, scaled to the desired size.
sdlSetSurfaceAlphaMod(Pointer<SdlSurface> surface, int alpha) → bool surface
Set an additional alpha value used in blit operations.
sdlSetSurfaceBlendMode(Pointer<SdlSurface> surface, int blendMode) → bool surface
Set the blend mode used for blit operations.
sdlSetSurfaceClipRect(Pointer<SdlSurface> surface, Pointer<SdlRect> rect) → bool surface
Set the clipping rectangle for a surface.
sdlSetSurfaceColorKey(Pointer<SdlSurface> surface, bool enabled, int key) → bool surface
Set the color key (transparent pixel) in a surface.
sdlSetSurfaceColorMod(Pointer<SdlSurface> surface, int r, int g, int b) → bool surface
Set an additional color value multiplied into blit operations.
sdlSetSurfaceColorspace(Pointer<SdlSurface> surface, int colorspace) → bool surface
Set the colorspace used by a surface.
sdlSetSurfacePalette(Pointer<SdlSurface> surface, Pointer<SdlPalette> palette) → bool surface
Set the palette used by a surface.
sdlSetSurfaceRle(Pointer<SdlSurface> surface, bool enabled) → bool surface
Set the RLE acceleration hint for a surface.
sdlStretchSurface(Pointer<SdlSurface> src, Pointer<SdlRect> srcrect, Pointer<SdlSurface> dst, Pointer<SdlRect> dstrect, int scaleMode) → bool surface
Perform a stretched pixel copy from one surface to another.
sdlSurfaceHasAlternateImages(Pointer<SdlSurface> surface) → bool surface
Return whether a surface has alternate versions available.
sdlSurfaceHasColorKey(Pointer<SdlSurface> surface) → bool surface
Returns whether the surface has a color key.
sdlSurfaceHasRle(Pointer<SdlSurface> surface) → bool surface
Returns whether the surface is RLE enabled.
sdlUnlockSurface(Pointer<SdlSurface> surface) → void surface
Release a surface after directly accessing the pixels.
sdlWriteSurfacePixel(Pointer<SdlSurface> surface, int x, int y, int r, int g, int b, int a) → bool surface
Writes a single pixel to a surface.
sdlWriteSurfacePixelFloat(Pointer<SdlSurface> surface, int x, int y, double r, double g, double b, double a) → bool surface
Writes a single pixel to a surface.