/** * @file dx.cpp * * Implementation of functions setting up the graphics pipeline. */ #include "dx.h" #include #include "engine.h" #include "options.h" #include "storm/storm.h" #include "utils/display.h" #include "utils/log.hpp" #ifdef __3DS__ #include <3ds.h> #endif namespace devilution { int sgdwLockCount; #ifdef _DEBUG int locktbl[256]; #endif static CCritSect sgMemCrit; int refreshDelay; SDL_Renderer *renderer; SDL_Texture *texture; /** Currently active palette */ SDL_Palette *palette; unsigned int pal_surface_palette_version = 0; /** 24-bit renderer texture surface */ SDL_Surface *renderer_texture_surface = nullptr; /** 8-bit surface that we render to */ SDL_Surface *pal_surface; /** Whether we render directly to the screen surface, i.e. `pal_surface == GetOutputSurface()` */ bool RenderDirectlyToOutputSurface; namespace { bool CanRenderDirectlyToOutputSurface() { #ifdef USE_SDL1 #ifdef SDL1_FORCE_DIRECT_RENDER return true; #else auto *outputSurface = GetOutputSurface(); return ((outputSurface->flags & SDL_DOUBLEBUF) == SDL_DOUBLEBUF && outputSurface->w == gnScreenWidth && outputSurface->h == gnScreenHeight && outputSurface->format->BitsPerPixel == 8); #endif #else // !USE_SDL1 return false; #endif } } // namespace static void dx_create_back_buffer() { if (CanRenderDirectlyToOutputSurface()) { Log("{}", "Will render directly to the SDL output surface"); pal_surface = GetOutputSurface(); RenderDirectlyToOutputSurface = true; } else { pal_surface = SDL_CreateRGBSurfaceWithFormat( /*flags=*/0, /*width=*/gnScreenWidth, /*height=*/gnScreenHeight, /*depth=*/8, SDL_PIXELFORMAT_INDEX8); if (pal_surface == nullptr) { ErrSdl(); } } #ifndef USE_SDL1 // In SDL2, `pal_surface` points to the global `palette`. if (SDL_SetSurfacePalette(pal_surface, palette) < 0) ErrSdl(); #else // In SDL1, `pal_surface` owns its palette and we must update it every // time the global `palette` is changed. No need to do anything here as // the global `palette` doesn't have any colors set yet. #endif pal_surface_palette_version = 1; } static void dx_create_primary_surface() { #ifndef USE_SDL1 if (renderer != nullptr) { int width, height; SDL_RenderGetLogicalSize(renderer, &width, &height); Uint32 format; if (SDL_QueryTexture(texture, &format, nullptr, nullptr, nullptr) < 0) ErrSdl(); renderer_texture_surface = SDL_CreateRGBSurfaceWithFormat(0, width, height, SDL_BITSPERPIXEL(format), format); } #endif if (GetOutputSurface() == nullptr) { ErrSdl(); } } void dx_init() { #ifndef USE_SDL1 SDL_RaiseWindow(ghMainWnd); SDL_ShowWindow(ghMainWnd); #endif dx_create_primary_surface(); palette_init(); dx_create_back_buffer(); } static void lock_buf_priv() { sgMemCrit.Enter(); if (sgdwLockCount != 0) { sgdwLockCount++; return; } sgdwLockCount++; } void lock_buf(BYTE idx) { #ifdef _DEBUG ++locktbl[idx]; #endif lock_buf_priv(); } static void unlock_buf_priv() { if (sgdwLockCount == 0) app_fatal("draw main unlock error"); sgdwLockCount--; sgMemCrit.Leave(); } void unlock_buf(BYTE idx) { #ifdef _DEBUG if (locktbl[idx] == 0) app_fatal("Draw lock underflow: 0x%x", idx); --locktbl[idx]; #endif unlock_buf_priv(); } CelOutputBuffer GlobalBackBuffer() { if (sgdwLockCount == 0) { Log("WARNING: Trying to obtain GlobalBackBuffer() without holding a lock"); return CelOutputBuffer(); } return CelOutputBuffer(pal_surface, SDL_Rect { 0, 0, gnScreenWidth, gnScreenHeight }); } void dx_cleanup() { #ifndef USE_SDL1 if (ghMainWnd != nullptr) SDL_HideWindow(ghMainWnd); #endif sgMemCrit.Enter(); sgdwLockCount = 0; sgMemCrit.Leave(); if (pal_surface == nullptr) return; SDL_FreeSurface(pal_surface); pal_surface = nullptr; SDL_FreePalette(palette); SDL_FreeSurface(renderer_texture_surface); #ifndef USE_SDL1 SDL_DestroyTexture(texture); SDL_DestroyRenderer(renderer); #endif SDL_DestroyWindow(ghMainWnd); } void dx_reinit() { #ifdef USE_SDL1 Uint32 flags = ghMainWnd->flags ^ SDL_FULLSCREEN; if (!IsFullScreen()) { flags |= SDL_FULLSCREEN; } ghMainWnd = SDL_SetVideoMode(0, 0, 0, flags); if (ghMainWnd == NULL) { ErrSdl(); } #else Uint32 flags = 0; if (!IsFullScreen()) { flags = renderer != nullptr ? SDL_WINDOW_FULLSCREEN_DESKTOP : SDL_WINDOW_FULLSCREEN; } if (SDL_SetWindowFullscreen(ghMainWnd, flags) != 0) { ErrSdl(); } #endif force_redraw = 255; } void InitPalette() { palette = SDL_AllocPalette(256); if (palette == nullptr) { ErrSdl(); } } void BltFast(SDL_Rect *src_rect, SDL_Rect *dst_rect) { if (RenderDirectlyToOutputSurface) return; Blit(pal_surface, src_rect, dst_rect); } void Blit(SDL_Surface *src, SDL_Rect *src_rect, SDL_Rect *dst_rect) { SDL_Surface *dst = GetOutputSurface(); #ifndef USE_SDL1 if (SDL_BlitSurface(src, src_rect, dst, dst_rect) < 0) ErrSdl(); #else if (!OutputRequiresScaling()) { if (SDL_BlitSurface(src, src_rect, dst, dst_rect) < 0) ErrSdl(); return; } SDL_Rect scaled_dst_rect; if (dst_rect != NULL) { scaled_dst_rect = *dst_rect; ScaleOutputRect(&scaled_dst_rect); dst_rect = &scaled_dst_rect; } // Same pixel format: We can call BlitScaled directly. if (SDLBackport_PixelFormatFormatEq(src->format, dst->format)) { if (SDL_BlitScaled(src, src_rect, dst, dst_rect) < 0) ErrSdl(); return; } // If the surface has a color key, we must stretch first and can then call BlitSurface. if (SDL_HasColorKey(src)) { SDL_Surface *stretched = SDL_CreateRGBSurface(SDL_SWSURFACE, dst_rect->w, dst_rect->h, src->format->BitsPerPixel, src->format->Rmask, src->format->Gmask, src->format->BitsPerPixel, src->format->Amask); SDL_SetColorKey(stretched, SDL_SRCCOLORKEY, src->format->colorkey); if (src->format->palette != NULL) SDL_SetPalette(stretched, SDL_LOGPAL, src->format->palette->colors, 0, src->format->palette->ncolors); SDL_Rect stretched_rect = { 0, 0, dst_rect->w, dst_rect->h }; if (SDL_SoftStretch(src, src_rect, stretched, &stretched_rect) < 0 || SDL_BlitSurface(stretched, &stretched_rect, dst, dst_rect) < 0) { SDL_FreeSurface(stretched); ErrSdl(); } SDL_FreeSurface(stretched); return; } // A surface with a non-output pixel format but without a color key needs scaling. // We can convert the format and then call BlitScaled. SDL_Surface *converted = SDL_ConvertSurface(src, dst->format, 0); if (SDL_BlitScaled(converted, src_rect, dst, dst_rect) < 0) { SDL_FreeSurface(converted); ErrSdl(); } SDL_FreeSurface(converted); #endif } /** * @brief Limit FPS to avoid high CPU load, use when v-sync isn't available */ void LimitFrameRate() { if (!sgOptions.Graphics.bFPSLimit) return; static uint32_t frameDeadline; uint32_t tc = SDL_GetTicks() * 1000; uint32_t v = 0; if (frameDeadline > tc) { v = tc % refreshDelay; SDL_Delay(v / 1000 + 1); // ceil } frameDeadline = tc + v + refreshDelay; } void RenderPresent() { SDL_Surface *surface = GetOutputSurface(); if (!gbActive) { LimitFrameRate(); return; } #ifndef USE_SDL1 if (renderer != nullptr) { if (SDL_UpdateTexture(texture, nullptr, surface->pixels, surface->pitch) <= -1) { //pitch is 2560 ErrSdl(); } // Clear buffer to avoid artifacts in case the window was resized if (SDL_SetRenderDrawColor(renderer, 0, 0, 0, 255) <= -1) { // TODO only do this if window was resized ErrSdl(); } if (SDL_RenderClear(renderer) <= -1) { ErrSdl(); } if (SDL_RenderCopy(renderer, texture, nullptr, nullptr) <= -1) { ErrSdl(); } SDL_RenderPresent(renderer); if (!sgOptions.Graphics.bVSync) { LimitFrameRate(); } } else { if (SDL_UpdateWindowSurface(ghMainWnd) <= -1) { ErrSdl(); } LimitFrameRate(); } #else if (SDL_Flip(surface) <= -1) { ErrSdl(); } if (RenderDirectlyToOutputSurface) pal_surface = GetOutputSurface(); LimitFrameRate(); #endif } void PaletteGetEntries(DWORD dwNumEntries, SDL_Color *lpEntries) { for (DWORD i = 0; i < dwNumEntries; i++) { lpEntries[i] = system_palette[i]; } } } // namespace devilution