Subversion Repositories Kolibri OS

/**********************************************************

 * Copyright 1998-2014 VMware, Inc.  All rights reserved.

 *

 * Permission is hereby granted, free of charge, to any person

 * obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without

 * restriction, including without limitation the rights to use, copy,

 * modify, merge, publish, distribute, sublicense, and/or sell copies

 * of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 * SOFTWARE.

 *

 **********************************************************/

/*

 * svga3d_cmd.h --

 *

 *       SVGA 3d hardware cmd definitions

 */

#ifndef _SVGA3D_CMD_H_

#define _SVGA3D_CMD_H_

#define INCLUDE_ALLOW_MODULE

#define INCLUDE_ALLOW_USERLEVEL

#define INCLUDE_ALLOW_VMCORE

#include "includeCheck.h"

#include "svga3d_types.h"

/*

 * Identifiers for commands in the command FIFO.

 *

 * IDs between 1000 and 1039 (inclusive) were used by obsolete versions of

 * the SVGA3D protocol and remain reserved; they should not be used in the

 * future.

 *

 * IDs between 1040 and 1999 (inclusive) are available for use by the

 * current SVGA3D protocol.

 *

 * FIFO clients other than SVGA3D should stay below 1000, or at 2000

 * and up.

 */

#define SVGA_3D_CMD_LEGACY_BASE                                1000

#define SVGA_3D_CMD_BASE                                       1040

#define SVGA_3D_CMD_SURFACE_DEFINE                             1040

#define SVGA_3D_CMD_SURFACE_DESTROY                            1041

#define SVGA_3D_CMD_SURFACE_COPY                               1042

#define SVGA_3D_CMD_SURFACE_STRETCHBLT                         1043

#define SVGA_3D_CMD_SURFACE_DMA                                1044

#define SVGA_3D_CMD_CONTEXT_DEFINE                             1045

#define SVGA_3D_CMD_CONTEXT_DESTROY                            1046

#define SVGA_3D_CMD_SETTRANSFORM                               1047

#define SVGA_3D_CMD_SETZRANGE                                  1048

#define SVGA_3D_CMD_SETRENDERSTATE                             1049

#define SVGA_3D_CMD_SETRENDERTARGET                            1050

#define SVGA_3D_CMD_SETTEXTURESTATE                            1051

#define SVGA_3D_CMD_SETMATERIAL                                1052

#define SVGA_3D_CMD_SETLIGHTDATA                               1053

#define SVGA_3D_CMD_SETLIGHTENABLED                            1054

#define SVGA_3D_CMD_SETVIEWPORT                                1055

#define SVGA_3D_CMD_SETCLIPPLANE                               1056

#define SVGA_3D_CMD_CLEAR                                      1057

#define SVGA_3D_CMD_PRESENT                                    1058

#define SVGA_3D_CMD_SHADER_DEFINE                              1059

#define SVGA_3D_CMD_SHADER_DESTROY                             1060

#define SVGA_3D_CMD_SET_SHADER                                 1061

#define SVGA_3D_CMD_SET_SHADER_CONST                           1062

#define SVGA_3D_CMD_DRAW_PRIMITIVES                            1063

#define SVGA_3D_CMD_SETSCISSORRECT                             1064

#define SVGA_3D_CMD_BEGIN_QUERY                                1065

#define SVGA_3D_CMD_END_QUERY                                  1066

#define SVGA_3D_CMD_WAIT_FOR_QUERY                             1067

#define SVGA_3D_CMD_PRESENT_READBACK                           1068

#define SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN                     1069

#define SVGA_3D_CMD_SURFACE_DEFINE_V2                          1070

#define SVGA_3D_CMD_GENERATE_MIPMAPS                           1071

#define SVGA_3D_CMD_VIDEO_CREATE_DECODER                       1072

#define SVGA_3D_CMD_VIDEO_DESTROY_DECODER                      1073

#define SVGA_3D_CMD_VIDEO_CREATE_PROCESSOR                     1074

#define SVGA_3D_CMD_VIDEO_DESTROY_PROCESSOR                    1075

#define SVGA_3D_CMD_VIDEO_DECODE_START_FRAME                   1076

#define SVGA_3D_CMD_VIDEO_DECODE_RENDER                        1077

#define SVGA_3D_CMD_VIDEO_DECODE_END_FRAME                     1078

#define SVGA_3D_CMD_VIDEO_PROCESS_FRAME                        1079

#define SVGA_3D_CMD_ACTIVATE_SURFACE                           1080

#define SVGA_3D_CMD_DEACTIVATE_SURFACE                         1081

#define SVGA_3D_CMD_SCREEN_DMA                                 1082

#define SVGA_3D_CMD_SET_UNITY_SURFACE_COOKIE                   1083

#define SVGA_3D_CMD_OPEN_CONTEXT_SURFACE                       1084

#define SVGA_3D_CMD_LOGICOPS_BITBLT                            1085

#define SVGA_3D_CMD_LOGICOPS_TRANSBLT                          1086

#define SVGA_3D_CMD_LOGICOPS_STRETCHBLT                        1087

#define SVGA_3D_CMD_LOGICOPS_COLORFILL                         1088

#define SVGA_3D_CMD_LOGICOPS_ALPHABLEND                        1089

#define SVGA_3D_CMD_LOGICOPS_CLEARTYPEBLEND                    1090

#define SVGA_3D_CMD_SET_OTABLE_BASE                            1091

#define SVGA_3D_CMD_READBACK_OTABLE                            1092

#define SVGA_3D_CMD_DEFINE_GB_MOB                              1093

#define SVGA_3D_CMD_DESTROY_GB_MOB                             1094

#define SVGA_3D_CMD_REDEFINE_GB_MOB                            1095

#define SVGA_3D_CMD_UPDATE_GB_MOB_MAPPING                      1096

#define SVGA_3D_CMD_DEFINE_GB_SURFACE                          1097

#define SVGA_3D_CMD_DESTROY_GB_SURFACE                         1098

#define SVGA_3D_CMD_BIND_GB_SURFACE                            1099

#define SVGA_3D_CMD_COND_BIND_GB_SURFACE                       1100

#define SVGA_3D_CMD_UPDATE_GB_IMAGE                            1101

#define SVGA_3D_CMD_UPDATE_GB_SURFACE                          1102

#define SVGA_3D_CMD_READBACK_GB_IMAGE                          1103

#define SVGA_3D_CMD_READBACK_GB_SURFACE                        1104

#define SVGA_3D_CMD_INVALIDATE_GB_IMAGE                        1105

#define SVGA_3D_CMD_INVALIDATE_GB_SURFACE                      1106

#define SVGA_3D_CMD_DEFINE_GB_CONTEXT                          1107

#define SVGA_3D_CMD_DESTROY_GB_CONTEXT                         1108

#define SVGA_3D_CMD_BIND_GB_CONTEXT                            1109

#define SVGA_3D_CMD_READBACK_GB_CONTEXT                        1110

#define SVGA_3D_CMD_INVALIDATE_GB_CONTEXT                      1111

#define SVGA_3D_CMD_DEFINE_GB_SHADER                           1112

#define SVGA_3D_CMD_DESTROY_GB_SHADER                          1113

#define SVGA_3D_CMD_BIND_GB_SHADER                             1114

#define SVGA_3D_CMD_BIND_SHADERCONSTS                          1115

#define SVGA_3D_CMD_BEGIN_GB_QUERY                             1116

#define SVGA_3D_CMD_END_GB_QUERY                               1117

#define SVGA_3D_CMD_WAIT_FOR_GB_QUERY                          1118

#define SVGA_3D_CMD_NOP                                        1119

#define SVGA_3D_CMD_ENABLE_GART                                1120

#define SVGA_3D_CMD_DISABLE_GART                               1121

#define SVGA_3D_CMD_MAP_MOB_INTO_GART                          1122

#define SVGA_3D_CMD_UNMAP_GART_RANGE                           1123

#define SVGA_3D_CMD_DEFINE_GB_SCREENTARGET                     1124

#define SVGA_3D_CMD_DESTROY_GB_SCREENTARGET                    1125

#define SVGA_3D_CMD_BIND_GB_SCREENTARGET                       1126

#define SVGA_3D_CMD_UPDATE_GB_SCREENTARGET                     1127

#define SVGA_3D_CMD_READBACK_GB_IMAGE_PARTIAL                  1128

#define SVGA_3D_CMD_INVALIDATE_GB_IMAGE_PARTIAL                1129

#define SVGA_3D_CMD_SET_GB_SHADERCONSTS_INLINE                 1130

#define SVGA_3D_CMD_GB_SCREEN_DMA                              1131

#define SVGA_3D_CMD_BIND_GB_SURFACE_WITH_PITCH                 1132

#define SVGA_3D_CMD_GB_MOB_FENCE                               1133

#define SVGA_3D_CMD_DEFINE_GB_SURFACE_V2                       1134

#define SVGA_3D_CMD_DEFINE_GB_MOB64                            1135

#define SVGA_3D_CMD_REDEFINE_GB_MOB64                          1136

#define SVGA_3D_CMD_NOP_ERROR                                  1137

#define SVGA_3D_CMD_RESERVED1                                  1138

#define SVGA_3D_CMD_RESERVED2                                  1139

#define SVGA_3D_CMD_RESERVED3                                  1140

#define SVGA_3D_CMD_RESERVED4                                  1141

#define SVGA_3D_CMD_RESERVED5                                  1142

#define SVGA_3D_CMD_MAX                                        1203

#define SVGA_3D_CMD_FUTURE_MAX                                 3000

/*

 * FIFO command format definitions:

 */

/*

 * The data size header following cmdNum for every 3d command

 */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               id;

   uint32               size;

}

#include "vmware_pack_end.h"

SVGA3dCmdHeader;

typedef enum {

   SVGA3D_SURFACE_CUBEMAP               = (1 << 0),

   /*

    * HINT flags are not enforced by the device but are useful for

    * performance.

    */

   SVGA3D_SURFACE_HINT_STATIC           = (1 << 1),

   SVGA3D_SURFACE_HINT_DYNAMIC          = (1 << 2),

   SVGA3D_SURFACE_HINT_INDEXBUFFER      = (1 << 3),

   SVGA3D_SURFACE_HINT_VERTEXBUFFER     = (1 << 4),

   SVGA3D_SURFACE_HINT_TEXTURE          = (1 << 5),

   SVGA3D_SURFACE_HINT_RENDERTARGET     = (1 << 6),

   SVGA3D_SURFACE_HINT_DEPTHSTENCIL     = (1 << 7),

   SVGA3D_SURFACE_HINT_WRITEONLY        = (1 << 8),

   SVGA3D_SURFACE_MASKABLE_ANTIALIAS    = (1 << 9),

   SVGA3D_SURFACE_AUTOGENMIPMAPS        = (1 << 10),

   SVGA3D_SURFACE_DECODE_RENDERTARGET   = (1 << 11),

   /*

    * Is this surface using a base-level pitch for it's mob backing?

    *

    * This flag is not intended to be set by guest-drivers, but is instead

    * set by the device when the surface is bound to a mob with a specified

    * pitch.

    */

   SVGA3D_SURFACE_MOB_PITCH             = (1 << 12),

   SVGA3D_SURFACE_INACTIVE              = (1 << 13),

   SVGA3D_SURFACE_HINT_RT_LOCKABLE      = (1 << 14),

   SVGA3D_SURFACE_VOLUME                = (1 << 15),

   /*

    * Required to be set on a surface to bind it to a screen target.

    */

   SVGA3D_SURFACE_SCREENTARGET          = (1 << 16),

   SVGA3D_SURFACE_RESERVED1             = (1 << 17),

   SVGA3D_SURFACE_1D                    = (1 << 18),

   SVGA3D_SURFACE_ARRAY                 = (1 << 19),

} SVGA3dSurfaceFlags;

#define SVGA3D_SURFACE_HB_DISALLOWED_MASK (SVGA3D_SURFACE_SCREENTARGET | \

                                           SVGA3D_SURFACE_MOB_PITCH    | \

                                           SVGA3D_SURFACE_BIND_CONSTANT_BUFFER | \

                                           SVGA3D_SURFACE_BIND_STREAM_OUTPUT)

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               numMipLevels;

}

#include "vmware_pack_end.h"

SVGA3dSurfaceFace;

typedef

#include "vmware_pack_begin.h"

struct {

   uint32                      sid;

   SVGA3dSurfaceFlags          surfaceFlags;

   SVGA3dSurfaceFormat         format;

   /*

    * If surfaceFlags has SVGA3D_SURFACE_CUBEMAP bit set, all SVGA3dSurfaceFace

    * structures must have the same value of numMipLevels field.

    * Otherwise, all but the first SVGA3dSurfaceFace structures must have the

    * numMipLevels set to 0.

    */

   SVGA3dSurfaceFace           face[SVGA3D_MAX_SURFACE_FACES];

   /*

    * Followed by an SVGA3dSize structure for each mip level in each face.

    *

    * A note on surface sizes: Sizes are always specified in pixels,

    * even if the true surface size is not a multiple of the minimum

    * block size of the surface's format. For example, a 3x3x1 DXT1

    * compressed texture would actually be stored as a 4x4x1 image in

    * memory.

    */

}

#include "vmware_pack_end.h"

SVGA3dCmdDefineSurface;       /* SVGA_3D_CMD_SURFACE_DEFINE */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32                      sid;

   SVGA3dSurfaceFlags          surfaceFlags;

   SVGA3dSurfaceFormat         format;

   /*

    * If surfaceFlags has SVGA3D_SURFACE_CUBEMAP bit set, all SVGA3dSurfaceFace

    * structures must have the same value of numMipLevels field.

    * Otherwise, all but the first SVGA3dSurfaceFace structures must have the

    * numMipLevels set to 0.

    */

   SVGA3dSurfaceFace           face[SVGA3D_MAX_SURFACE_FACES];

   uint32                      multisampleCount;

   SVGA3dTextureFilter         autogenFilter;

   /*

    * Followed by an SVGA3dSize structure for each mip level in each face.

    *

    * A note on surface sizes: Sizes are always specified in pixels,

    * even if the true surface size is not a multiple of the minimum

    * block size of the surface's format. For example, a 3x3x1 DXT1

    * compressed texture would actually be stored as a 4x4x1 image in

    * memory.

    */

}

#include "vmware_pack_end.h"

SVGA3dCmdDefineSurface_v2;     /* SVGA_3D_CMD_SURFACE_DEFINE_V2 */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               sid;

}

#include "vmware_pack_end.h"

SVGA3dCmdDestroySurface;      /* SVGA_3D_CMD_SURFACE_DESTROY */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

}

#include "vmware_pack_end.h"

SVGA3dCmdDefineContext;       /* SVGA_3D_CMD_CONTEXT_DEFINE */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

}

#include "vmware_pack_end.h"

SVGA3dCmdDestroyContext;      /* SVGA_3D_CMD_CONTEXT_DESTROY */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dClearFlag      clearFlag;

   uint32               color;

   float                depth;

   uint32               stencil;

   /* Followed by variable number of SVGA3dRect structures */

}

#include "vmware_pack_end.h"

SVGA3dCmdClear;               /* SVGA_3D_CMD_CLEAR */

typedef

#include "vmware_pack_begin.h"

struct {

   SVGA3dLightType      type;

   SVGA3dBool           inWorldSpace;

   float                diffuse[4];

   float                specular[4];

   float                ambient[4];

   float                position[4];

   float                direction[4];

   float                range;

   float                falloff;

   float                attenuation0;

   float                attenuation1;

   float                attenuation2;

   float                theta;

   float                phi;

}

#include "vmware_pack_end.h"

SVGA3dLightData;

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               sid;

   /* Followed by variable number of SVGA3dCopyRect structures */

}

#include "vmware_pack_end.h"

SVGA3dCmdPresent;             /* SVGA_3D_CMD_PRESENT */

typedef

#include "vmware_pack_begin.h"

struct {

   SVGA3dRenderStateName   state;

   union {

      uint32               uintValue;

      float                floatValue;

   };

}

#include "vmware_pack_end.h"

SVGA3dRenderState;

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   /* Followed by variable number of SVGA3dRenderState structures */

}

#include "vmware_pack_end.h"

SVGA3dCmdSetRenderState;      /* SVGA_3D_CMD_SETRENDERSTATE */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32                 cid;

   SVGA3dRenderTargetType type;

   SVGA3dSurfaceImageId   target;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetRenderTarget;     /* SVGA_3D_CMD_SETRENDERTARGET */

typedef

#include "vmware_pack_begin.h"

struct {

   SVGA3dSurfaceImageId  src;

   SVGA3dSurfaceImageId  dest;

   /* Followed by variable number of SVGA3dCopyBox structures */

}

#include "vmware_pack_end.h"

SVGA3dCmdSurfaceCopy;               /* SVGA_3D_CMD_SURFACE_COPY */

typedef

#include "vmware_pack_begin.h"

struct {

   SVGA3dSurfaceImageId  src;

   SVGA3dSurfaceImageId  dest;

   SVGA3dBox             boxSrc;

   SVGA3dBox             boxDest;

   SVGA3dStretchBltMode  mode;

}

#include "vmware_pack_end.h"

SVGA3dCmdSurfaceStretchBlt;         /* SVGA_3D_CMD_SURFACE_STRETCHBLT */

typedef

#include "vmware_pack_begin.h"

struct {

   /*

    * If the discard flag is present in a surface DMA operation, the host may

    * discard the contents of the current mipmap level and face of the target

    * surface before applying the surface DMA contents.

    */

   uint32 discard : 1;

   /*

    * If the unsynchronized flag is present, the host may perform this upload

    * without syncing to pending reads on this surface.

    */

   uint32 unsynchronized : 1;

   /*

    * Guests *MUST* set the reserved bits to 0 before submitting the command

    * suffix as future flags may occupy these bits.

    */

   uint32 reserved : 30;

}

#include "vmware_pack_end.h"

SVGA3dSurfaceDMAFlags;

typedef

#include "vmware_pack_begin.h"

struct {

   SVGAGuestImage guest;

   SVGA3dSurfaceImageId host;

   SVGA3dTransferType transfer;

   /*

    * Followed by variable number of SVGA3dCopyBox structures. For consistency

    * in all clipping logic and coordinate translation, we define the

    * "source" in each copyBox as the guest image and the

    * "destination" as the host image, regardless of transfer

    * direction.

    *

    * For efficiency, the SVGA3D device is free to copy more data than

    * specified. For example, it may round copy boxes outwards such

    * that they lie on particular alignment boundaries.

    */

}

