Skip to content

Commit

Permalink
SDL API renaming: SDL_render.h
Browse files Browse the repository at this point in the history
Fixes #6883
  • Loading branch information
slouken committed Dec 27, 2022
1 parent 083e436 commit 0d54115
Show file tree
Hide file tree
Showing 41 changed files with 588 additions and 454 deletions.
32 changes: 32 additions & 0 deletions WhatsNew.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,38 @@ General:
* SDL_NewAudioStream => SDL_CreateAudioStream
* SDL_NumJoysticks => SDL_GetNumJoysticks
* SDL_PixelFormatEnumToMasks => SDL_GetMasksForPixelFormatEnum
* SDL_RenderCopy => SDL_RenderTexture
* SDL_RenderCopyEx => SDL_RenderTextureRotated
* SDL_RenderCopyExF => SDL_RenderTextureRotatedF
* SDL_RenderCopyF => SDL_RenderTextureF
* SDL_RenderDrawLine => SDL_RenderLine
* SDL_RenderDrawLineF => SDL_RenderLineF
* SDL_RenderDrawLines => SDL_RenderLines
* SDL_RenderDrawLinesF => SDL_RenderLinesF
* SDL_RenderDrawPoint => SDL_RenderPoint
* SDL_RenderDrawPointF => SDL_RenderPointF
* SDL_RenderDrawPoints => SDL_RenderPoints
* SDL_RenderDrawPointsF => SDL_RenderPointsF
* SDL_RenderDrawRect => SDL_RenderRect
* SDL_RenderDrawRectF => SDL_RenderRectF
* SDL_RenderDrawRects => SDL_RenderRects
* SDL_RenderDrawRectsF => SDL_RenderRectsF
* SDL_RenderGetClipRect => SDL_GetRenderClipRect
* SDL_RenderGetIntegerScale => SDL_GetRenderIntegerScale
* SDL_RenderGetLogicalSize => SDL_GetRenderLogicalSize
* SDL_RenderGetMetalCommandEncoder => SDL_GetRenderMetalCommandEncoder
* SDL_RenderGetMetalLayer => SDL_GetRenderMetalLayer
* SDL_RenderGetScale => SDL_GetRenderScale
* SDL_RenderGetViewport => SDL_GetRenderViewport
* SDL_RenderGetWindow => SDL_GetRenderWindow
* SDL_RenderIsClipEnabled => SDL_IsRenderClipEnabled
* SDL_RenderSetClipRect => SDL_SetRenderClipRect
* SDL_RenderSetIntegerScale => SDL_SetRenderIntegerScale
* SDL_RenderSetLogicalSize => SDL_SetRenderLogicalSize
* SDL_RenderSetScale => SDL_SetRenderScale
* SDL_RenderSetVSync => SDL_SetRenderVSync
* SDL_RenderSetViewport => SDL_SetRenderViewport
* SDL_RenderTargetSupported => SDL_IsRenderTargetSupported
* Removed the following functions from the API, see docs/README-migration.md for details:
* SDL_AudioInit()
* SDL_AudioQuit()
Expand Down
6 changes: 3 additions & 3 deletions Xcode-iOS/Demos/src/accelerometer.c
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,13 @@ render(SDL_Renderer *renderer, int w, int h, double deltaTime)
}

/* draw the background */
SDL_RenderCopy(renderer, space, NULL, NULL);
SDL_RenderTexture(renderer, space, NULL, NULL);

/* draw the ship */
shipData.rect.x = shipData.x;
shipData.rect.y = shipData.y;

SDL_RenderCopy(renderer, ship, NULL, &shipData.rect);
SDL_RenderTexture(renderer, ship, NULL, &shipData.rect);

/* update screen */
SDL_RenderPresent(renderer);
Expand Down Expand Up @@ -174,7 +174,7 @@ main(int argc, char *argv[])
renderer = SDL_CreateRenderer(window, NULL, 0);

SDL_GetWindowSize(window, &w, &h);
SDL_RenderSetLogicalSize(renderer, w, h);
SDL_SetRenderLogicalSize(renderer, w, h);

