Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDL API renaming: SDL_render.h #6883

Closed
slouken opened this issue Dec 23, 2022 · 4 comments
Closed

SDL API renaming: SDL_render.h #6883

slouken opened this issue Dec 23, 2022 · 4 comments

Comments

@slouken
Copy link
Collaborator

slouken commented Dec 23, 2022

Here are proposed name changes for functions in SDL_render.h, per discussion in #6569

SDL_CreateRenderer
SDL_CreateSoftwareRenderer
SDL_CreateTexture
SDL_CreateTextureFromSurface
SDL_CreateWindowAndRenderer
SDL_DestroyRenderer
SDL_DestroyTexture
SDL_GL_BindTexture
SDL_GL_UnbindTexture
SDL_GetNumRenderDrivers
SDL_GetRenderDrawBlendMode
SDL_GetRenderDrawColor
SDL_GetRenderDriver
SDL_GetRenderTarget
SDL_GetRenderer
SDL_GetRendererInfo
SDL_GetRendererOutputSize
SDL_GetTextureAlphaMod
SDL_GetTextureBlendMode
SDL_GetTextureColorMod
SDL_GetTextureScaleMode
SDL_GetTextureUserData
SDL_LockTexture
SDL_LockTextureToSurface
SDL_QueryTexture
SDL_RenderClear
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_RenderFillRect
SDL_RenderFillRectF
SDL_RenderFillRects
SDL_RenderFillRectsF
SDL_RenderFlush
SDL_RenderGeometry
SDL_RenderGeometryRaw
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_RenderLogicalToWindow
SDL_RenderPresent
SDL_RenderReadPixels
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_RenderWindowToLogical
SDL_SetRenderDrawBlendMode
SDL_SetRenderDrawColor
SDL_SetRenderTarget
SDL_SetTextureAlphaMod
SDL_SetTextureBlendMode
SDL_SetTextureColorMod
SDL_SetTextureScaleMode
SDL_SetTextureUserData
SDL_UnlockTexture
SDL_UpdateNVTexture
SDL_UpdateTexture
SDL_UpdateYUVTexture

@libsdl-org/a-team for discussion?

@icculus
Copy link
Collaborator

icculus commented Dec 27, 2022

Do we want SDL_RenderDrawPoints (etc) to be SDL_DrawRenderPoints? That seems more consistent but also extremely redundant.

Maybe just SDL_DrawPoints? Or SDL_RenderPoints might be better.

I always thought SDL_RenderCopy was a weird name choice, doubly so with the extended version doing rotating and scaling, but if that sort of thing is out of scope for the basic renaming, we can talk about that elsewhere.

@slouken
Copy link
Collaborator Author

slouken commented Dec 27, 2022

I was going back and forth on this myself, but SDL_DrawRenderPoints seemed weird. I like SDL_RenderPoints though.

Maybe this? I'm also still waffling on whether we want int versions of the APIs. If we don't, this is a good time to remove them.

SDL_RenderCopy => SDL_RenderTexture
SDL_RenderCopyEx => REMOVED
SDL_RenderCopyExF => SDL_RenderTextureRotated
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_RenderFillRect, etc. => NOCHANGE

@icculus
Copy link
Collaborator

icculus commented Dec 27, 2022

That's good for me.

I think we could maybe fold all the texture draws into a single function, too, but that can wait for later.

@icculus
Copy link
Collaborator

icculus commented Dec 29, 2022

(I'm just reopening things when there's a nitpick instead of starting a new issue.)

Some of these are in SDL_system.h:

extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
extern DECLSPEC ID3D11Device* SDLCALL SDL_RenderGetD3D11Device(SDL_Renderer * renderer);

@icculus icculus reopened this Dec 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants