SDL_RenderTexture9Grid - Man Page

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

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_RenderTexture(3)

Info

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS