Aerofoil/GpCommon/IGpDisplayDriver.h

#pragma once

#include "CoreDefs.h"
#include "GpPixelFormat.h"
#include "EGpStandardCursor.h"

#include <stdint.h>
#include <stddef.h>

struct IGpDisplayDriverSurface;
struct IGpCursor;
struct IGpPrefsHandler;
struct GpDisplayDriverProperties;

struct GpDisplayDriverSurfaceEffects
{
	GpDisplayDriverSurfaceEffects();

	bool m_darken;
	bool m_flicker;
	int32_t m_flickerAxisX;
	int32_t m_flickerAxisY;
	int32_t m_flickerStartThreshold;
	int32_t m_flickerEndThreshold;
	float m_desaturation;
};

// Display drivers are responsible for timing and calling the game tick function.
struct IGpDisplayDriver
{
	typedef void (*SurfaceInvalidateCallback_t) (void *context);

	GP_ASYNCIFY_PARANOID_VIRTUAL bool Init() GP_ASYNCIFY_PARANOID_PURE;
	GP_ASYNCIFY_PARANOID_VIRTUAL void ServeTicks(int tickCount) GP_ASYNCIFY_PARANOID_PURE;
	virtual void ForceSync() = 0;
	GP_ASYNCIFY_PARANOID_VIRTUAL void Shutdown() GP_ASYNCIFY_PARANOID_PURE;

	// Returns the initial resolution before any display resolution events are posted
	virtual void GetInitialDisplayResolution(unsigned int *width, unsigned int *height) = 0;

	virtual IGpDisplayDriverSurface *CreateSurface(size_t width, size_t height, size_t pitch, GpPixelFormat_t pixelFormat, SurfaceInvalidateCallback_t invalidateCallback, void *invalidateContext) = 0;
	virtual void DrawSurface(IGpDisplayDriverSurface *surface, int32_t x, int32_t y, size_t width, size_t height, const GpDisplayDriverSurfaceEffects *effects) = 0;

	GP_ASYNCIFY_PARANOID_VIRTUAL IGpCursor *CreateBWCursor(size_t width, size_t height, const void *pixelData, const void *maskData, size_t hotSpotX, size_t hotSpotY) GP_ASYNCIFY_PARANOID_PURE;
	GP_ASYNCIFY_PARANOID_VIRTUAL IGpCursor *CreateColorCursor(size_t width, size_t height, const void *pixelDataRGBA, size_t hotSpotX, size_t hotSpotY) GP_ASYNCIFY_PARANOID_PURE;

	virtual void SetCursor(IGpCursor *cursor) = 0;
	virtual void SetStandardCursor(EGpStandardCursor_t standardCursor) = 0;

	virtual void UpdatePalette(const void *paletteData) = 0;

	virtual void SetBackgroundColor(uint8_t r, uint8_t g, uint8_t b, uint8_t a) = 0;
	virtual void SetBackgroundDarkenEffect(bool isDark) = 0;

	virtual void SetUseICCProfile(bool useICCProfile) = 0;

	virtual void RequestToggleFullScreen(uint32_t timestamp) = 0;
	virtual void RequestResetVirtualResolution() = 0;

	virtual bool IsFullScreen() const = 0;

	virtual const GpDisplayDriverProperties &GetProperties() const = 0;
	virtual IGpPrefsHandler *GetPrefsHandler() const = 0;
};

inline GpDisplayDriverSurfaceEffects::GpDisplayDriverSurfaceEffects()
	: m_darken(false)
	, m_flicker(false)
	, m_flickerAxisX(0)
	, m_flickerAxisY(0)
	, m_flickerStartThreshold(0)
	, m_flickerEndThreshold(0)
	, m_desaturation(0)
{
}