qzdoom/src/rendering/v_video.h

395 lines
11 KiB
C
Raw Normal View History

2016-03-01 15:47:10 +00:00
/*
** v_video.h
**
**---------------------------------------------------------------------------
** Copyright 1998-2008 Randy Heit
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions
** are met:
**
** 1. Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** 2. Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in the
** documentation and/or other materials provided with the distribution.
** 3. The name of the author may not be used to endorse or promote products
** derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
** THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**---------------------------------------------------------------------------
**
*/
#ifndef __V_VIDEO_H__
#define __V_VIDEO_H__
#include <functional>
2016-03-01 15:47:10 +00:00
#include "doomtype.h"
#include "vectors.h"
2016-03-01 15:47:10 +00:00
#include "doomdef.h"
#include "m_png.h"
2016-03-01 15:47:10 +00:00
#include "dobject.h"
#include "renderstyle.h"
2016-03-01 15:47:10 +00:00
#include "c_cvars.h"
#include "v_colortables.h"
#include "v_2ddrawer.h"
2020-04-11 17:46:57 +00:00
2018-10-28 22:32:13 +00:00
#include "hwrenderer/dynlights/hw_shadowmap.h"
2016-03-01 15:47:10 +00:00
static const int VID_MIN_WIDTH = 320;
static const int VID_MIN_HEIGHT = 200;
static const int VID_MIN_UI_WIDTH = 640;
static const int VID_MIN_UI_HEIGHT = 400;
2020-04-11 17:46:57 +00:00
class player_t;
struct sector_t;
struct FPortalSceneState;
class FSkyVertexBuffer;
class IIndexBuffer;
class IVertexBuffer;
class IDataBuffer;
class FFlatVertexBuffer;
class HWViewpointBuffer;
class FLightBuffer;
struct HWDrawInfo;
class FMaterial;
class FGameTexture;
class FRenderState;
enum EHWCaps
{
// [BB] Added texture compression flags.
RFL_TEXTURE_COMPRESSION = 1,
RFL_TEXTURE_COMPRESSION_S3TC = 2,
RFL_SHADER_STORAGE_BUFFER = 4,
RFL_BUFFER_STORAGE = 8,
RFL_NO_CLIP_PLANES = 32,
RFL_INVALIDATE_BUFFER = 64,
RFL_DEBUG = 128,
};
2018-05-12 15:23:56 +00:00
struct IntRect
{
int left, top;
int width, height;
void Offset(int xofs, int yofs)
{
left += xofs;
top += yofs;
}
void AddToRect(int x, int y)
{
if (x < left)
left = x;
if (x > left + width)
width = x - left;
if (y < top)
top = y;
if (y > top + height)
height = y - top;
}
2018-05-12 15:23:56 +00:00
};
extern int DisplayWidth, DisplayHeight;
2016-03-01 15:47:10 +00:00
void V_UpdateModeSize (int width, int height);
void V_OutputResized (int width, int height);
2016-03-01 15:47:10 +00:00
EXTERN_CVAR(Int, vid_rendermode)
EXTERN_CVAR(Bool, vid_fullscreen)
2018-07-28 08:05:16 +00:00
EXTERN_CVAR(Int, win_x)
EXTERN_CVAR(Int, win_y)
EXTERN_CVAR(Int, win_w)
EXTERN_CVAR(Int, win_h)
EXTERN_CVAR(Bool, win_maximized)
2018-07-28 08:05:16 +00:00
inline bool V_IsHardwareRenderer()
{
return vid_rendermode == 4;
}
inline bool V_IsSoftwareRenderer()
{
return vid_rendermode < 2;
}
inline bool V_IsPolyRenderer()
{
return vid_rendermode == 2 || vid_rendermode == 3;
}
inline bool V_IsTrueColor()
{
return vid_rendermode == 1 || vid_rendermode == 3 || vid_rendermode == 4;
}
struct FColormap;
class FileWriter;
enum FTextureFormat : uint32_t;
class FModelRenderer;
struct SamplerUniform;
2016-03-01 15:47:10 +00:00
//
// VIDEO
//
//
class DCanvas
2016-03-01 15:47:10 +00:00
{
public:
DCanvas (int width, int height, bool bgra);
~DCanvas ();
void Resize(int width, int height, bool optimizepitch = true);
2016-03-01 15:47:10 +00:00
// Member variable access
inline uint8_t *GetPixels () const { return Pixels.Data(); }
2016-03-01 15:47:10 +00:00
inline int GetWidth () const { return Width; }
inline int GetHeight () const { return Height; }
inline int GetPitch () const { return Pitch; }
inline bool IsBgra() const { return Bgra; }
2016-03-01 15:47:10 +00:00
protected:
TArray<uint8_t> Pixels;
2016-03-01 15:47:10 +00:00
int Width;
int Height;
int Pitch;
bool Bgra;
2016-03-01 15:47:10 +00:00
};
class IHardwareTexture;
class FTexture;
2016-03-01 15:47:10 +00:00
class DFrameBuffer
2016-03-01 15:47:10 +00:00
{
2020-04-11 17:46:57 +00:00
public:
F2DDrawer m2DDrawer;
private:
int Width = 0;
int Height = 0;
public:
// Hardware render state that needs to be exposed to the API independent part of the renderer. For ease of access this is stored in the base class.
int hwcaps = 0; // Capability flags
float glslversion = 0; // This is here so that the differences between old OpenGL and new OpenGL/Vulkan can be handled by platform independent code.
int instack[2] = { 0,0 }; // this is globally maintained state for portal recursion avoidance.
int stencilValue = 0; // Global stencil test value
unsigned int uniformblockalignment = 256; // Hardware dependent uniform buffer alignment.
unsigned int maxuniformblock = 65536;
const char *vendorstring; // We have to account for some issues with particular vendors.
FPortalSceneState *mPortalState; // global portal state.
FSkyVertexBuffer *mSkyData = nullptr; // the sky vertex buffer
FFlatVertexBuffer *mVertexData = nullptr; // Global vertex data
HWViewpointBuffer *mViewpoints = nullptr; // Viewpoint render data.
FLightBuffer *mLights = nullptr; // Dynamic lights
2018-10-28 22:32:13 +00:00
IShadowMap mShadowMap;
2018-05-12 15:23:56 +00:00
IntRect mScreenViewport;
IntRect mSceneViewport;
IntRect mOutputLetterbox;
float mSceneClearColor[4];
2018-05-12 15:23:56 +00:00
2016-03-01 15:47:10 +00:00
public:
DFrameBuffer (int width=1, int height=1);
virtual ~DFrameBuffer();
virtual void InitializeState() = 0; // For stuff that needs 'screen' set.
virtual bool IsVulkan() { return false; }
2019-07-24 20:13:00 +00:00
virtual bool IsPoly() { return false; }
virtual DCanvas* GetCanvas() { return nullptr; }
2016-03-01 15:47:10 +00:00
void SetSize(int width, int height);
void SetVirtualSize(int width, int height)
{
Width = width;
Height = height;
}
inline int GetWidth() const { return Width; }
inline int GetHeight() const { return Height; }
FVector2 SceneScale() const
{
return { mSceneViewport.width / (float)mScreenViewport.width, mSceneViewport.height / (float)mScreenViewport.height };
}
FVector2 SceneOffset() const
{
return { mSceneViewport.left / (float)mScreenViewport.width, mSceneViewport.top / (float)mScreenViewport.height };
}
// Make the surface visible.
virtual void Update ();
2016-03-01 15:47:10 +00:00
// Stores the palette with flash blended in into 256 dwords
// Mark the palette as changed. It will be updated on the next Update().
virtual void UpdatePalette() {}
2016-03-01 15:47:10 +00:00
virtual void SetGamma() {}
2016-03-01 15:47:10 +00:00
// Returns true if running fullscreen.
virtual bool IsFullscreen () = 0;
virtual void ToggleFullscreen(bool yes) {}
2016-03-01 15:47:10 +00:00
// Changes the vsync setting, if supported by the device.
virtual void SetVSync (bool vsync);
// Delete any resources that need to be deleted after restarting with a different IWAD
virtual void CleanForRestart() {}
virtual void SetTextureFilterMode() {}
2018-12-11 19:26:33 +00:00
virtual IHardwareTexture *CreateHardwareTexture() { return nullptr; }
virtual void PrecacheMaterial(FMaterial *mat, int translation) {}
virtual FModelRenderer *CreateModelRenderer(int mli) { return nullptr; }
virtual FMaterial* CreateMaterial(FGameTexture* tex, int scaleflags);
virtual void TextureFilterChanged() {}
virtual void BeginFrame() {}
virtual void SetWindowSize(int w, int h) {}
virtual void StartPrecaching() {}
virtual FRenderState* RenderState() { return nullptr; }
2016-03-01 15:47:10 +00:00
2018-05-12 15:23:56 +00:00
virtual int GetClientWidth() = 0;
virtual int GetClientHeight() = 0;
virtual void BlurScene(float amount) {}
2018-06-12 08:58:32 +00:00
// Interface to hardware rendering resources
virtual IVertexBuffer *CreateVertexBuffer() { return nullptr; }
virtual IIndexBuffer *CreateIndexBuffer() { return nullptr; }
2019-04-18 20:01:42 +00:00
virtual IDataBuffer *CreateDataBuffer(int bindingpoint, bool ssbo, bool needsresize) { return nullptr; }
bool BuffersArePersistent() { return !!(hwcaps & RFL_BUFFER_STORAGE); }
2018-05-12 15:23:56 +00:00
// Begin/End 2D drawing operations.
2020-04-11 17:46:57 +00:00
void Begin2D()
{
m2DDrawer.Begin();
m2DDrawer.SetSize(Width, Height);
}
void End2D() { m2DDrawer.End(); }
2016-03-01 15:47:10 +00:00
void End2DAndUpdate()
{
DrawRateStuff();
2020-04-11 17:46:57 +00:00
m2DDrawer.End();
Update();
}
// This is overridable in case Vulkan does it differently.
virtual bool RenderTextureIsFlipped() const
{
return true;
}
2016-03-01 15:47:10 +00:00
// Report a game restart
void SetClearColor(int color);
virtual uint32_t GetCaps();
virtual int Backend() { return 0; }
virtual const char* DeviceName() const { return "Unknown"; }
virtual void WriteSavePic(player_t *player, FileWriter *file, int width, int height);
virtual sector_t *RenderView(player_t *player) { return nullptr; }
virtual void AmbientOccludeScene(float m5) {}
virtual void FirstEye() {}
virtual void NextEye(int eyecount) {}
virtual void SetSceneRenderTarget(bool useSSAO) {}
virtual void UpdateShadowMap() {}
2016-03-01 15:47:10 +00:00
// Screen wiping
virtual FTexture *WipeStartScreen();
virtual FTexture *WipeEndScreen();
2016-03-01 15:47:10 +00:00
virtual void PostProcessScene(bool swscene, int fixedcm, const std::function<void()> &afterBloomDrawEndScene2D) { if (afterBloomDrawEndScene2D) afterBloomDrawEndScene2D(); }
void ScaleCoordsFromWindow(int16_t &x, int16_t &y);
2016-03-01 15:47:10 +00:00
uint64_t GetLastFPS() const { return LastCount; }
2016-03-01 15:47:10 +00:00
virtual void Draw2D() {}
void Clear2D() { m2DDrawer.Clear(); }
// Calculate gamma table
void CalcGamma(float gamma, uint8_t gammalookup[256]);
2018-06-03 11:59:40 +00:00
virtual void SetViewportRects(IntRect *bounds);
2018-05-12 15:23:56 +00:00
int ScreenToWindowX(int x);
int ScreenToWindowY(int y);
void FPSLimit();
// Retrieves a buffer containing image data for a screenshot.
// Hint: Pitch can be negative for upside-down images, in which case buffer
// points to the last row in the buffer, which will be the first row output.
virtual TArray<uint8_t> GetScreenshotBuffer(int &pitch, ESSType &color_type, float &gamma) { return TArray<uint8_t>(); }
static float GetZNear() { return 5.f; }
static float GetZFar() { return 65536.f; }
2016-09-14 21:38:11 +00:00
// The original size of the framebuffer as selected in the video menu.
uint64_t FrameTime = 0;
2016-09-14 21:38:11 +00:00
2016-03-01 15:47:10 +00:00
protected:
void DrawRateStuff ();
private:
uint64_t fpsLimitTime = 0;
uint64_t LastMS = 0, LastSec = 0, FrameCount = 0, LastCount = 0, LastTic = 0;
bool isIn2D = false;
2016-03-01 15:47:10 +00:00
};
// This is the screen updated by I_FinishUpdate.
extern DFrameBuffer *screen;
#define SCREENWIDTH (screen->GetWidth ())
#define SCREENHEIGHT (screen->GetHeight ())
#define SCREENPITCH (screen->GetPitch ())
EXTERN_CVAR (Float, Gamma)
// Allocates buffer screens, call before R_Init.
void V_InitScreenSize();
void V_InitScreen();
2016-03-01 15:47:10 +00:00
// Initializes graphics mode for the first time.
void V_Init2 ();
void V_Shutdown ();
class FScanner;
struct FScriptPosition;
2016-03-01 15:47:10 +00:00
2016-09-12 13:51:50 +00:00
inline bool IsRatioWidescreen(int ratio) { return (ratio & 3) != 0; }
2016-03-01 15:47:10 +00:00
#include "v_draw.h"
2016-03-01 15:47:10 +00:00
#endif // __V_VIDEO_H__