/* print out some info about joysticks and try to open accelerometer for use */
printf("There are %d joysticks available\n", SDL_GetNumJoysticks());
Expand Down
8 changes: 4 additions & 4 deletions Xcode-iOS/Demos/src/happy.c
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ initializeHappyFaces(SDL_Renderer *renderer)
int i;
int w;
int h;
SDL_RenderGetLogicalSize(renderer, &w, &h);
SDL_GetRenderLogicalSize(renderer, &w, &h);

for (i = 0; i < NUM_HAPPY_FACES; i++) {
faces[i].x = randomFloat(0.0f, w - HAPPY_FACE_SIZE);
Expand All @@ -48,7 +48,7 @@ render(SDL_Renderer *renderer, double deltaTime)
int w;
int h;

SDL_RenderGetLogicalSize(renderer, &w, &h);
SDL_GetRenderLogicalSize(renderer, &w, &h);

/* setup boundaries for happyface bouncing */
int maxx = w - HAPPY_FACE_SIZE;
Expand Down Expand Up @@ -93,7 +93,7 @@ render(SDL_Renderer *renderer, double deltaTime)
}
dstRect.x = faces[i].x;
dstRect.y = faces[i].y;
SDL_RenderCopy(renderer, texture, &srcRect, &dstRect);
SDL_RenderTexture(renderer, texture, &srcRect, &dstRect);
}
/* update screen */
SDL_RenderPresent(renderer);
Expand Down Expand Up @@ -149,7 +149,7 @@ main(int argc, char *argv[])
renderer = SDL_CreateRenderer(window, NULL, 0);

SDL_GetWindowSize(window, &width, &height);
SDL_RenderSetLogicalSize(renderer, width, height);
SDL_SetRenderLogicalSize(renderer, width, height);

initializeTexture(renderer);
initializeHappyFaces(renderer);
Expand Down
8 changes: 4 additions & 4 deletions Xcode-iOS/Demos/src/keyboard.c
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ void
getPositionForCharNumber(int n, int *x, int *y)
{
int renderW, renderH;
SDL_RenderGetLogicalSize(renderer, &renderW, &renderH);
SDL_GetRenderLogicalSize(renderer, &renderW, &renderH);

int x_padding = 16; /* padding space on left and right side of screen */
int y_padding = 32; /* padding space at top of screen */
Expand All @@ -157,7 +157,7 @@ drawGlyph(int glyph, int positionIndex)
getPositionForCharNumber(positionIndex, &x, &y);
SDL_Rect srcRect = { GLYPH_SIZE_IMAGE * glyph, 0, GLYPH_SIZE_IMAGE, GLYPH_SIZE_IMAGE };
SDL_Rect dstRect = { x, y, GLYPH_SIZE_SCREEN, GLYPH_SIZE_SCREEN };
SDL_RenderCopy(renderer, texture, &srcRect, &dstRect);
SDL_RenderTexture(renderer, texture, &srcRect, &dstRect);
}

/* this function loads our font into an SDL_Texture and returns the SDL_Texture */
Expand Down Expand Up @@ -227,7 +227,7 @@ main(int argc, char *argv[])
renderer = SDL_CreateRenderer(window, NULL, SDL_RENDERER_PRESENTVSYNC);

SDL_GetWindowSize(window, &width, &height);
SDL_RenderSetLogicalSize(renderer, width, height);
SDL_SetRenderLogicalSize(renderer, width, height);

/* load up our font */
loadFont();
Expand All @@ -253,7 +253,7 @@ main(int argc, char *argv[])
if (event.window.event == SDL_WINDOWEVENT_RESIZED) {
width = event.window.data1;
height = event.window.data2;
SDL_RenderSetLogicalSize(renderer, width, height);
SDL_SetRenderLogicalSize(renderer, width, height);
#ifdef TEST_INPUT_RECT
textrect.x = 0;
textrect.y = height - GLYPH_SIZE_IMAGE;
Expand Down
4 changes: 2 additions & 2 deletions Xcode-iOS/Demos/src/mixer.c
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ initializeButtons(SDL_Renderer *renderer)
SDL_Color downColor = { 191, 191, 221, 255 }; /* color of drum when pressed */
int renderW, renderH;

SDL_RenderGetLogicalSize(renderer, &renderW, &renderH);
SDL_GetRenderLogicalSize(renderer, &renderW, &renderH);

buttonRect.x = spacing;
buttonRect.y = spacing;
Expand Down Expand Up @@ -287,7 +287,7 @@ main(int argc, char *argv[])
renderer = SDL_CreateRenderer(window, NULL, 0);

SDL_GetWindowSize(window, &width, &height);
SDL_RenderSetLogicalSize(renderer, width, height);
SDL_SetRenderLogicalSize(renderer, width, height);

/* initialize the mixer */
SDL_memset(&mixer, 0, sizeof(mixer));
Expand Down
4 changes: 2 additions & 2 deletions Xcode-iOS/Demos/src/rectangles.c
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ render(SDL_Renderer *renderer)
int renderW;
int renderH;

SDL_RenderGetLogicalSize(renderer, &renderW, &renderH);
SDL_GetRenderLogicalSize(renderer, &renderW, &renderH);

/* Come up with a random rectangle */
SDL_Rect rect;
Expand Down Expand Up @@ -69,7 +69,7 @@ main(int argc, char *argv[])
}

