D3DDDI_RESOURCEFLAGS structure (d3dukmdt.h)
The D3DDDI_RESOURCEFLAGS structure identifies the type of resources to create in a call to the driver's CreateResource function.
Syntax
typedef struct _D3DDDI_RESOURCEFLAGS {
union {
struct {
UINT RenderTarget : 1;
UINT ZBuffer : 1;
UINT Dynamic : 1;
UINT HintStatic : 1;
UINT AutogenMipmap : 1;
UINT DMap : 1;
UINT WriteOnly : 1;
UINT NotLockable : 1;
UINT Points : 1;
UINT RtPatches : 1;
UINT NPatches : 1;
UINT SharedResource : 1;
UINT DiscardRenderTarget : 1;
UINT Video : 1;
UINT CaptureBuffer : 1;
UINT Primary : 1;
UINT Texture : 1;
UINT CubeMap : 1;
UINT Volume : 1;
UINT VertexBuffer : 1;
UINT IndexBuffer : 1;
UINT DecodeRenderTarget : 1;
UINT DecodeCompressedBuffer : 1;
UINT VideoProcessRenderTarget : 1;
UINT CpuOptimized : 1;
UINT MightDrawFromLocked : 1;
UINT Overlay : 1;
UINT MatchGdiPrimary : 1;
UINT InterlacedRefresh : 1;
UINT TextApi : 1;
UINT RestrictedContent : 1;
UINT RestrictSharedAccess : 1;
};
UINT Value;
};
} D3DDDI_RESOURCEFLAGS;
Members
RenderTarget
Setting this member is equivalent to setting the first bit of the 32-bit Value member (0x00000001).
ZBuffer
A UINT value that specifies whether the surface is the z-buffer. The z-buffer contains bit-depth information that is used to determine which pixels are visible and which are obscured. The z-buffer contains information that cannot be displayed.
Setting this member is equivalent to setting the second bit of the 32-bit Value member (0x00000002).
Dynamic
A UINT value that specifies whether the surface is updated frequently. This bit-field flag cannot be used with the HintStatic bit-field flag.
Setting this member is equivalent to setting the third bit of the 32-bit Value member (0x00000004).
HintStatic
A UINT value that specifies whether the surface is updated infrequently but still must allow access. This bit-field flag cannot be used with the Dynamic bit-field flag.
Setting this member is equivalent to setting the fourth bit of the 32-bit Value member (0x00000008).
AutogenMipmap
A UINT value that specifies whether the MIP-map sublevels for the surface are automatically generated.
Setting this member is equivalent to setting the fifth bit of the 32-bit Value member (0x00000010).
DMap
A UINT value that specifies whether the surface is a displacement-map texture that the displacement-map sampler can sample in the tessellation unit.
Setting this member is equivalent to setting the sixth bit of the 32-bit Value member (0x00000020).
WriteOnly
A UINT value that specifies whether the surface can only be written to. Read access from the surface might generate a general protection fault (GPF). If the surface is read from, the read results are not meaningful.
Setting this member is equivalent to setting the seventh bit of the 32-bit Value member (0x00000040).
NotLockable
A UINT value that specifies whether the render target is lockable. This bit-field flag is set on the primary and the back buffers if the flipping chain is not lockable, or on any render target that is not lockable. The driver can then do background optimization.
Even if this flag is set, the surface can still be locked, so the driver must handle this situation. However, such locks are infrequent and are not expected to be fast.
The driver can also determine whether the depth or stencil buffer is lockable by the presence of this bit-field flag.
Setting this member is equivalent to setting the eighth bit of the 32-bit Value member (0x00000080).
Points
A UINT value that specifies whether the surface contains vertex buffer data that can be used to render points and point sprites.
Setting this member is equivalent to setting the ninth bit of the 32-bit Value member (0x00000100).
RtPatches
A UINT value that specifies whether the surface contains vertex buffer data that can be used to render rt-patches.
Setting this member is equivalent to setting the tenth bit of the 32-bit Value member (0x00000200).
NPatches
A UINT value that specifies whether the surface contains vertex buffer data that can be used to render n-patches.
Setting this member is equivalent to setting the eleventh bit of the 32-bit Value member (0x00000400).
SharedResource
A UINT value that specifies whether multiple devices and processes share the surface.
Setting this member is equivalent to setting the twelfth bit of the 32-bit Value member (0x00000800).
DiscardRenderTarget
A UINT value that specifies whether the preservation of the surface is required. If the surface is used as a render target, its preservation is not required.
Setting this member is equivalent to setting the thirteenth bit of the 32-bit Value member (0x00001000).
Video
A UINT value that specifies whether the surface is a render target that contains video data.
Note that several render targets can be created with this flag, and if two or more of these render targets belong to the same Microsoft Direct3D context, the driver determines that these render targets should all display the same video stream regardless of whether the render target surfaces are attached to each other.
Setting this member is equivalent to setting the fourteenth bit of the 32-bit Value member (0x00002000).
CaptureBuffer
A UINT value that specifies whether the resource is a capture buffer.
Setting this member is equivalent to setting the fifteenth bit of the 32-bit Value member (0x00004000).
Primary
A UINT value that specifies whether the surface is the primary surface--that is, whether the surface is currently visible to the user.
Setting this member is equivalent to setting the sixteenth bit of the 32-bit Value member (0x00008000).
Texture
A UINT value that specifies whether the surface can be used as a texture.
Setting this member is equivalent to setting the seventeenth bit of the 32-bit Value member (0x00010000).
CubeMap
A UINT value that specifies whether the surface is a cubic-environment map. This bit-field flag requires that the Texture bit-field flag is set.
Setting this member is equivalent to setting the eighteenth bit of the 32-bit Value member (0x00020000).
Volume
A UINT value that specifies whether the surface has depth, in addition to width and height--that is, whether the surface is a volume. This bit-field flag requires that the Texture bit-field flag is set.
Setting this member is equivalent to setting the nineteenth bit of the 32-bit Value member (0x00040000).
VertexBuffer
A UINT value that specifies whether the surface is a vertex buffer (that is, stores vertices).
Setting this member is equivalent to setting the twentieth bit of the 32-bit Value member (0x00080000).
IndexBuffer
A UINT value that specifies whether the surface is an index buffer (that is, stores indices).
Setting this member is equivalent to setting the twenty-first bit of the 32-bit Value member (0x00100000).
DecodeRenderTarget
A UINT value that specifies whether the surface is used as a render target for Microsoft DirectX Video Acceleration (DirectX VA) decoding.
Setting this member is equivalent to setting the twenty-second bit of the 32-bit Value member (0x00200000).
DecodeCompressedBuffer
A UINT value that specifies whether the surface contains compressed buffer information for DirectX VA decoding.
Setting this member is equivalent to setting the twenty-third bit of the 32-bit Value member (0x00400000).
VideoProcessRenderTarget
A UINT value that specifies whether the surface is used as a render target for DirectX VA video processing.
Setting this member is equivalent to setting the twenty-fourth bit of the 32-bit Value member (0x00800000).
CpuOptimized
A UINT value that specifies whether the CPU frequently accesses the resource.
The driver should place the resource in a memory pool that the CPU can quickly access (for example, AGP memory). The display miniport driver should flag the memory as cacheable by setting the Cached bit-field flag in the Flags member of the DXGK_ALLOCATIONINFO structure when its DxgkDdiCreateAllocation function is called.
The CpuOptimized flag is typically set for render targets (both stand-alone render targets and textures).
Setting this member is equivalent to setting the twenty-fifth bit of the 32-bit Value member (0x01000000).
MightDrawFromLocked
A UINT value that specifies whether the driver is possibly requested to draw from a vertex buffer even if the vertex buffer is locked by the Direct3D runtime. This request means that the driver can, on occasion, receive calls to its DrawIndexedPrimitive, DrawIndexedPrimitive2, DrawPrimitive, and DrawPrimitive2 functions where the vertex data is referenced within a locked vertex buffer that is marked with MightDrawFromLocked. The runtime must make these types of calls in scenarios in which it performs software transform and lighting (rather than hardware). These scenarios do not typically occur.
However, because the runtime locked the vertex buffer, the driver cannot call the pfnUnlockCb function before calling the pfnRenderCb function. As a result, the driver must support the vertex buffer in a system or AGP memory segment; otherwise, the video memory manager rejects the rendering. The driver is not required to take any other special action because the runtime will not overwrite any data in the locked vertex buffer when the hardware actively renders from the vertex buffer.
Setting this member is equivalent to setting the twenty-sixth bit of the 32-bit Value member (0x02000000).
Overlay
A UINT value that specifies whether the resource is an overlay.
Setting this member is equivalent to setting the twenty-seventh bit of the 32-bit Value member (0x04000000).
MatchGdiPrimary
A UINT value that specifies whether the resource is a primary surface that matches all the properties of the current GDI primary surface that was created by using the D3DKMDT_SHAREDPRIMARYSURFACEDATA structure. For example, flipping from the matching primary surface to the current GDI primary surface and vice versa is possible.
Setting this member is equivalent to setting the twenty-eighth bit of the 32-bit Value member (0x08000000).
InterlacedRefresh
A UINT value that specifies whether the resource is a primary surface that is meant to be used in an interlaced display mode.
Setting this member is equivalent to setting the twenty-ninth bit of the 32-bit Value member (0x10000000).
TextApi
A UINT value that specifies whether the resource can be used for texture filtering or as an input stream source. If textures are created with the TextApi bit-field flag set, they cannot be used for texture filtering. If vertex buffers are created with the TextApi bit-field flag set, they cannot be used as input stream sources. The TextApi bit-field flag must be specified for vertex buffers and source surfaces that are used in calls to the ComposeRects function.
Setting this member is equivalent to setting the thirtieth bit of the 32-bit Value member (0x20000000).
RestrictedContent
Supported in Windows 7 and later versions.
A UINT value that specifies whether the resource contains protected content. In most situations, an application has explicitly enabled content protection before the application creates a restricted resource. However, the application does not have to explicitly enable content protection if it creates a restricted fullscreen exclusive mode swapchain.
Setting this member is equivalent to setting the thirty-first bit of the 32-bit Value member (0x40000000).
RestrictSharedAccess
Supported in Windows 7 and later versions.
A UINT value that specifies whether the runtime allows only specific processes access to the shared resource.
Setting this member is equivalent to setting the thirty-second bit of the 32-bit Value member (0x80000000).
Value
A 32-bit value that identifies the type of resource to create.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Available in Windows Vista and later versions of the Windows operating systems. |
| Header | d3dukmdt.h (include D3dumddi.h, D3dkmddi.h) |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for