#include "vmware_pack_end.h"

SVGA3dCmdSurfaceDMA;                /* SVGA_3D_CMD_SURFACE_DMA */

/*

 * SVGA3dCmdSurfaceDMASuffix --

 *

 *    This is a command suffix that will appear after a SurfaceDMA command in

 *    the FIFO.  It contains some extra information that hosts may use to

 *    optimize performance or protect the guest.  This suffix exists to preserve

 *    backwards compatibility while also allowing for new functionality to be

 *    implemented.

 */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32 suffixSize;

   /*

    * The maximum offset is used to determine the maximum offset from the

    * guestPtr base address that will be accessed or written to during this

    * surfaceDMA.  If the suffix is supported, the host will respect this

    * boundary while performing surface DMAs.

    *

    * Defaults to MAX_UINT32

    */

   uint32 maximumOffset;

   /*

    * A set of flags that describes optimizations that the host may perform

    * while performing this surface DMA operation.  The guest should never rely

    * on behaviour that is different when these flags are set for correctness.

    *

    * Defaults to 0

    */

   SVGA3dSurfaceDMAFlags flags;

}

#include "vmware_pack_end.h"

SVGA3dCmdSurfaceDMASuffix;

/*

 * SVGA_3D_CMD_DRAW_PRIMITIVES --

 *

 *   This command is the SVGA3D device's generic drawing entry point.

 *   It can draw multiple ranges of primitives, optionally using an

 *   index buffer, using an arbitrary collection of vertex buffers.

 *

 *   Each SVGA3dVertexDecl defines a distinct vertex array to bind

 *   during this draw call. The declarations specify which surface

 *   the vertex data lives in, what that vertex data is used for,

 *   and how to interpret it.

 *

 *   Each SVGA3dPrimitiveRange defines a collection of primitives

 *   to render using the same vertex arrays. An index buffer is

 *   optional.

 */

typedef

#include "vmware_pack_begin.h"

struct {

   /*

    * A range hint is an optional specification for the range of indices

    * in an SVGA3dArray that will be used. If 'last' is zero, it is assumed

    * that the entire array will be used.

    *

    * These are only hints. The SVGA3D device may use them for

    * performance optimization if possible, but it's also allowed to

    * ignore these values.

    */

   uint32               first;

   uint32               last;

}

#include "vmware_pack_end.h"

SVGA3dArrayRangeHint;

typedef

#include "vmware_pack_begin.h"

struct {

   /*

    * Define the origin and shape of a vertex or index array. Both

    * 'offset' and 'stride' are in bytes. The provided surface will be

    * reinterpreted as a flat array of bytes in the same format used

    * by surface DMA operations. To avoid unnecessary conversions, the

    * surface should be created with the SVGA3D_BUFFER format.

    *

    * Index 0 in the array starts 'offset' bytes into the surface.

    * Index 1 begins at byte 'offset + stride', etc. Array indices may

    * not be negative.

    */

   uint32               surfaceId;

   uint32               offset;

   uint32               stride;

}

#include "vmware_pack_end.h"

SVGA3dArray;

typedef

#include "vmware_pack_begin.h"

struct {

   /*

    * Describe a vertex array's data type, and define how it is to be

    * used by the fixed function pipeline or the vertex shader. It

    * isn't useful to have two VertexDecls with the same

    * VertexArrayIdentity in one draw call.

    */

   SVGA3dDeclType       type;

   SVGA3dDeclMethod     method;

   SVGA3dDeclUsage      usage;

   uint32               usageIndex;

}

#include "vmware_pack_end.h"

SVGA3dVertexArrayIdentity;

typedef

#include "vmware_pack_begin.h"

struct SVGA3dVertexDecl {

   SVGA3dVertexArrayIdentity  identity;

   SVGA3dArray                array;

   SVGA3dArrayRangeHint       rangeHint;

}

#include "vmware_pack_end.h"

SVGA3dVertexDecl;

typedef

#include "vmware_pack_begin.h"

struct SVGA3dPrimitiveRange {

   /*

    * Define a group of primitives to render, from sequential indices.

    *

    * The value of 'primitiveType' and 'primitiveCount' imply the

    * total number of vertices that will be rendered.

    */

   SVGA3dPrimitiveType  primType;

   uint32               primitiveCount;

   /*

    * Optional index buffer. If indexArray.surfaceId is

    * SVGA3D_INVALID_ID, we render without an index buffer. Rendering

    * without an index buffer is identical to rendering with an index

    * buffer containing the sequence [0, 1, 2, 3, ...].

    *

    * If an index buffer is in use, indexWidth specifies the width in

    * bytes of each index value. It must be less than or equal to

    * indexArray.stride.

    *

    * (Currently, the SVGA3D device requires index buffers to be tightly

    * packed. In other words, indexWidth == indexArray.stride)

    */