SDL_GetWindowSize(window, &windowW, &windowH);
SDL_RenderSetLogicalSize(renderer, windowW, windowH);
SDL_SetRenderLogicalSize(renderer, windowW, windowH);

/* Fill screen with black */
SDL_SetRenderDrawColor(renderer, 0, 0, 0, 255);
Expand Down
6 changes: 3 additions & 3 deletions Xcode-iOS/Demos/src/touch.c
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ drawLine(SDL_Renderer *renderer, float startx, float starty, float dx, float dy)
x += dx_prime;
y += dy_prime;
/* draw brush blot */
SDL_RenderCopy(renderer, brush, NULL, &dstRect);
SDL_RenderTexture(renderer, brush, NULL, &dstRect);
}
}

Expand Down Expand Up @@ -96,7 +96,7 @@ main(int argc, char *argv[])
renderer = SDL_CreateRenderer(window, NULL, 0);

SDL_GetWindowSize(window, &w, &h);
SDL_RenderSetLogicalSize(renderer, w, h);
SDL_SetRenderLogicalSize(renderer, w, h);

/* load brush texture */
initializeTexture(renderer);
Expand Down Expand Up @@ -127,7 +127,7 @@ main(int argc, char *argv[])
}
}

SDL_RenderCopy(renderer, target, NULL, NULL);
SDL_RenderTexture(renderer, target, NULL, NULL);
SDL_RenderPresent(renderer);
}

Expand Down
34 changes: 34 additions & 0 deletions docs/README-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,40 @@ which index is the "opengl" or whatnot driver, you can just pass that string dir
here, now. Passing NULL is the same as passing -1 here in SDL2, to signify you want SDL
to decide for you.

The following functions have been renamed:
* SDL_RenderCopy => SDL_RenderTexture
* SDL_RenderCopyEx => SDL_RenderTextureRotated
* SDL_RenderCopyExF => SDL_RenderTextureRotatedF
* SDL_RenderCopyF => SDL_RenderTextureF
* SDL_RenderDrawLine => SDL_RenderLine
* SDL_RenderDrawLineF => SDL_RenderLineF
* SDL_RenderDrawLines => SDL_RenderLines
* SDL_RenderDrawLinesF => SDL_RenderLinesF
* SDL_RenderDrawPoint => SDL_RenderPoint
* SDL_RenderDrawPointF => SDL_RenderPointF
* SDL_RenderDrawPoints => SDL_RenderPoints
* SDL_RenderDrawPointsF => SDL_RenderPointsF
* SDL_RenderDrawRect => SDL_RenderRect
* SDL_RenderDrawRectF => SDL_RenderRectF
* SDL_RenderDrawRects => SDL_RenderRects
* SDL_RenderDrawRectsF => SDL_RenderRectsF
* SDL_RenderGetClipRect => SDL_GetRenderClipRect
* SDL_RenderGetIntegerScale => SDL_GetRenderIntegerScale
* SDL_RenderGetLogicalSize => SDL_GetRenderLogicalSize
* SDL_RenderGetMetalCommandEncoder => SDL_GetRenderMetalCommandEncoder
* SDL_RenderGetMetalLayer => SDL_GetRenderMetalLayer
* SDL_RenderGetScale => SDL_GetRenderScale
* SDL_RenderGetViewport => SDL_GetRenderViewport
* SDL_RenderGetWindow => SDL_GetRenderWindow
* SDL_RenderIsClipEnabled => SDL_IsRenderClipEnabled
* SDL_RenderSetClipRect => SDL_SetRenderClipRect
* SDL_RenderSetIntegerScale => SDL_SetRenderIntegerScale
* SDL_RenderSetLogicalSize => SDL_SetRenderLogicalSize
* SDL_RenderSetScale => SDL_SetRenderScale
* SDL_RenderSetVSync => SDL_SetRenderVSync
* SDL_RenderSetViewport => SDL_SetRenderViewport
* SDL_RenderTargetSupported => SDL_IsRenderTargetSupported

## SDL_rwops.h

The following macros have been renamed:
Expand Down
2 changes: 1 addition & 1 deletion include/SDL3/SDL_blendmode.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ extern "C" {
#endif

/**
* \brief The blend mode used in SDL_RenderCopy() and drawing operations.
* \brief The blend mode used in SDL_RenderTexture() and drawing operations.
*/
typedef enum
{
Expand Down
2 changes: 1 addition & 1 deletion include/SDL3/SDL_hints.h
Original file line number Diff line number Diff line change
Expand Up @@ -1400,7 +1400,7 @@ extern "C" {
#define SDL_HINT_RENDER_DRIVER "SDL_RENDER_DRIVER"

/**
* \brief A variable controlling the scaling policy for SDL_RenderSetLogicalSize.
* \brief A variable controlling the scaling policy for SDL_SetRenderLogicalSize.
*
* This variable can be set to the following values:
* "0" or "letterbox" - Uses letterbox/sidebars to fit the entire rendering on screen
Expand Down
68 changes: 68 additions & 0 deletions include/SDL3/SDL_oldnames.h
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,40 @@
#define __MACOSX__ __MACOS__
#endif

/* ##SDL_render.h */
#define SDL_RenderCopy SDL_RenderTexture
#define SDL_RenderCopyEx SDL_RenderTextureRotated
#define SDL_RenderCopyExF SDL_RenderTextureRotatedF
#define SDL_RenderCopyF SDL_RenderTextureF
#define SDL_RenderDrawLine SDL_RenderLine
#define SDL_RenderDrawLineF SDL_RenderLineF
#define SDL_RenderDrawLines SDL_RenderLines
#define SDL_RenderDrawLinesF SDL_RenderLinesF
#define SDL_RenderDrawPoint SDL_RenderPoint
#define SDL_RenderDrawPointF SDL_RenderPointF
#define SDL_RenderDrawPoints SDL_RenderPoints
#define SDL_RenderDrawPointsF SDL_RenderPointsF
#define SDL_RenderDrawRect SDL_RenderRect
#define SDL_RenderDrawRectF SDL_RenderRectF
#define SDL_RenderDrawRects SDL_RenderRects
#define SDL_RenderDrawRectsF SDL_RenderRectsF
#define SDL_RenderGetClipRect SDL_GetRenderClipRect
#define SDL_RenderGetIntegerScale SDL_GetRenderIntegerScale
#define SDL_RenderGetLogicalSize SDL_GetRenderLogicalSize
#define SDL_RenderGetMetalCommandEncoder SDL_GetRenderMetalCommandEncoder
#define SDL_RenderGetMetalLayer SDL_GetRenderMetalLayer
#define SDL_RenderGetScale SDL_GetRenderScale
#define SDL_RenderGetViewport SDL_GetRenderViewport
#define SDL_RenderGetWindow SDL_GetRenderWindow
#define SDL_RenderIsClipEnabled SDL_IsRenderClipEnabled
#define SDL_RenderSetClipRect SDL_SetRenderClipRect
#define SDL_RenderSetIntegerScale SDL_SetRenderIntegerScale
#define SDL_RenderSetLogicalSize SDL_SetRenderLogicalSize
#define SDL_RenderSetScale SDL_SetRenderScale
#define SDL_RenderSetVSync SDL_SetRenderVSync
#define SDL_RenderSetViewport SDL_SetRenderViewport
#define SDL_RenderTargetSupported SDL_IsRenderTargetSupported

/* ##SDL_rwops.h */
#define RW_SEEK_CUR SDL_RW_SEEK_CUR
#define RW_SEEK_END SDL_RW_SEEK_END
Expand Down Expand Up @@ -242,6 +276,40 @@
#define __MACOSX__ __MACOSX___renamed___MACOS__
#endif

/* ##SDL_render.h */
#define SDL_RenderCopy SDL_RenderCopy_renamed_SDL_RenderTexture
#define SDL_RenderCopyEx SDL_RenderCopyEx_renamed_SDL_RenderTextureRotated
#define SDL_RenderCopyExF SDL_RenderCopyExF_renamed_SDL_RenderTextureRotatedF
#define SDL_RenderCopyF SDL_RenderCopyF_renamed_SDL_RenderTextureF
#define SDL_RenderDrawLine SDL_RenderDrawLine_renamed_SDL_RenderLine
#define SDL_RenderDrawLineF SDL_RenderDrawLineF_renamed_SDL_RenderLineF
#define SDL_RenderDrawLines SDL_RenderDrawLines_renamed_SDL_RenderLines
#define SDL_RenderDrawLinesF SDL_RenderDrawLinesF_renamed_SDL_RenderLinesF
#define SDL_RenderDrawPoint SDL_RenderDrawPoint_renamed_SDL_RenderPoint
#define SDL_RenderDrawPointF SDL_RenderDrawPointF_renamed_SDL_RenderPointF
#define SDL_RenderDrawPoints SDL_RenderDrawPoints_renamed_SDL_RenderPoints
#define SDL_RenderDrawPointsF SDL_RenderDrawPointsF_renamed_SDL_RenderPointsF
#define SDL_RenderDrawRect SDL_RenderDrawRect_renamed_SDL_RenderRect
#define SDL_RenderDrawRectF SDL_RenderDrawRectF_renamed_SDL_RenderRectF
#define SDL_RenderDrawRects SDL_RenderDrawRects_renamed_SDL_RenderRects
#define SDL_RenderDrawRectsF SDL_RenderDrawRectsF_renamed_SDL_RenderRectsF
#define SDL_RenderGetClipRect SDL_RenderGetClipRect_renamed_SDL_GetRenderClipRect
#define SDL_RenderGetIntegerScale SDL_RenderGetIntegerScale_renamed_SDL_GetRenderIntegerScale
#define SDL_RenderGetLogicalSize SDL_RenderGetLogicalSize_renamed_SDL_GetRenderLogicalSize
#define SDL_RenderGetMetalCommandEncoder SDL_RenderGetMetalCommandEncoder_renamed_SDL_GetRenderMetalCommandEncoder
#define SDL_RenderGetMetalLayer SDL_RenderGetMetalLayer_renamed_SDL_GetRenderMetalLayer
#define SDL_RenderGetScale SDL_RenderGetScale_renamed_SDL_GetRenderScale
#define SDL_RenderGetViewport SDL_RenderGetViewport_renamed_SDL_GetRenderViewport
#define SDL_RenderGetWindow SDL_RenderGetWindow_renamed_SDL_GetRenderWindow
#define SDL_RenderIsClipEnabled SDL_RenderIsClipEnabled_renamed_SDL_IsRenderClipEnabled
#define SDL_RenderSetClipRect SDL_RenderSetClipRect_renamed_SDL_SetRenderClipRect
#define SDL_RenderSetIntegerScale SDL_RenderSetIntegerScale_renamed_SDL_SetRenderIntegerScale
#define SDL_RenderSetLogicalSize SDL_RenderSetLogicalSize_renamed_SDL_SetRenderLogicalSize
#define SDL_RenderSetScale SDL_RenderSetScale_renamed_SDL_SetRenderScale
#define SDL_RenderSetVSync SDL_RenderSetVSync_renamed_SDL_SetRenderVSync
#define SDL_RenderSetViewport SDL_RenderSetViewport_renamed_SDL_SetRenderViewport
#define SDL_RenderTargetSupported SDL_RenderTargetSupported_renamed_SDL_IsRenderTargetSupported

/* ##SDL_rwops.h */
#define RW_SEEK_CUR RW_SEEK_CUR_renamed_SDL_RW_SEEK_CUR
#define RW_SEEK_END RW_SEEK_END_renamed_SDL_RW_SEEK_END
Expand Down
Loading

0 comments on commit 0d54115

Please sign in to comment.