table of contents
SDL_RenderTexture9Grid(3) | SDL3 FUNCTIONS | SDL_RenderTexture9Grid(3) |
NAME¶
SDL_RenderTexture9Grid - Perform a scaled copy using the 9-grid algorithm to the current rendering target at subpixel precision.
HEADER FILE¶
Defined in SDL3/SDL_render.h
SYNOPSIS¶
#include "SDL3/SDL.h"
bool SDL_RenderTexture9Grid(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_FRect *srcrect, float left_width, float right_width, float top_height, float bottom_height, float scale, const SDL_FRect *dstrect);
DESCRIPTION¶
The pixels in the texture 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.
FUNCTION PARAMETERS¶
- renderer
- the renderer which should copy parts of a texture.
- texture
- the source texture.
- srcrect
- the SDL_Rect
structure representing the rectangle to be used for the 9-grid, or NULL to use the entire texture. - left_width
- the width, in pixels, of the left corners in srcrect .
- right_width
- the width, in pixels, of the right corners in srcrect .
- top_height
- the height, in pixels, of the top corners in srcrect .
- bottom_height
- the height, in pixels, of the bottom corners in srcrect .
- scale
- the scale used to transform the corner of srcrect into the corner of dstrect , or 0.0f for an unscaled copy.
- dstrect
- a pointer to the destination rectangle, or NULL for the entire rendering target.
RETURN VALUE¶
Returns true on success or false on failure; call
SDL_GetError () for more information.
THREAD SAFETY¶
You may only call this function from the main thread.
AVAILABILITY¶
This function is available since SDL 3.1.3.
SEE ALSO¶
•(3), SDL_RenderTexture(3)
SDL 3.1.6 | Simple Directmedia Layer |