   SVGA3dArray          indexArray;

   uint32               indexWidth;

   /*

    * Optional index bias. This number is added to all indices from

    * indexArray before they are used as vertex array indices. This

    * can be used in multiple ways:

    *

    *  - When not using an indexArray, this bias can be used to

    *    specify where in the vertex arrays to begin rendering.

    *

    *  - A positive number here is equivalent to increasing the

    *    offset in each vertex array.

    *

    *  - A negative number can be used to render using a small

    *    vertex array and an index buffer that contains large

    *    values. This may be used by some applications that

    *    crop a vertex buffer without modifying their index

    *    buffer.

    *

    * Note that rendering with a negative bias value may be slower and

    * use more memory than rendering with a positive or zero bias.

    */

   int32                indexBias;

}

#include "vmware_pack_end.h"

SVGA3dPrimitiveRange;

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   uint32               numVertexDecls;

   uint32               numRanges;

   /*

    * There are two variable size arrays after the

    * SVGA3dCmdDrawPrimitives structure. In order,

    * they are:

    *

    * 1. SVGA3dVertexDecl, quantity 'numVertexDecls', but no more than

    *    SVGA3D_MAX_VERTEX_ARRAYS;

    * 2. SVGA3dPrimitiveRange, quantity 'numRanges', but no more than

    *    SVGA3D_MAX_DRAW_PRIMITIVE_RANGES;

    * 3. Optionally, SVGA3dVertexDivisor, quantity 'numVertexDecls' (contains

    *    the frequency divisor for the corresponding vertex decl).

    */

}

#include "vmware_pack_end.h"

SVGA3dCmdDrawPrimitives;      /* SVGA_3D_CMD_DRAWPRIMITIVES */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32                   stage;

   SVGA3dTextureStateName   name;

   union {

      uint32                value;

      float                 floatValue;

   };

}

#include "vmware_pack_end.h"

SVGA3dTextureState;

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   /* Followed by variable number of SVGA3dTextureState structures */

}

#include "vmware_pack_end.h"

SVGA3dCmdSetTextureState;      /* SVGA_3D_CMD_SETTEXTURESTATE */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32                   cid;

   SVGA3dTransformType      type;

   float                    matrix[16];

}

#include "vmware_pack_end.h"

SVGA3dCmdSetTransform;          /* SVGA_3D_CMD_SETTRANSFORM */

typedef

#include "vmware_pack_begin.h"

struct {

   float                min;

   float                max;

}

#include "vmware_pack_end.h"

SVGA3dZRange;

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dZRange         zRange;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetZRange;             /* SVGA_3D_CMD_SETZRANGE */

typedef

#include "vmware_pack_begin.h"

struct {

   float                diffuse[4];

   float                ambient[4];

   float                specular[4];

   float                emissive[4];

   float                shininess;

}

#include "vmware_pack_end.h"

SVGA3dMaterial;

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dFace           face;

   SVGA3dMaterial       material;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetMaterial;           /* SVGA_3D_CMD_SETMATERIAL */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   uint32               index;

   SVGA3dLightData      data;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetLightData;           /* SVGA_3D_CMD_SETLIGHTDATA */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   uint32               index;

   uint32               enabled;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetLightEnabled;      /* SVGA_3D_CMD_SETLIGHTENABLED */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dRect           rect;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetViewport;           /* SVGA_3D_CMD_SETVIEWPORT */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dRect           rect;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetScissorRect;         /* SVGA_3D_CMD_SETSCISSORRECT */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   uint32               index;

   float                plane[4];

}

#include "vmware_pack_end.h"

SVGA3dCmdSetClipPlane;           /* SVGA_3D_CMD_SETCLIPPLANE */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   uint32               shid;

   SVGA3dShaderType     type;

   /* Followed by variable number of DWORDs for shader bycode */

}

#include "vmware_pack_end.h"

SVGA3dCmdDefineShader;           /* SVGA_3D_CMD_SHADER_DEFINE */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   uint32               shid;

   SVGA3dShaderType     type;

}

#include "vmware_pack_end.h"

SVGA3dCmdDestroyShader;         /* SVGA_3D_CMD_SHADER_DESTROY */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32                  cid;

   uint32                  reg;     /* register number */

   SVGA3dShaderType        type;

   SVGA3dShaderConstType   ctype;

   uint32                  values[4];

   /*

    * Followed by a variable number of additional values.

    */

}

#include "vmware_pack_end.h"

