SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_blendmode.h>
#include <SDL3/SDL_pixels.h>
#include <SDL3/SDL_properties.h>
#include <SDL3/SDL_rect.h>
#include <SDL3/SDL_rwops.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Data Structures | |
struct | SDL_Surface |
Header file for SDL_Surface definition and management functions.
Definition in file SDL_surface.h.
#define SDL_DONTFREE 0x00000004 |
Surface is referenced internally
Definition at line 56 of file SDL_surface.h.
#define SDL_MUSTLOCK | ( | S | ) | (((S)->flags & SDL_RLEACCEL) != 0) |
Evaluates to true if the surface needs to be locked before access.
Definition at line 64 of file SDL_surface.h.
#define SDL_PREALLOC 0x00000001 |
Surface uses preallocated memory
Definition at line 54 of file SDL_surface.h.
#define SDL_PROPERTY_SURFACE_COLOR_PRIMARIES_NUMBER "SDL.surface.color_primaries" |
Definition at line 292 of file SDL_surface.h.
#define SDL_PROPERTY_SURFACE_MAXCLL_NUMBER "SDL.surface.maxCLL" |
Definition at line 294 of file SDL_surface.h.
#define SDL_PROPERTY_SURFACE_MAXFALL_NUMBER "SDL.surface.maxFALL" |
Definition at line 295 of file SDL_surface.h.
#define SDL_PROPERTY_SURFACE_TRANSFER_CHARACTERISTICS_NUMBER "SDL.surface.transfer_characteristics" |
Definition at line 293 of file SDL_surface.h.
#define SDL_RLEACCEL 0x00000002 |
Surface is RLE encoded
Definition at line 55 of file SDL_surface.h.
#define SDL_SIMD_ALIGNED 0x00000008 |
Surface uses aligned memory
Definition at line 57 of file SDL_surface.h.
#define SDL_SURFACE_USES_PROPERTIES 0x00000010 |
Surface uses properties
Definition at line 58 of file SDL_surface.h.
#define SDL_SWSURFACE 0 |
Just here for compatibility
Definition at line 53 of file SDL_surface.h.
typedef int(* SDL_blit) (struct SDL_Surface *src, const SDL_Rect *srcrect, struct SDL_Surface *dst, const SDL_Rect *dstrect) |
The type of function used for surface blitting functions.
Definition at line 137 of file SDL_surface.h.
typedef struct SDL_BlitMap SDL_BlitMap |
Definition at line 66 of file SDL_surface.h.
enum SDL_ColorPrimaries |
The color primaries, as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en
Definition at line 144 of file SDL_surface.h.
enum SDL_FlipMode |
The flip mode
Enumerator | |
---|---|
SDL_FLIP_NONE | Do not flip |
SDL_FLIP_HORIZONTAL | flip horizontally |
SDL_FLIP_VERTICAL | flip vertically |
Definition at line 81 of file SDL_surface.h.
enum SDL_ScaleMode |
The scaling mode
Enumerator | |
---|---|
SDL_SCALEMODE_NEAREST | nearest pixel sampling |
SDL_SCALEMODE_LINEAR | linear filtering |
SDL_SCALEMODE_BEST | anisotropic filtering |
Definition at line 71 of file SDL_surface.h.
The transfer characteristics, as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en
Definition at line 165 of file SDL_surface.h.
The formula used for converting between YUV and RGB
Definition at line 190 of file SDL_surface.h.
|
extern |
Performs a fast blit from the source surface to the destination surface.
This assumes that the source and destination rectangles are the same size. If either srcrect
or dstrect
are NULL, the entire surface (src
or dst
) is copied. The final blit rectangles are saved in srcrect
and dstrect
after all clipping is performed.
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:
src | the SDL_Surface structure to be copied from |
srcrect | the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface |
dst | the SDL_Surface structure that is the blit target |
dstrect | the SDL_Rect structure representing the x and y position in the destination surface. On input the width and height are ignored (taken from srcrect), and on output this is filled in with the actual rectangle used after clipping. |
|
extern |
Perform a scaled surface copy to a destination surface.
src | the SDL_Surface structure to be copied from |
srcrect | the SDL_Rect structure representing the rectangle to be copied |
dst | the SDL_Surface structure that is the blit target |
dstrect | the SDL_Rect structure representing the target rectangle in the destination surface, filled with the actual rectangle used after clipping |
scaleMode | scale algorithm to be used |
|
extern |
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.
src | the SDL_Surface structure to be copied from |
srcrect | the SDL_Rect structure representing the rectangle to be copied, or NULL to copy the entire surface |
dst | the SDL_Surface structure that is the blit target |
dstrect | the SDL_Rect structure representing the target rectangle in the destination surface |
|
extern |
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.
src | the SDL_Surface structure to be copied from |
srcrect | the SDL_Rect structure representing the rectangle to be copied |
dst | the SDL_Surface structure that is the blit target |
dstrect | the SDL_Rect structure representing the target rectangle in the destination surface |
scaleMode | scale algorithm to be used |
|
extern |
Copy a block of pixels of one format to another format.
width | the width of the block to copy, in pixels |
height | the height of the block to copy, in pixels |
src_format | an SDL_PixelFormatEnum value of the src pixels format |
src | a pointer to the source pixels |
src_pitch | the pitch of the source pixels, in bytes |
dst_format | an SDL_PixelFormatEnum value of the dst pixels format |
dst | a pointer to be filled in with new pixel data |
dst_pitch | the pitch of the destination pixels, in bytes |
|
extern |
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.
surface | the existing SDL_Surface structure to convert |
format | the SDL_PixelFormat structure that the new surface is optimized for |
|
extern |
Copy an existing surface to a new surface of the specified format enum.
This function operates just like SDL_ConvertSurface(), but accepts an SDL_PixelFormatEnum value instead of an SDL_PixelFormat structure. As such, it might be easier to call but it doesn't have access to palette information for the destination surface, in case that would be important.
surface | the existing SDL_Surface structure to convert |
pixel_format | the SDL_PixelFormatEnum that the new surface is optimized for |
|
extern |
Allocate a new RGB surface with a specific pixel format.
width | the width of the surface |
height | the height of the surface |
format | the SDL_PixelFormatEnum for the new surface's pixel format. |
|
extern |
Allocate a new RGB 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.
pixels | a pointer to existing pixel data |
width | the width of the surface |
height | the height of the surface |
pitch | the pitch of the surface in bytes |
format | the SDL_PixelFormatEnum for the new surface's pixel format. |
|
extern |
Free an RGB surface.
It is safe to pass NULL to this function.
surface | the SDL_Surface to free. |
|
extern |
|
extern |
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 SDL_MapRGB() or SDL_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 SDL_SetSurfaceClipRect()), then this function will fill based on the intersection of the clip rectangle and rect
.
dst | the SDL_Surface structure that is the drawing target |
rect | the SDL_Rect structure representing the rectangle to fill, or NULL to fill the entire surface |
color | the color to fill with |
|
extern |
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 SDL_MapRGB() or SDL_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 SDL_SetSurfaceClipRect()), then this function will fill based on the intersection of the clip rectangle and rect
.
dst | the SDL_Surface structure that is the drawing target |
rects | an array of SDL_Rects representing the rectangles to fill. |
count | the number of rectangles in the array |
color | the color to fill with |
|
extern |
|
extern |
Get the additional alpha value used in blit operations.
surface | the SDL_Surface structure to query |
alpha | a pointer filled in with the current alpha value |
|
extern |
Get the blend mode used for blit operations.
surface | the SDL_Surface structure to query |
blendMode | a pointer filled in with the current SDL_BlendMode |
|
extern |
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.
surface | the SDL_Surface structure representing the surface to be clipped |
rect | an SDL_Rect structure filled in with the clipping rectangle for the surface |
|
extern |
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 SDL_MapRGB().
If the surface doesn't have color key enabled this function returns -1.
surface | the SDL_Surface structure to query |
key | a pointer filled in with the transparent pixel |
|
extern |
Get the additional color value multiplied into blit operations.
surface | the SDL_Surface structure to query |
r | a pointer filled in with the current red color value |
g | a pointer filled in with the current green color value |
b | a pointer filled in with the current blue color value |
|
extern |
Get the properties associated with a surface.
The following properties are understood by SDL:
SDL_PROPERTY_SURFACE_COLOR_PRIMARIES_NUMBER
: an SDL_ColorPrimaries value describing the surface colorspaceSDL_PROPERTY_SURFACE_TRANSFER_CHARACTERISTICS_NUMBER
: an SDL_TransferCharacteristics value describing the surface colorspaceSDL_PROPERTY_SURFACE_MAXCLL_NUMBER
: MaxCLL (Maximum Content Light Level) indicates the maximum light level of any single pixel (in cd/m2 or nits) of the entire playback sequence. MaxCLL is usually measured off the final delivered content after mastering. If one uses the full light level of the HDR mastering display and adds a hard clip at its maximum value, MaxCLL would be equal to the peak luminance of the mastering monitor.SDL_PROPERTY_SURFACE_MAXFALL_NUMBER
: MaxFALL (Maximum Frame Average Light Level) indicates the maximum value of the frame average light level (in cd/m2 or nits) of the entire playback sequence. MaxFALL is calculated by averaging the decoded luminance values of all the pixels within a frame. MaxFALL is usually much lower than MaxCLL.surface | the SDL_Surface structure to query |
|
extern |
Get the YUV conversion mode
|
extern |
Get the YUV conversion mode, returning the correct mode for the resolution when the current conversion mode is SDL_YUV_CONVERSION_AUTOMATIC
width | width |
height | height |
|
extern |
Load a BMP image from a file.
The new surface should be freed with SDL_DestroySurface(). Not doing so will result in a memory leak.
file | the BMP file to load |
|
extern |
Load a BMP image from a seekable SDL data stream.
The new surface should be freed with SDL_DestroySurface(). Not doing so will result in a memory leak.
src | the data stream for the surface |
freesrc | if SDL_TRUE, calls SDL_RWclose() on src before returning, even in the case of an error |
|
extern |
Set up a surface for directly accessing the pixels.
Between calls to SDL_LockSurface() / SDL_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 SDL_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.
surface | the SDL_Surface structure to be locked |
|
extern |
Premultiply the alpha on a block of pixels.
This is safe to use with src == dst, but not for other overlapping areas.
This function is currently only implemented for SDL_PIXELFORMAT_ARGB8888.
width | the width of the block to convert, in pixels |
height | the height of the block to convert, in pixels |
src_format | an SDL_PixelFormatEnum value of the src pixels format |
src | a pointer to the source pixels |
src_pitch | the pitch of the source pixels, in bytes |
dst_format | an SDL_PixelFormatEnum value of the dst pixels format |
dst | a pointer to be filled in with premultiplied pixel data |
dst_pitch | the pitch of the destination pixels, in bytes |
|
extern |
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 SDL_GetRGBA, this uses the entire 0..255 range when converting color components from pixel formats with less than 8 bits per RGB component.
surface | the surface to read |
x | the horizontal coordinate, 0 <= x < width |
y | the vertical coordinate, 0 <= y < height |
r | a pointer filled in with the red channel, 0-255, or NULL to ignore this channel |
g | a pointer filled in with the green channel, 0-255, or NULL to ignore this channel |
b | a pointer filled in with the blue channel, 0-255, or NULL to ignore this channel |
a | a pointer filled in with the alpha channel, 0-255, or NULL to ignore this channel |
|
extern |
Save a surface to a file.
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.
surface | the SDL_Surface structure containing the image to be saved |
file | a file to save to |
|
extern |
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.
surface | the SDL_Surface structure containing the image to be saved |
dst | a data stream to save to |
freedst | if SDL_TRUE, calls SDL_RWclose() on dst before returning, even in the case of an error |
|
extern |
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)
surface | the SDL_Surface structure to update |
alpha | the alpha value multiplied into blit operations |
|
extern |
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
.
surface | the SDL_Surface structure to update |
blendMode | the SDL_BlendMode to use for blit blending |
|
extern |
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.
surface | the SDL_Surface structure to be clipped |
rect | the SDL_Rect structure representing the clipping rectangle, or NULL to disable clipping |
|
extern |
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 SDL_MapRGB().
RLE acceleration can substantially speed up blitting of images with large horizontal runs of transparent pixels. See SDL_SetSurfaceRLE() for details.
surface | the SDL_Surface structure to update |
flag | SDL_TRUE to enable color key, SDL_FALSE to disable color key |
key | the transparent pixel |
|
extern |
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)
surface | the SDL_Surface structure to update |
r | the red color value multiplied into blit operations |
g | the green color value multiplied into blit operations |
b | the blue color value multiplied into blit operations |
|
extern |
Set the palette used by a surface.
A single palette can be shared with many surfaces.
surface | the SDL_Surface structure to update |
palette | the SDL_Palette structure to use |
|
extern |
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.
surface | the SDL_Surface structure to optimize |
flag | 0 to disable, non-zero to enable RLE acceleration |
|
extern |
Set the YUV conversion mode
mode | YUV conversion mode |
|
extern |
Perform stretch blit between two surfaces of the same format.
Using SDL_SCALEMODE_NEAREST: fast, low quality. Using SDL_SCALEMODE_LINEAR: bilinear scaling, slower, better quality, only 32BPP.
src | the SDL_Surface structure to be copied from |
srcrect | the SDL_Rect structure representing the rectangle to be copied |
dst | the SDL_Surface structure that is the blit target |
dstrect | the SDL_Rect structure representing the target rectangle in the destination surface |
scaleMode | scale algorithm to be used |
|
extern |
Returns whether the surface has a color key
It is safe to pass a NULL surface
here; it will return SDL_FALSE.
surface | the SDL_Surface structure to query |
|
extern |
Returns whether the surface is RLE enabled
It is safe to pass a NULL surface
here; it will return SDL_FALSE.
surface | the SDL_Surface structure to query |
|
extern |
Release a surface after directly accessing the pixels.
surface | the SDL_Surface structure to be unlocked |