1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
//! Module for SDL's in-memory bitmap type. use crate::{ blendmode::*, c_char, c_int, c_void, pixels::*, rect::*, rwops::*, stdinc::*, }; /// Surface uses preallocated memory pub const SDL_PREALLOC: u32 = 0x00000001; /// Surface is RLE encoded pub const SDL_RLEACCEL: u32 = 0x00000002; /// Surface is referenced internally pub const SDL_DONTFREE: u32 = 0x00000004; /// Surface uses aligned memory pub const SDL_SIMD_ALIGNED: u32 = 0x00000008; /// Checks if an [`SDL_Surface`] must be locked before the pixels are accessed /// directly. #[inline] #[must_use] pub unsafe fn SDL_MUSTLOCK(s: *const SDL_Surface) -> bool { ((*s).flags & SDL_RLEACCEL) != 0 } /// A newtype'd `c_void`. #[allow(unused)] #[repr(transparent)] pub struct SDL_BlitMap(c_void); /// Represents a bitmap image in CPU memory. /// /// Generally, you should not touch these fields yourself. #[derive(Debug)] #[repr(C)] #[allow(missing_docs)] pub struct SDL_Surface { /// Read-only pub flags: Uint32, /// Read-only pub format: *mut SDL_PixelFormat, /// Read-only pub w: c_int, /// Read-only pub h: c_int, /// Read-only pub pitch: c_int, /// Read-write pub pixels: *mut c_void, /// Application data associated with the surface, Read-write pub userdata: *mut c_void, /// information needed for surfaces requiring locks, Read-only pub locked: c_int, /// list of BlitMap that hold a reference to this surface, Private pub list_blitmap: *mut c_void, /// clipping information, Read-only pub clip_rect: SDL_Rect, /// info for fast blit mapping to other surfaces, Private pub map: *mut SDL_BlitMap, /// Reference count -- used when freeing surface, Read-mostly pub refcount: c_int, } /// The formula used for converting between YUV and RGB. #[derive(Debug, Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Hash)] #[repr(transparent)] pub struct SDL_YUV_CONVERSION_MODE(pub u32); /// Full range JPEG pub const SDL_YUV_CONVERSION_JPEG: SDL_YUV_CONVERSION_MODE = SDL_YUV_CONVERSION_MODE(0); /// BT.601 (the default) pub const SDL_YUV_CONVERSION_BT601: SDL_YUV_CONVERSION_MODE = SDL_YUV_CONVERSION_MODE(1); /// BT.709 pub const SDL_YUV_CONVERSION_BT709: SDL_YUV_CONVERSION_MODE = SDL_YUV_CONVERSION_MODE(2); /// BT.601 for SD content, BT.709 for HD content pub const SDL_YUV_CONVERSION_AUTOMATIC: SDL_YUV_CONVERSION_MODE = SDL_YUV_CONVERSION_MODE(3); /// Given a file path to a BMP file, load and parse it into an [`SDL_Surface`] /// as one step. /// /// **Return:** As [`SDL_LoadBMP_RW`]: the new surface, or NULL if there was an /// error. #[inline] pub unsafe fn SDL_LoadBMP(file: *const c_char) -> *mut SDL_Surface { SDL_LoadBMP_RW(SDL_RWFromFile(file, b"rb\0".as_ptr().cast()), 1) } /// Save an [`SDL_Surface`] to the file path specified. /// /// **Return:** As [`SDL_SaveBMP_RW`]: 0 if successful or -1 if there was an /// error. #[inline] pub unsafe fn SDL_SaveBMP( surface: *mut SDL_Surface, file: *const c_char, ) -> c_int { SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, b"wb\0".as_ptr().cast()), 1) } extern "C" { /// Allocate a new RGB surface. /// /// If the depth is 4 or 8 bits, an empty palette is allocated for the /// surface. If the depth is greater than 8 bits, the pixel format is set /// using the flags '[RGB]mask'. /// /// If the function runs out of memory, it will return NULL. /// /// * `flags`: The `flags` are obsolete and should be set to 0. /// * `width`: The width in pixels of the surface to create. /// * `height`: The height in pixels of the surface to create. /// * `depth`: The depth in bits of the surface to create. /// * `Rmask`: The red mask of the surface to create. /// * `Gmask`: The green mask of the surface to create. /// * `Bmask`: The blue mask of the surface to create. /// * `Amask`: The alpha mask of the surface to create. /// /// **Return:** A new [`SDL_Surface`], or NULL on error (call [`SDL_GetError`] /// for more info). /// /// **Note:** This actually uses [`SDL_MasksToPixelFormatEnum`] to determine a /// pixel format enum value, and then calls /// [`SDL_CreateRGBSurfaceWithFormat`]. If you already know the pixel format /// enum value, then you can use that function directly. pub fn SDL_CreateRGBSurface( flags: Uint32, width: c_int, height: c_int, depth: c_int, Rmask: Uint32, Gmask: Uint32, Bmask: Uint32, Amask: Uint32, ) -> *mut SDL_Surface; /// Similar to [`SDL_CreateRGBSurface`], but using a pixel format enum value. pub fn SDL_CreateRGBSurfaceWithFormat( flags: Uint32, width: c_int, height: c_int, depth: c_int, format: Uint32, ) -> *mut SDL_Surface; /// Makes a surface from a pre-allocated buffer. /// /// The surface depends on the pixels allocation for its lifetime, but has the /// `PRE_ALLOC` flag so it won't free the pixels on its own. In other words, /// this works like a borrow rather than like an ownership transfer. pub fn SDL_CreateRGBSurfaceFrom( pixels: *mut c_void, width: c_int, height: c_int, depth: c_int, pitch: c_int, Rmask: Uint32, Gmask: Uint32, Bmask: Uint32, Amask: Uint32, ) -> *mut SDL_Surface; /// Makes a surface from a pre-allocated buffer in a specified format. /// /// This is like a combination of [`SDL_CreateRGBSurfaceWithFormat`] and /// [`SDL_CreateRGBSurfaceFrom`]. pub fn SDL_CreateRGBSurfaceWithFormatFrom( pixels: *mut c_void, width: c_int, height: c_int, depth: c_int, pitch: c_int, format: Uint32, ) -> *mut SDL_Surface; /// Frees the surface. /// /// This doesn't necessarily free any memory. Surfaces use ref counting for /// some things, and this will only actually free the memory if the ref count /// goes to 0. Also, they can be formed using borrowed memory, and in that /// case freeing the surface will not free the borrowed pixel memory itself. pub fn SDL_FreeSurface(surface: *mut SDL_Surface); /// Set the palette used by a surface. /// /// A single palette can be shared with many surfaces. /// /// **Return:** 0, or -1 if the surface format doesn't use a palette. pub fn SDL_SetSurfacePalette( surface: *mut SDL_Surface, palette: *mut SDL_Palette, ) -> c_int; /// Sets 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)`](SDL_MUSTLOCK) 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. /// /// No operating system or library calls should be made between lock/unlock /// pairs, as critical system locks may be held during this time. /// /// [`SDL_LockSurface`] returns 0, or -1 if the surface couldn't be locked. pub fn SDL_LockSurface(surface: *mut SDL_Surface) -> c_int; /// See [`SDL_LockSurface`] pub fn SDL_UnlockSurface(surface: *mut SDL_Surface); /// Load a surface from a seekable SDL data stream (memory or file). /// /// If `freesrc` is non-zero, the stream will be closed after being read. /// /// The new surface should be freed with [`SDL_FreeSurface`]. /// /// **Return:** the new surface, or NULL if there was an error. pub fn SDL_LoadBMP_RW( src: *mut SDL_RWops, freesrc: c_int, ) -> *mut SDL_Surface; /// Save a surface to a seekable SDL data stream (memory or 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. /// /// If `freedst` is non-zero, the stream will be closed after being written. /// /// **Return:** 0 if successful or -1 if there was an error. pub fn SDL_SaveBMP_RW( surface: *mut SDL_Surface, dst: *mut SDL_RWops, freedst: c_int, ) -> c_int; /// Sets the RLE acceleration hint for a surface. /// /// If RLE is enabled, colorkey and alpha blending blits are much faster, /// but the surface must be locked before directly accessing the pixels. /// /// **Return:** 0 on success, or -1 if the surface is not valid pub fn SDL_SetSurfaceRLE(surface: *mut SDL_Surface, flag: c_int) -> c_int; /// Returns whether the surface is RLE enabled /// /// **Returns:** `SDL_TRUE` if the surface is RLE enabled, or `SDL_FALSE` if /// the surface is `NULL` or not RLE enabled pub fn SDL_HasSurfaceRLE(surface: *mut SDL_Surface) -> SDL_bool; /// Sets the color key (transparent pixel) in a blit-able surface. /// /// You can pass [`SDL_RLEACCEL`] to enable RLE accelerated blits. /// /// * `surface`: The surface to update /// * `flag`: Non-zero to enable colorkey and 0 to disable colorkey /// * `key`: The transparent pixel in the native surface format /// /// **Return:** 0 on success, or -1 if the surface is not valid pub fn SDL_SetColorKey( surface: *mut SDL_Surface, flag: c_int, key: Uint32, ) -> c_int; /// Returns whether the surface has a color key /// /// **Return:** `SDL_TRUE` if the surface has a color key, or `SDL_FALSE` if /// the surface is NULL or has no color key pub fn SDL_HasColorKey(surface: *mut SDL_Surface) -> SDL_bool; /// Gets the color key (transparent pixel) in a blit-able surface. /// /// * `surface`: The surface to update /// * `key`: A pointer filled in with the transparent pixel in the native /// surface format /// /// **Return:** 0 on success, or -1 if the surface is not valid or colorkey is /// not enabled. pub fn SDL_GetColorKey(surface: *mut SDL_Surface, key: *mut Uint32) -> c_int; /// Set an additional color value used in blit operations. /// /// * `surface`: The surface 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. /// /// **Return:** 0 on success, or -1 if the surface is not valid. pub fn SDL_SetSurfaceColorMod( surface: *mut SDL_Surface, r: Uint8, g: Uint8, b: Uint8, ) -> c_int; /// Get the additional color value used in blit operations. /// /// * `surface`: The surface 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. /// /// **Return:** 0 on success, or -1 if the surface is not valid. pub fn SDL_GetSurfaceColorMod( surface: *mut SDL_Surface, r: *mut Uint8, g: *mut Uint8, b: *mut Uint8, ) -> c_int; /// Get the additional alpha value used in blit operations. /// /// * `surface`: The surface to query. /// * `alpha`: A pointer filled in with the current alpha value. /// /// **Return:** 0 on success, or -1 if the surface is not valid. pub fn SDL_SetSurfaceAlphaMod( surface: *mut SDL_Surface, alpha: Uint8, ) -> c_int; /// Set the blend mode used for blit operations. /// /// * `surface`: The surface to update. /// * `blendMode`: [`SDL_BlendMode`] to use for blit blending. /// /// **Return:** 0 on success, or -1 if the parameters are not valid. pub fn SDL_SetSurfaceBlendMode( surface: *mut SDL_Surface, blendMode: SDL_BlendMode, ) -> c_int; /// Get the blend mode used for blit operations. /// /// * `surface`: The surface to query. /// * `blendMode`: A pointer filled in with the current blend mode. /// /// **Return:** 0 on success, or -1 if the surface is not valid. pub fn SDL_GetSurfaceBlendMode( surface: *mut SDL_Surface, blendMode: *mut SDL_BlendMode, ) -> c_int; /// Sets the clipping rectangle for the destination surface in a blit. /// /// If the clip rectangle is NULL, clipping will be disabled. /// /// If the clip rectangle doesn't intersect the surface, the function will /// return `SDL_FALSE` and blits will be completely clipped. Otherwise the /// function returns `SDL_TRUE` and blits to the surface will be clipped to /// the intersection of the surface area and the clipping rectangle. /// /// Note that blits are automatically clipped to the edges of the source /// and destination surfaces. pub fn SDL_SetClipRect( surface: *mut SDL_Surface, rect: *const SDL_Rect, ) -> SDL_bool; /// Gets the clipping rectangle for the destination surface in a blit. /// /// `rect` must be a pointer to a valid rectangle which will be filled /// with the correct values. pub fn SDL_GetClipRect(surface: *mut SDL_Surface, rect: *mut SDL_Rect); /// Creates a new surface identical to the existing surface pub fn SDL_DuplicateSurface(surface: *mut SDL_Surface) -> *mut SDL_Surface; /// Creates a new surface of the specified format, and then copies and maps /// the given surface to it so the blit of the converted surface will be as /// fast as possible. If this function fails, it returns NULL. /// /// The `flags` parameter is passed to [`SDL_CreateRGBSurface`] and has those /// semantics. You can also pass [`SDL_RLEACCEL`] in the flags parameter and /// SDL will try to RLE accelerate colorkey and alpha blits in the resulting /// surface. pub fn SDL_ConvertSurface( src: *mut SDL_Surface, fmt: *const SDL_PixelFormat, flags: Uint32, ) -> *mut SDL_Surface; /// See [`SDL_ConvertSurface`] pub fn SDL_ConvertSurfaceFormat( src: *mut SDL_Surface, pixel_format: Uint32, flags: Uint32, ) -> *mut SDL_Surface; /// Copy a block of pixels of one format to another format /// /// **Return:** 0 on success, or -1 if there was an error pub fn SDL_ConvertPixels( width: c_int, height: c_int, src_format: Uint32, src: *const c_void, src_pitch: c_int, dst_format: Uint32, dst: *mut c_void, dst_pitch: c_int, ) -> c_int; /// Performs a fast fill of the given rectangle with `color`. /// /// If `rect` is NULL, the whole surface will be filled with `color`. /// /// The color should be a pixel of the format used by the surface, and /// can be generated by the SDL_MapRGB() function. /// /// **Return:** 0 on success, or -1 on error. pub fn SDL_FillRect( dst: *mut SDL_Surface, rect: *const SDL_Rect, color: Uint32, ) -> c_int; /// See [`SDL_FillRect`] pub fn SDL_FillRects( dst: *mut SDL_Surface, rects: *const SDL_Rect, count: c_int, color: Uint32, ) -> c_int; /// 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. /// /// **Return:** If the blit is successful, it returns 0, otherwise it returns /// -1. /// /// 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: /// ```txt /// 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 matching 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 matching 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 matching 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 matching the /// source color key. /// ``` /// /// You should call [`SDL_BlitSurface`] unless you know exactly how SDL /// blitting works internally and how to use the other blit functions. #[link_name = "SDL_UpperBlit"] pub fn SDL_BlitSurface( src: *mut SDL_Surface, srcrect: *const SDL_Rect, dst: *mut SDL_Surface, dstrect: *mut SDL_Rect, ) -> c_int; /// This is the public scaled blit function, SDL_BlitScaled(), and it performs /// rectangle validation and clipping before passing it to /// SDL_LowerBlitScaled() #[link_name = "SDL_UpperBlitScaled"] pub fn SDL_BlitScaled( src: *mut SDL_Surface, srcrect: *const SDL_Rect, dst: *mut SDL_Surface, dstrect: *mut SDL_Rect, ) -> c_int; /// Set the YUV conversion mode pub fn SDL_SetYUVConversionMode(mode: SDL_YUV_CONVERSION_MODE); /// Get the YUV conversion mode pub fn SDL_GetYUVConversionMode() -> SDL_YUV_CONVERSION_MODE; /// Get the YUV conversion mode. /// /// Returns the correct mode for the resolution when the current conversion /// mode is `SDL_YUV_CONVERSION_AUTOMATIC` pub fn SDL_GetYUVConversionModeForResolution( width: c_int, height: c_int, ) -> SDL_YUV_CONVERSION_MODE; }