SVGA3dCmdSetShaderConst;        /* SVGA_3D_CMD_SET_SHADER_CONST */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dShaderType     type;

   uint32               shid;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetShader;       /* SVGA_3D_CMD_SET_SHADER */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dQueryType      type;

}

#include "vmware_pack_end.h"

SVGA3dCmdBeginQuery;           /* SVGA_3D_CMD_BEGIN_QUERY */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;

   SVGA3dQueryType      type;

   SVGAGuestPtr         guestResult;   /* Points to an SVGA3dQueryResult structure */

}

#include "vmware_pack_end.h"

SVGA3dCmdEndQuery;                  /* SVGA_3D_CMD_END_QUERY */

/*

 * SVGA3D_CMD_WAIT_FOR_QUERY --

 *

 *    Will read the SVGA3dQueryResult structure pointed to by guestResult,

 *    and if the state member is set to anything else than

 *    SVGA3D_QUERYSTATE_PENDING, this command will always be a no-op.

 *

 *    Otherwise, in addition to the query explicitly waited for,

 *    All queries with the same type and issued with the same cid, for which

 *    an SVGA_3D_CMD_END_QUERY command has previously been sent, will

 *    be finished after execution of this command.

 *

 *    A query will be identified by the gmrId and offset of the guestResult

 *    member. If the device can't find an SVGA_3D_CMD_END_QUERY that has

 *    been sent previously with an indentical gmrId and offset, it will

 *    effectively end all queries with an identical type issued with the

 *    same cid, and the SVGA3dQueryResult structure pointed to by

 *    guestResult will not be written to. This property can be used to

 *    implement a query barrier for a given cid and query type.

 */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               cid;        /* Same parameters passed to END_QUERY */

   SVGA3dQueryType      type;

   SVGAGuestPtr         guestResult;

}

#include "vmware_pack_end.h"

SVGA3dCmdWaitForQuery;              /* SVGA_3D_CMD_WAIT_FOR_QUERY */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               totalSize;    /* Set by guest before query is ended. */

   SVGA3dQueryState     state;        /* Set by host or guest. See SVGA3dQueryState. */

   union {                            /* Set by host on exit from PENDING state */

      uint32            result32;

      uint32            queryCookie; /* May be used to identify which QueryGetData this

                                        result corresponds to. */

   };

}

#include "vmware_pack_end.h"

SVGA3dQueryResult;

/*

 * SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN --

 *

 *    This is a blit from an SVGA3D surface to a Screen Object.

 *    This blit must be directed at a specific screen.

 *

 *    The blit copies from a rectangular region of an SVGA3D surface

 *    image to a rectangular region of a screen.

 *

 *    This command takes an optional variable-length list of clipping

 *    rectangles after the body of the command. If no rectangles are

 *    specified, there is no clipping region. The entire destRect is

 *    drawn to. If one or more rectangles are included, they describe

 *    a clipping region. The clip rectangle coordinates are measured

 *    relative to the top-left corner of destRect.

 *

 *    The srcImage must be from mip=0 face=0.

 *

 *    This supports scaling if the src and dest are of different sizes.

 *

 * Availability:

 *    SVGA_FIFO_CAP_SCREEN_OBJECT

 */

typedef

#include "vmware_pack_begin.h"

struct {

   SVGA3dSurfaceImageId srcImage;

   SVGASignedRect       srcRect;

   uint32               destScreenId; /* Screen Object ID */

   SVGASignedRect       destRect;

   /* Clipping: zero or more SVGASignedRects follow */

}

#include "vmware_pack_end.h"

SVGA3dCmdBlitSurfaceToScreen;         /* SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32               sid;

   SVGA3dTextureFilter  filter;

}

#include "vmware_pack_end.h"

SVGA3dCmdGenerateMipmaps;             /* SVGA_3D_CMD_GENERATE_MIPMAPS */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32 sid;

}

#include "vmware_pack_end.h"

SVGA3dCmdActivateSurface;               /* SVGA_3D_CMD_ACTIVATE_SURFACE */

typedef

#include "vmware_pack_begin.h"

struct {

   uint32 sid;

}

#include "vmware_pack_end.h"

SVGA3dCmdDeactivateSurface;             /* SVGA_3D_CMD_DEACTIVATE_SURFACE */

/*

 * Screen DMA command

 *

 * Available with SVGA_FIFO_CAP_SCREEN_OBJECT_2.  The SVGA_CAP_3D device

 * cap bit is not required.

 *

 * - refBuffer and destBuffer are 32bit BGRX; refBuffer and destBuffer could

 *   be different, but it is required that guest makes sure refBuffer has

 *   exactly the same contents that were written to when last time screen DMA

 *   command is received by host.

 *

 * - changemap is generated by lib/blit, and it has the changes from last

 *   received screen DMA or more.

 */

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdScreenDMA {

   uint32 screenId;

   SVGAGuestImage refBuffer;

   SVGAGuestImage destBuffer;

   SVGAGuestImage changeMap;

}

#include "vmware_pack_end.h"

SVGA3dCmdScreenDMA;        /* SVGA_3D_CMD_SCREEN_DMA */

/*

 * Set Unity Surface Cookie

 *

 * Associates the supplied cookie with the surface id for use with

 * Unity.  This cookie is a hint from guest to host, there is no way

 * for the guest to readback the cookie and the host is free to drop

 * the cookie association at will.  The default value for the cookie

 * on all surfaces is 0.

 */

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdSetUnitySurfaceCookie {

   uint32 sid;

   uint64 cookie;

}

#include "vmware_pack_end.h"

SVGA3dCmdSetUnitySurfaceCookie;   /* SVGA_3D_CMD_SET_UNITY_SURFACE_COOKIE */

/*

 * Open a context-specific surface in a non-context-specific manner.

 */

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdOpenContextSurface {

   uint32 sid;

}

#include "vmware_pack_end.h"

SVGA3dCmdOpenContextSurface;   /* SVGA_3D_CMD_OPEN_CONTEXT_SURFACE */

/*

 * Logic ops

 */

#define SVGA3D_LOTRANSBLT_HONORALPHA     (0x01)

#define SVGA3D_LOSTRETCHBLT_MIRRORX      (0x01)

#define SVGA3D_LOSTRETCHBLT_MIRRORY      (0x02)

#define SVGA3D_LOALPHABLEND_SRCHASALPHA  (0x01)

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdLogicOpsBitBlt {

   /*

    * All LogicOps surfaces are one-level

    * surfaces so mipmap & face should always

    * be zero.

    */

   SVGA3dSurfaceImageId src;

   SVGA3dSurfaceImageId dst;

   SVGA3dLogicOp logicOp;

   /* Followed by variable number of SVGA3dCopyBox structures */

}

#include "vmware_pack_end.h"

SVGA3dCmdLogicOpsBitBlt;   /* SVGA_3D_CMD_LOGICOPS_BITBLT */

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdLogicOpsTransBlt {

   /*

    * All LogicOps surfaces are one-level

    * surfaces so mipmap & face should always

    * be zero.

    */

   SVGA3dSurfaceImageId src;

   SVGA3dSurfaceImageId dst;

   uint32 color;

   uint32 flags;

   SVGA3dBox srcBox;

   SVGA3dBox dstBox;

}

#include "vmware_pack_end.h"

SVGA3dCmdLogicOpsTransBlt;   /* SVGA_3D_CMD_LOGICOPS_TRANSBLT */

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdLogicOpsStretchBlt {

   /*

    * All LogicOps surfaces are one-level

    * surfaces so mipmap & face should always

    * be zero.

    */

   SVGA3dSurfaceImageId src;

   SVGA3dSurfaceImageId dst;

   uint16 mode;

   uint16 flags;

   SVGA3dBox srcBox;

   SVGA3dBox dstBox;

}

#include "vmware_pack_end.h"

SVGA3dCmdLogicOpsStretchBlt;   /* SVGA_3D_CMD_LOGICOPS_STRETCHBLT */

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdLogicOpsColorFill {

   /*

    * All LogicOps surfaces are one-level

    * surfaces so mipmap & face should always

    * be zero.

    */

   SVGA3dSurfaceImageId dst;

   uint32 color;

   SVGA3dLogicOp logicOp;

   /* Followed by variable number of SVGA3dRect structures. */

}

#include "vmware_pack_end.h"

SVGA3dCmdLogicOpsColorFill;   /* SVGA_3D_CMD_LOGICOPS_COLORFILL */

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdLogicOpsAlphaBlend {

   /*

    * All LogicOps surfaces are one-level

    * surfaces so mipmap & face should always

    * be zero.

    */

   SVGA3dSurfaceImageId src;

   SVGA3dSurfaceImageId dst;

   uint32 alphaVal;

   uint32 flags;

   SVGA3dBox srcBox;

   SVGA3dBox dstBox;

}

#include "vmware_pack_end.h"

SVGA3dCmdLogicOpsAlphaBlend;   /* SVGA_3D_CMD_LOGICOPS_ALPHABLEND */

#define SVGA3D_CLEARTYPE_INVALID_GAMMA_INDEX 0xFFFFFFFF

#define SVGA3D_CLEARTYPE_GAMMA_WIDTH  512

#define SVGA3D_CLEARTYPE_GAMMA_HEIGHT 16

typedef

#include "vmware_pack_begin.h"

struct SVGA3dCmdLogicOpsClearTypeBlend {