VirtualBox

source: vbox/trunk/src/VBox/Devices/Graphics/DevVGA-SVGA3d.h@ 86838

Last change on this file since 86838 was 86838, checked in by vboxsync, 4 years ago

Devices/Graphics: A couple of new commands; a more generic handler for creating a surface; cleaned saved state data for a surface; increased saved state version; possibility to build DX11 backend. bugref:9830
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.7 KB
Line 
1/* $Id: DevVGA-SVGA3d.h 86838 2020-11-09 23:16:50Z vboxsync $ */
2/** @file
3 * DevVMWare - VMWare SVGA device - 3D part.
4 */
5
6/*
7 * Copyright (C) 2013-2020 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef VBOX_INCLUDED_SRC_Graphics_DevVGA_SVGA3d_h
19#define VBOX_INCLUDED_SRC_Graphics_DevVGA_SVGA3d_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include "DevVGA-SVGA.h"
25
26
27/** Arbitrary limit */
28#define SVGA3D_MAX_SHADER_IDS 0x800
29/** D3D allows up to 8 texture stages. */
30#define SVGA3D_MAX_TEXTURE_STAGES 8
31/** Samplers: 16 Pixel Shader + 1 Displacement Map + 4 Vertex Shader */
32#define SVGA3D_MAX_SAMPLERS_PS 16
33#define SVGA3D_MAX_SAMPLERS_DMAP 1
34#define SVGA3D_MAX_SAMPLERS_VS 4
35#define SVGA3D_MAX_SAMPLERS (SVGA3D_MAX_SAMPLERS_PS + SVGA3D_MAX_SAMPLERS_DMAP + SVGA3D_MAX_SAMPLERS_VS)
36/** Arbitrary upper limit; seen 8 so far. */
37#define SVGA3D_MAX_LIGHTS 32
38/** Arbitrary upper limit; 2GB enough for 32768x16384*4. */
39#define SVGA3D_MAX_SURFACE_MEM_SIZE 0x80000000
40
41
42/**@def FLOAT_FMT_STR
43 * Format string bits to go with FLOAT_FMT_ARGS. */
44#define FLOAT_FMT_STR "%s%u.%06u"
45/** @def FLOAT_FMT_ARGS
46 * Format arguments for a float value, corresponding to FLOAT_FMT_STR.
47 * @param r The floating point value to format. */
48#define FLOAT_FMT_ARGS(r) (r) >= 0.0f ? "" : "-", (unsigned)RT_ABS(r), (unsigned)(RT_ABS((r) - (unsigned)(r)) * 1000000.0f)
49
50
51typedef enum VMSVGA3D_SURFACE_MAP
52{
53 VMSVGA3D_SURFACE_MAP_READ,
54 VMSVGA3D_SURFACE_MAP_WRITE,
55 VMSVGA3D_SURFACE_MAP_READ_WRITE,
56 VMSVGA3D_SURFACE_MAP_WRITE_DISCARD,
57} VMSVGA3D_SURFACE_MAP;
58
59typedef struct VMSVGA3D_MAPPED_SURFACE
60{
61 VMSVGA3D_SURFACE_MAP enmMapType;
62 SVGA3dBox box;
63 uint32_t cbPixel;
64 uint32_t cbRowPitch;
65 uint32_t cbDepthPitch;
66 void *pvData;
67} VMSVGA3D_MAPPED_SURFACE;
68
69#ifdef DUMP_BITMAPS
70void vmsvga3dMapWriteBmpFile(VMSVGA3D_MAPPED_SURFACE const *pMap, char const *pszPrefix);
71#endif
72
73/* DevVGA-SVGA.cpp: */
74void vmsvgaR33dSurfaceUpdateHeapBuffersOnFifoThread(PPDMDEVINS pDevIns, PVGASTATE pThis, PVGASTATECC pThisCC, uint32_t sid);
75
76
77/* DevVGA-SVGA3d-ogl.cpp & DevVGA-SVGA3d-win.cpp: */
78int vmsvga3dInit(PPDMDEVINS pDevIns, PVGASTATE pThis, PVGASTATECC pThisCC);
79int vmsvga3dPowerOn(PPDMDEVINS pDevIns, PVGASTATE pThis, PVGASTATECC pThisCC);
80int vmsvga3dLoadExec(PPDMDEVINS pDevIns, PVGASTATE pThis, PVGASTATECC pThisCC, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
81int vmsvga3dSaveExec(PPDMDEVINS pDevIns, PVGASTATECC pThisCC, PSSMHANDLE pSSM);
82int vmsvga3dTerminate(PVGASTATECC pThisCC);
83int vmsvga3dReset(PVGASTATECC pThisCC);
84void vmsvga3dUpdateHostScreenViewport(PVGASTATECC pThisCC, uint32_t idScreen, VMSVGAVIEWPORT const *pOldViewport);
85int vmsvga3dQueryCaps(PVGASTATECC pThisCC, uint32_t idx3dCaps, uint32_t *pu32Val);
86
87int vmsvga3dSurfaceDefine(PVGASTATECC pThisCC, uint32_t sid, SVGA3dSurfaceFlags surfaceFlags, SVGA3dSurfaceFormat format,
88 uint32_t multisampleCount, SVGA3dTextureFilter autogenFilter,
89 uint32_t cMipLevels, SVGA3dSize const *pMipLevel0Size);
90int vmsvga3dSurfaceDestroy(PVGASTATECC pThisCC, uint32_t sid);
91int vmsvga3dSurfaceCopy(PVGASTATECC pThisCC, SVGA3dSurfaceImageId dest, SVGA3dSurfaceImageId src,
92 uint32_t cCopyBoxes, SVGA3dCopyBox *pBox);
93int vmsvga3dSurfaceStretchBlt(PVGASTATE pThis, PVGASTATECC pThisCC,
94 SVGA3dSurfaceImageId const *pDstSfcImg, SVGA3dBox const *pDstBox,
95 SVGA3dSurfaceImageId const *pSrcSfcImg, SVGA3dBox const *pSrcBox, SVGA3dStretchBltMode enmMode);
96int vmsvga3dSurfaceDMA(PVGASTATE pThis, PVGASTATECC pThisCC, SVGAGuestImage guest, SVGA3dSurfaceImageId host, SVGA3dTransferType transfer, uint32_t cCopyBoxes, SVGA3dCopyBox *pBoxes);
97int vmsvga3dSurfaceBlitToScreen(PVGASTATE pThis, PVGASTATECC pThisCC, uint32_t dest, SVGASignedRect destRect, SVGA3dSurfaceImageId srcImage, SVGASignedRect srcRect, uint32_t cRects, SVGASignedRect *pRect);
98
99int vmsvga3dContextDefine(PVGASTATECC pThisCC, uint32_t cid);
100int vmsvga3dContextDestroy(PVGASTATECC pThisCC, uint32_t cid);
101
102int vmsvga3dChangeMode(PVGASTATECC pThisCC);
103
104int vmsvga3dDefineScreen(PVGASTATE pThis, PVGASTATECC pThisCC, VMSVGASCREENOBJECT *pScreen);
105int vmsvga3dDestroyScreen(PVGASTATECC pThisCC, VMSVGASCREENOBJECT *pScreen);
106
107int vmsvga3dSetTransform(PVGASTATECC pThisCC, uint32_t cid, SVGA3dTransformType type, float matrix[16]);
108int vmsvga3dSetZRange(PVGASTATECC pThisCC, uint32_t cid, SVGA3dZRange zRange);
109int vmsvga3dSetRenderState(PVGASTATECC pThisCC, uint32_t cid, uint32_t cRenderStates, SVGA3dRenderState *pRenderState);
110int vmsvga3dSetRenderTarget(PVGASTATECC pThisCC, uint32_t cid, SVGA3dRenderTargetType type, SVGA3dSurfaceImageId target);
111int vmsvga3dSetTextureState(PVGASTATECC pThisCC, uint32_t cid, uint32_t cTextureStates, SVGA3dTextureState *pTextureState);
112int vmsvga3dSetMaterial(PVGASTATECC pThisCC, uint32_t cid, SVGA3dFace face, SVGA3dMaterial *pMaterial);
113int vmsvga3dSetLightData(PVGASTATECC pThisCC, uint32_t cid, uint32_t index, SVGA3dLightData *pData);
114int vmsvga3dSetLightEnabled(PVGASTATECC pThisCC, uint32_t cid, uint32_t index, uint32_t enabled);
115int vmsvga3dSetViewPort(PVGASTATECC pThisCC, uint32_t cid, SVGA3dRect *pRect);
116int vmsvga3dSetClipPlane(PVGASTATECC pThisCC, uint32_t cid, uint32_t index, float plane[4]);
117int vmsvga3dCommandClear(PVGASTATECC pThisCC, uint32_t cid, SVGA3dClearFlag clearFlag, uint32_t color, float depth, uint32_t stencil, uint32_t cRects, SVGA3dRect *pRect);
118int vmsvga3dCommandPresent(PVGASTATE pThis, PVGASTATECC pThisCC, uint32_t sid, uint32_t cRects, SVGA3dCopyRect *pRect);
119int vmsvga3dDrawPrimitives(PVGASTATECC pThisCC, uint32_t cid, uint32_t numVertexDecls, SVGA3dVertexDecl *pVertexDecl, uint32_t numRanges, SVGA3dPrimitiveRange *pNumRange, uint32_t cVertexDivisor, SVGA3dVertexDivisor *pVertexDivisor);
120int vmsvga3dSetScissorRect(PVGASTATECC pThisCC, uint32_t cid, SVGA3dRect *pRect);
121int vmsvga3dGenerateMipmaps(PVGASTATECC pThisCC, uint32_t sid, SVGA3dTextureFilter filter);
122
123int vmsvga3dShaderDefine(PVGASTATECC pThisCC, uint32_t cid, uint32_t shid, SVGA3dShaderType type, uint32_t cbData, uint32_t *pShaderData);
124int vmsvga3dShaderDestroy(PVGASTATECC pThisCC, uint32_t cid, uint32_t shid, SVGA3dShaderType type);
125int vmsvga3dShaderSet(PVGASTATECC pThisCC, struct VMSVGA3DCONTEXT *pContext, uint32_t cid, SVGA3dShaderType type, uint32_t shid);
126int vmsvga3dShaderSetConst(PVGASTATECC pThisCC, uint32_t cid, uint32_t reg, SVGA3dShaderType type, SVGA3dShaderConstType ctype, uint32_t cRegisters, uint32_t *pValues);
127
128int vmsvga3dQueryBegin(PVGASTATECC pThisCC, uint32_t cid, SVGA3dQueryType type);
129int vmsvga3dQueryEnd(PVGASTATECC pThisCC, uint32_t cid, SVGA3dQueryType type, SVGAGuestPtr guestResult);
130int vmsvga3dQueryWait(PVGASTATE pThis, PVGASTATECC pThisCC, uint32_t cid, SVGA3dQueryType type, SVGAGuestPtr guestResult);
131
132int vmsvga3dScreenTargetBind(PVGASTATECC pThisCC, VMSVGASCREENOBJECT *pScreen, uint32_t sid);
133int vmsvga3dScreenTargetUpdate(PVGASTATECC pThisCC, VMSVGASCREENOBJECT *pScreen, SVGA3dRect const *pRect);
134
135int vmsvga3dSurfaceMap(PVGASTATECC pThisCC, SVGA3dSurfaceImageId const *pImage, SVGA3dBox const *pBox, VMSVGA3D_SURFACE_MAP enmMapType, VMSVGA3D_MAPPED_SURFACE *pMap);
136int vmsvga3dSurfaceUnmap(PVGASTATECC pThisCC, SVGA3dSurfaceImageId const *pImage, VMSVGA3D_MAPPED_SURFACE *pMap, bool fWritten);
137
138/* DevVGA-SVGA3d-shared.h: */
139#if defined(RT_OS_WINDOWS) && defined(IN_RING3)
140# include <iprt/win/windows.h>
141
142# define WM_VMSVGA3D_WAKEUP (WM_APP+1)
143# define WM_VMSVGA3D_CREATEWINDOW (WM_APP+2)
144# define WM_VMSVGA3D_DESTROYWINDOW (WM_APP+3)
145# define WM_VMSVGA3D_EXIT (WM_APP+5)
146# if 0
147# define WM_VMSVGA3D_CREATE_DEVICE (WM_APP+6)
148typedef struct VMSVGA3DCREATEDEVICEPARAMS
149{
150 struct VMSVGA3DSTATE *pState;
151 struct VMSVGA3DCONTEXT *pContext;
152 struct _D3DPRESENT_PARAMETERS_ *pPresParams;
153 HRESULT hrc;
154} VMSVGA3DCREATEDEVICEPARAMS;
155# endif
156
157DECLCALLBACK(int) vmsvga3dWindowThread(RTTHREAD ThreadSelf, void *pvUser);
158int vmsvga3dSendThreadMessage(RTTHREAD pWindowThread, RTSEMEVENT WndRequestSem, UINT msg, WPARAM wParam, LPARAM lParam);
159int vmsvga3dContextWindowCreate(HINSTANCE hInstance, RTTHREAD pWindowThread, RTSEMEVENT WndRequestSem, HWND *pHwnd);
160
161#endif
162
163void vmsvga3dUpdateHeapBuffersForSurfaces(PVGASTATECC pThisCC, uint32_t sid);
164void vmsvga3dInfoContextWorker(PVGASTATECC pThisCC, PCDBGFINFOHLP pHlp, uint32_t cid, bool fVerbose);
165void vmsvga3dInfoSurfaceWorker(PPDMDEVINS pDevIns, PVGASTATE pThis, PVGASTATECC pThisCC, PCDBGFINFOHLP pHlp, uint32_t sid,
166 bool fVerbose, uint32_t cxAscii, bool fInvY, const char *pszBitmapPath);
167
168/* DevVGA-SVGA3d-shared.cpp: */
169
170/**
171 * Structure for use with vmsvga3dInfoU32Flags.
172 */
173typedef struct VMSVGAINFOFLAGS32
174{
175 /** The flags. */
176 uint32_t fFlags;
177 /** The corresponding mnemonic. */
178 const char *pszJohnny;
179} VMSVGAINFOFLAGS32;
180/** Pointer to a read-only flag translation entry. */
181typedef VMSVGAINFOFLAGS32 const *PCVMSVGAINFOFLAGS32;
182void vmsvga3dInfoU32Flags(PCDBGFINFOHLP pHlp, uint32_t fFlags, const char *pszPrefix, PCVMSVGAINFOFLAGS32 paFlags, uint32_t cFlags);
183
184/**
185 * Structure for use with vmsvgaFormatEnumValueEx and vmsvgaFormatEnumValue.
186 */
187typedef struct VMSVGAINFOENUM
188{
189 /** The enum value. */
190 int32_t iValue;
191 /** The corresponding value name. */
192 const char *pszName;
193} VMSVGAINFOENUM;
194/** Pointer to a read-only enum value translation entry. */
195typedef VMSVGAINFOENUM const *PCVMSVGAINFOENUM;
196/**
197 * Structure for use with vmsvgaFormatEnumValueEx and vmsvgaFormatEnumValue.
198 */
199typedef struct VMSVGAINFOENUMMAP
200{
201 /** Pointer to the value mapping array. */
202 PCVMSVGAINFOENUM paValues;
203 /** The number of value mappings. */
204 size_t cValues;
205 /** The prefix. */
206 const char *pszPrefix;
207#ifdef RT_STRICT
208 /** Indicates whether we've checked that it's sorted or not. */
209 bool *pfAsserted;
210#endif
211} VMSVGAINFOENUMMAP;
212typedef VMSVGAINFOENUMMAP const *PCVMSVGAINFOENUMMAP;
213/** @def VMSVGAINFOENUMMAP_MAKE
214 * Macro for defining a VMSVGAINFOENUMMAP, silently dealing with pfAsserted.
215 *
216 * @param a_Scope The scope. RT_NOTHING or static.
217 * @param a_VarName The variable name for this map.
218 * @param a_aValues The variable name of the value mapping array.
219 * @param a_pszPrefix The value name prefix.
220 */
221#ifdef VBOX_STRICT
222# define VMSVGAINFOENUMMAP_MAKE(a_Scope, a_VarName, a_aValues, a_pszPrefix) \
223 static bool RT_CONCAT(a_VarName,_AssertedSorted) = false; \
224 a_Scope VMSVGAINFOENUMMAP const a_VarName = { \
225 a_aValues, RT_ELEMENTS(a_aValues), a_pszPrefix, &RT_CONCAT(a_VarName,_AssertedSorted) \
226 }
227#else
228# define VMSVGAINFOENUMMAP_MAKE(a_Scope, a_VarName, a_aValues, a_pszPrefix) \
229 a_Scope VMSVGAINFOENUMMAP const a_VarName = { a_aValues, RT_ELEMENTS(a_aValues), a_pszPrefix }
230#endif
231extern VMSVGAINFOENUMMAP const g_SVGA3dSurfaceFormat2String;
232const char *vmsvgaLookupEnum(int32_t iValue, PCVMSVGAINFOENUMMAP pEnumMap);
233char *vmsvgaFormatEnumValueEx(char *pszBuffer, size_t cbBuffer, const char *pszName, int32_t iValue,
234 bool fPrefix, PCVMSVGAINFOENUMMAP pEnumMap);
235char *vmsvgaFormatEnumValue(char *pszBuffer, size_t cbBuffer, const char *pszName, uint32_t uValue,
236 const char *pszPrefix, const char * const *papszValues, size_t cValues);
237
238/**
239 * ASCII "art" scanline printer callback.
240 *
241 * @param pszLine The line to output.
242 * @param pvUser The user argument.
243 */
244typedef DECLCALLBACKTYPE(void, FNVMSVGAASCIIPRINTLN,(const char *pszLine, void *pvUser));
245/** Pointer to an ASCII "art" print line callback. */
246typedef FNVMSVGAASCIIPRINTLN *PFNVMSVGAASCIIPRINTLN;
247void vmsvga3dAsciiPrint(PFNVMSVGAASCIIPRINTLN pfnPrintLine, void *pvUser, void const *pvImage, size_t cbImage,
248 uint32_t cx, uint32_t cy, uint32_t cbScanline, SVGA3dSurfaceFormat enmFormat, bool fInvY,
249 uint32_t cchMaxX, uint32_t cchMaxY);
250DECLCALLBACK(void) vmsvga3dAsciiPrintlnInfo(const char *pszLine, void *pvUser);
251DECLCALLBACK(void) vmsvga3dAsciiPrintlnLog(const char *pszLine, void *pvUser);
252
253char *vmsvga3dFormatRenderState(char *pszBuffer, size_t cbBuffer, SVGA3dRenderState const *pRenderState);
254char *vmsvga3dFormatTextureState(char *pszBuffer, size_t cbBuffer, SVGA3dTextureState const *pTextureState);
255void vmsvga3dInfoHostWindow(PCDBGFINFOHLP pHlp, uint64_t idHostWindow);
256
257uint32_t vmsvga3dSurfaceFormatSize(SVGA3dSurfaceFormat format,
258 uint32_t *pu32BlockWidth,
259 uint32_t *pu32BlockHeight);
260
261#ifdef LOG_ENABLED
262const char *vmsvga3dGetCapString(uint32_t idxCap);
263const char *vmsvga3dGet3dFormatString(uint32_t format);
264const char *vmsvga3dGetRenderStateName(uint32_t state);
265const char *vmsvga3dTextureStateToString(SVGA3dTextureStateName textureState);
266const char *vmsvgaTransformToString(SVGA3dTransformType type);
267const char *vmsvgaDeclUsage2String(SVGA3dDeclUsage usage);
268const char *vmsvgaDeclType2String(SVGA3dDeclType type);
269const char *vmsvgaDeclMethod2String(SVGA3dDeclMethod method);
270const char *vmsvgaSurfaceType2String(SVGA3dSurfaceFormat format);
271const char *vmsvga3dPrimitiveType2String(SVGA3dPrimitiveType PrimitiveType);
272#endif
273
274#endif /* !VBOX_INCLUDED_SRC_Graphics_DevVGA_SVGA3d_h */
275
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette