diff --git a/FFXIVAPP.Client/App.cs b/FFXIVAPP.Client/App.cs index d97ec94e..b99fbd5a 100644 --- a/FFXIVAPP.Client/App.cs +++ b/FFXIVAPP.Client/App.cs @@ -53,35 +53,6 @@ namespace FFXIVAPP.Client { public partial class App { - #region Logger - - private static readonly Logger Logger = LogManager.GetCurrentClassLogger(); - private static List _availableAudioDevices; - private static IEnumerable _availableNetworkInterfaces; - - #endregion - - #region Property Bindings - - internal static PluginHost Plugins - { - get { return PluginHost.Instance; } - } - - internal static IEnumerable AvailableAudioDevices - { - get { return _availableAudioDevices ?? (_availableAudioDevices = new List(DirectSoundOut.Devices.Where(d => d.Guid != Guid.Empty))); } - } - - internal static IEnumerable AvailableNetworkInterfaces - { - get { return _availableNetworkInterfaces ?? (_availableNetworkInterfaces = NetworkInterface.GetAllNetworkInterfaces()); } - } - - public static string[] MArgs { get; private set; } - - #endregion - private App() { Startup += ApplicationStartup; @@ -237,6 +208,16 @@ private static void SettingsPropertyChanged(object sender, PropertyChangedEventA Initializer.StopNetworkWorker(); } break; + case "EnableDirectXHook": + if (Settings.Default.EnableDirectXHook) + { + Initializer.HookDirectX(); + } + else + { + Initializer.UnHookDirectX(); + } + break; case "EnableHelpLabels": Constants.EnableHelpLabels = Settings.Default.EnableHelpLabels; break; @@ -283,5 +264,34 @@ private static void SettingsSettingChanging(object sender, SettingChangingEventA { Logging.Log(Logger, String.Format("SettingChanging : [{0},{1}]", e.SettingKey, e.NewValue)); } + + #region Logger + + private static readonly Logger Logger = LogManager.GetCurrentClassLogger(); + private static List _availableAudioDevices; + private static IEnumerable _availableNetworkInterfaces; + + #endregion + + #region Property Bindings + + internal static PluginHost Plugins + { + get { return PluginHost.Instance; } + } + + internal static IEnumerable AvailableAudioDevices + { + get { return _availableAudioDevices ?? (_availableAudioDevices = new List(DirectSoundOut.Devices.Where(d => d.Guid != Guid.Empty))); } + } + + internal static IEnumerable AvailableNetworkInterfaces + { + get { return _availableNetworkInterfaces ?? (_availableNetworkInterfaces = NetworkInterface.GetAllNetworkInterfaces()); } + } + + public static string[] MArgs { get; private set; } + + #endregion } } diff --git a/FFXIVAPP.Client/AppBootstrapper.cs b/FFXIVAPP.Client/AppBootstrapper.cs index e6b20691..0b1675d1 100644 --- a/FFXIVAPP.Client/AppBootstrapper.cs +++ b/FFXIVAPP.Client/AppBootstrapper.cs @@ -49,21 +49,6 @@ internal class AppBootstrapper : INotifyPropertyChanged #endregion - #region Property Bindings - - private static AppBootstrapper _instance; - - public static AppBootstrapper Instance - { - get { return _instance ?? (_instance = new AppBootstrapper()); } - } - - #endregion - - #region Declarations - - #endregion - /*main entry to app * used for: * initializing settings @@ -203,6 +188,21 @@ private void ProcessDetachCheckTimerOnElapsed(object sender, ElapsedEventArgs el } } + #region Property Bindings + + private static AppBootstrapper _instance; + + public static AppBootstrapper Instance + { + get { return _instance ?? (_instance = new AppBootstrapper()); } + } + + #endregion + + #region Declarations + + #endregion + #region Loading Functions #endregion diff --git a/FFXIVAPP.Client/Constants.cs b/FFXIVAPP.Client/Constants.cs index 54afbfbf..043f9544 100644 --- a/FFXIVAPP.Client/Constants.cs +++ b/FFXIVAPP.Client/Constants.cs @@ -36,11 +36,18 @@ using FFXIVAPP.Client.Models; using FFXIVAPP.Common.Core.Constant; using FFXIVAPP.Common.Helpers; +using FFXIVAPP.Hooker; namespace FFXIVAPP.Client { public static partial class Constants { + #region DirectX + + public static HookProcess HookProcess { get; set; } + + #endregion + #region Declarations public static readonly string[] Supported = diff --git a/FFXIVAPP.Client/FFXIVAPP.Client.csproj b/FFXIVAPP.Client/FFXIVAPP.Client.csproj index e22d17f6..0d0ae220 100644 --- a/FFXIVAPP.Client/FFXIVAPP.Client.csproj +++ b/FFXIVAPP.Client/FFXIVAPP.Client.csproj @@ -31,6 +31,8 @@ 1.0.0.%2a false true + + x86 @@ -137,6 +139,7 @@ + @@ -170,7 +173,6 @@ - @@ -190,7 +192,6 @@ - @@ -403,7 +404,12 @@ false - + + + {d425cf86-abeb-44fc-9413-318b4c1617b5} + FFXIVAPP.Hooker + + + + + + Compiles the effect10 from memory. + + The data ref. + Length of the data. + The SRC file name ref. + The defines ref. + The include ref. + The h LSL flags. + The f X flags. + The compiled effect out. + The errors out. + Result code. + HRESULT D3D10CompileEffectFromMemory([In] void* pData,[In] SIZE_T DataLength,[In] const char* pSrcFileName,[In, Buffer, Optional] const D3D_SHADER_MACRO* pDefines,[In] ID3DInclude* pInclude,[In] D3DCOMPILE_SHADER_FLAGS HLSLFlags,[In] D3DCOMPILE_EFFECT_FLAGS FXFlags,[In] ID3D10Blob** ppCompiledEffect,[In] ID3D10Blob** ppErrors) + + + +

Retrieves a specific part from a compilation result.

+
+

A reference to uncompiled shader data; either ASCII HLSL code or a compiled effect.

+

Length of uncompiled shader data that pSrcData points to.

+

A -typed value that specifies the part of the buffer to retrieve.

+

Flags that indicate how to retrieve the blob part. Currently, no flags are defined.

+

The address of a reference to the ID3DBlob interface that is used to retrieve the specified part of the buffer.

+

Returns one of the following Direct3D 10 Return Codes.

+ +

retrieves the part of a blob (arbitrary length data buffer) that contains the type of data that the Part parameter specifies.

+
+ + ff728674 + HRESULT D3DGetBlobPart([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] D3D_BLOB_PART Part,[In] unsigned int Flags,[Out] ID3D10Blob** ppPart) + D3DGetBlobPart +
+ + +

Decompresses one or more shaders from a compressed set.

+
+

A reference to uncompiled shader data; either ASCII HLSL code or a compiled effect.

+

Length of uncompiled shader data that pSrcData points to.

+

The number of shaders to decompress.

+

The index of the first shader to decompress.

+

An array of indexes that represent the shaders to decompress.

+

Flags that indicate how to decompress. Currently, no flags are defined.

+

The address of a reference to the ID3DBlob interface that is used to retrieve the decompressed shader data.

+

A reference to a variable that receives the total number of shaders that decompressed.

+

Returns one of the following Direct3D 10 Return Codes.

+ + ff728673 + HRESULT D3DDecompressShaders([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] unsigned int uNumShaders,[In] unsigned int uStartIndex,[In, Buffer, Optional] unsigned int* pIndices,[In] unsigned int uFlags,[Out, Buffer] ID3D10Blob** ppShaders,[Out, Optional] unsigned int* pTotalShaders) + D3DDecompressShaders +
+ + +

Disassembles compiled HLSL code.

+
+

A reference to source data as compiled HLSL code.

+

Length of pSrcData.

+

Flags affecting the behavior of . Flags can be a combination of zero or more of the following values.

FlagDescription
Enable the output of color codes.
Enable the output of default values.
Enable instruction numbering.
No effect.

?

+

The optional comment string at the top of the shader that identifies the shader constants and variables.

+

A reference to a buffer that receives the interface that accesses assembly text.

+

Returns one of the following Direct3D 10 Return Codes.

+ + dd607326 + HRESULT D3DDisassemble([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] D3DCOMPILE_DISASM_FLAGS Flags,[In, Optional] const char* szComments,[Out] ID3D10Blob** ppDisassembly) + D3DDisassemble +
+ + +

Compile HLSL code or an effect file into bytecode for a given target.

+
+

A reference to uncompiled shader data; either ASCII HLSL code or a compiled effect.

+

Length of pSrcData.

+

Optional. You can use this parameter for strings that specify error messages. If not used, set to null.

+

Optional. An array of null-terminated macro definitions (see ).

+

Optional. A reference to an for handling include files. Setting this to null will cause a compile error if a shader contains a #include. You can pass the D3D_COMPILE_STANDARD_FILE_INCLUDE macro, which is a reference to a default include handler. This default include handler includes files that are relative to the current directory and files that are relative to the directory of the initial source file. When you use D3D_COMPILE_STANDARD_FILE_INCLUDE, you must specify the source file name in the pSourceName parameter; the compiler will derive the initial relative directory from pSourceName.

#define D3D_COMPILE_STANDARD_FILE_INCLUDE ((*)()1)
+

The name of the shader entry point function where shader execution begins. When you compile an effect, ignores pEntrypoint; we recommend that you set pEntrypoint to null because it is good programming practice to set a reference parameter to null if the called function will not use it.

+

A string that specifies the shader target or set of shader features to compile against. The shader target can be shader model 2, shader model 3, shader model 4, or shader model 5. The target can also be an effect type (for example, fx_4_1).

+

Shader compile options.

+

Effect compile options. When you compile a shader and not an effect file, ignores Flags2; we recommend that you set Flags2 to zero because it is good programming practice to set a nonreference parameter to zero if the called function will not use it.

+

The address of a ID3DBlob that contains the compiled code.

+

Optional. A reference to an ID3DBlob that contains compiler error messages, or null if there were no errors.

+

Returns one of the Direct3D 10 Return Codes.

+ + dd607324 + HRESULT D3DCompile([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In, Optional] const char* pSourceName,[In, Buffer, Optional] const D3D_SHADER_MACRO* pDefines,[In, Optional] ID3DInclude* pInclude,[In] const char* pEntrypoint,[In] const char* pTarget,[In] D3DCOMPILE_SHADER_FLAGS Flags1,[In] D3DCOMPILE_EFFECT_FLAGS Flags2,[Out] ID3D10Blob** ppCode,[Out, Optional] ID3D10Blob** ppErrorMsgs) + D3DCompile +
+ + +

Removes unwanted blobs from a compilation result.

+
+

A reference to source data as compiled HLSL code.

+

Length of pSrcData.

+

Strip flag options, represented by .

+

A reference to a variable that receives a reference to the ID3DBlob interface that you can use to access the unwanted stripped out shader code.

+

Returns one of the Direct3D 10 Return Codes.

+ + dd607335 + HRESULT D3DStripShader([In, Buffer] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In] D3DCOMPILER_STRIP_FLAGS uStripFlags,[Out] ID3D10Blob** ppStrippedBlob) + D3DStripShader +
+ + +

Preprocesses uncompiled HLSL code.

+
+

A reference to uncompiled shader data; either ASCII HLSL code or a compiled effect.

+

Length of pSrcData.

+

Optional. The name of the file that contains the uncompiled HLSL code.

+

Optional. An array of null-terminated macro definitions (see ).

+

Optional. A reference to an for handling include files. Setting this to null will cause a compile error if a shader contains a #include. You can pass the D3D_COMPILE_STANDARD_FILE_INCLUDE macro, which is a reference to a default include handler. This default include handler includes files that are relative to the current directory and files that are relative to the directory of the initial source file. When you use D3D_COMPILE_STANDARD_FILE_INCLUDE, you must specify the source file name in the pSourceName parameter; the compiler will derive the initial relative directory from pSourceName.

#define D3D_COMPILE_STANDARD_FILE_INCLUDE ((*)()1)
+

The address of a ID3DBlob that contains the compiled code.

+

Optional. A reference to an ID3DBlob that contains compiler error messages, or null if there were no errors.

+

Returns one of the Direct3D 10 Return Codes.

+ +

outputs #line directives and preserves line numbering of source input so that output line numbering can be properly related to the input source.

+
+ + dd607332 + HRESULT D3DPreprocess([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In, Optional] const char* pSourceName,[In, Buffer, Optional] const D3D_SHADER_MACRO* pDefines,[In, Optional] ID3DInclude* pInclude,[Out] ID3D10Blob** ppCodeText,[Out, Optional] ID3D10Blob** ppErrorMsgs) + D3DPreprocess +
+ + +

Compresses a set of shaders into a more compact form.

+
+

The number of shaders to compress.

+

An array of structures that describe the set of shaders to compress.

+

Flags that indicate how to compress the shaders. Currently, only the D3D_COMPRESS_SHADER_KEEP_ALL_PARTS (0x00000001) flag is defined.

+

The address of a reference to the ID3DBlob interface that is used to retrieve the compressed shader data.

+

Returns one of the following Direct3D 10 Return Codes.

+ + ff728671 + HRESULT D3DCompressShaders([In] unsigned int uNumShaders,[In, Buffer] D3D_SHADER_DATA* pShaderData,[In] unsigned int uFlags,[Out] ID3D10Blob** ppCompressedData) + D3DCompressShaders +
+ + +

Gets a reference to a reflection interface.

+
+

A reference to source data as compiled HLSL code.

+

Length of pSrcData.

+

The reference of the COM interface to use. For example, IID_ID3D11ShaderReflection or IID_ID3D10ShaderReflection.

+

A reference to a reflection interface.

+

Returns one of the following Direct3D 10 Return Codes.

+ +

Shader code contains metadata that can be inspected using the reflection APIs.

The following code illustrates retrieving a Interface from a shader.

 pd3dDevice->CreatePixelShader( pPixelShaderBuffer->GetBufferPointer(), pPixelShaderBuffer->GetBufferSize(), g_pPSClassLinkage, &g_pPixelShader ); * pReflector = null; 	
+            ( pPixelShaderBuffer->GetBufferPointer(), pPixelShaderBuffer->GetBufferSize(),  IID_ID3D11ShaderReflection, (void**) &pReflector);	
+            
+
+ + dd607334 + HRESULT D3DReflect([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] const GUID& pInterface,[Out] void** ppReflector) + D3DReflect +
+ + +

Gets the input signature from a compilation result.

+
+

A reference to source data as compiled HLSL code.

+

Length of pSrcData.

+

Optional. A reference to an that contains a compiled shader.

+

Returns one of the following Direct3D 10 Return Codes.

+ + dd607330 + HRESULT D3DGetInputSignatureBlob([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppSignatureBlob) + D3DGetInputSignatureBlob +
+ + +

Gets the input and output signatures from a compilation result.

+
+

A reference to source data as compiled HLSL code.

+

Length of pSrcData.

+

Optional. A reference to an that contains a compiled shader.

+

Returns one of the following Direct3D 10 Return Codes.

+ + dd607329 + HRESULT D3DGetInputAndOutputSignatureBlob([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppSignatureBlob) + D3DGetInputAndOutputSignatureBlob +
+ + +

Gets the output signature from a compilation result.

+
+

A reference to source data as compiled HLSL code.

+

Length of pSrcData.

+

Optional. A reference to an that contains a compiled shader.

+

Returns one of the following Direct3D 10 Return Codes.

+ + dd607331 + HRESULT D3DGetOutputSignatureBlob([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppSignatureBlob) + D3DGetOutputSignatureBlob +
+ + +

Gets shader debug information.

+
+

A reference to source data; either uncompiled or compiled HLSL code.

+

Length of pSrcData.

+

Optional. A reference to an that contains debug information.

+

Returns one of the following Direct3D 10 Return Codes.

+ +

Debug information is embedded in the body of the shader after calling .

+
+ + dd607328 + HRESULT D3DGetDebugInfo([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppDebugInfo) + D3DGetDebugInfo +
+ + +

Values that identify the indended use of a constant-data buffer.

+
+ +

-typed values are specified in the uFlags member of the structure.

+
+ + ff728729 + D3D_SHADER_CBUFFER_FLAGS + D3D_SHADER_CBUFFER_FLAGS +
+ + +

Bind the constant buffer to an input slot defined in HLSL code (instead of letting the compiler choose the input slot).

+
+ + ff728729 + D3D_CBF_USERPACKED + D3D_CBF_USERPACKED +
+ + + None. + + + None + None + + + +

Values that identify the intended use of constant-buffer data.

+
+ + ff728722 + D3D_CBUFFER_TYPE + D3D_CBUFFER_TYPE +
+ + +

A buffer containing scalar constants.

+
+ + ff728722 + D3D_CT_CBUFFER + D3D_CT_CBUFFER +
+ + +

A buffer containing texture data.

+
+ + ff728722 + D3D_CT_TBUFFER + D3D_CT_TBUFFER +
+ + +

A buffer containing interface references.

+
+ + ff728722 + D3D_CT_INTERFACE_POINTERS + D3D_CT_INTERFACE_POINTERS +
+ + +

A buffer containing binding information.

+
+ + ff728722 + D3D_CT_RESOURCE_BIND_INFO + D3D_CT_RESOURCE_BIND_INFO +
+ + + No documentation. + + + D3DCOMPILE_DISASM_FLAGS + D3DCOMPILE_DISASM_FLAGS + + + + No documentation. + + + D3D_DISASM_ENABLE_COLOR_CODE + D3D_DISASM_ENABLE_COLOR_CODE + + + + No documentation. + + + D3D_DISASM_ENABLE_DEFAULT_VALUE_PRINTS + D3D_DISASM_ENABLE_DEFAULT_VALUE_PRINTS + + + + No documentation. + + + D3D_DISASM_ENABLE_INSTRUCTION_NUMBERING + D3D_DISASM_ENABLE_INSTRUCTION_NUMBERING + + + + No documentation. + + + D3D_DISASM_ENABLE_INSTRUCTION_CYCLE + D3D_DISASM_ENABLE_INSTRUCTION_CYCLE + + + + No documentation. + + + D3D_DISASM_DISABLE_DEBUG_INFO + D3D_DISASM_DISABLE_DEBUG_INFO + + + + None. + + + None + None + + + + No documentation. + + + D3DCOMPILE_EFFECT_FLAGS + D3DCOMPILE_EFFECT_FLAGS + + + + No documentation. + + + D3DCOMPILE_EFFECT_CHILD_EFFECT + D3DCOMPILE_EFFECT_CHILD_EFFECT + + + + No documentation. + + + D3DCOMPILE_EFFECT_ALLOW_SLOW_OPS + D3DCOMPILE_EFFECT_ALLOW_SLOW_OPS + + + + None. + + + None + None + + + +

Values that indicate the location of a shader #include file.

+
+ +

You pass a -typed value to the IncludeType parameter in a call to the method to indicate the location of the #include file.

+
+ + ff728723 + D3D_INCLUDE_TYPE + D3D_INCLUDE_TYPE +
+ + +

The local directory.

+
+ + ff728723 + D3D_INCLUDE_LOCAL + D3D_INCLUDE_LOCAL +
+ + +

The system directory.

+
+ + ff728723 + D3D_INCLUDE_SYSTEM + D3D_INCLUDE_SYSTEM +
+ + +

Values that indicate how the pipeline interprets vertex data that is bound to the input-assembler stage. These primitive topology values determine how the vertex data is rendered on screen.

+
+ +

Use the method and a value from to bind a primitive topology to the input-assembler stage. Use the method to retrieve the primitive topology for the input-assembler stage.

The following diagram shows the various primitive types for a geometry shader object.

+
+ + ff728726 + D3D_PRIMITIVE + D3D_PRIMITIVE +
+ + + No documentation. + + + D3D_PRIMITIVE_UNDEFINED + D3D_PRIMITIVE_UNDEFINED + + + + No documentation. + + + D3D_PRIMITIVE_POINT + D3D_PRIMITIVE_POINT + + + + No documentation. + + + D3D_PRIMITIVE_LINE + D3D_PRIMITIVE_LINE + + + + No documentation. + + + D3D_PRIMITIVE_TRIANGLE + D3D_PRIMITIVE_TRIANGLE + + + + No documentation. + + + D3D_PRIMITIVE_LINE_ADJ + D3D_PRIMITIVE_LINE_ADJ + + + + No documentation. + + + D3D_PRIMITIVE_TRIANGLE_ADJ + D3D_PRIMITIVE_TRIANGLE_ADJ + + + + No documentation. + + + D3D_PRIMITIVE_1_CONTROL_POINT_PATCH + D3D_PRIMITIVE_1_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_2_CONTROL_POINT_PATCH + D3D_PRIMITIVE_2_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_3_CONTROL_POINT_PATCH + D3D_PRIMITIVE_3_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_4_CONTROL_POINT_PATCH + D3D_PRIMITIVE_4_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_5_CONTROL_POINT_PATCH + D3D_PRIMITIVE_5_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_6_CONTROL_POINT_PATCH + D3D_PRIMITIVE_6_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_7_CONTROL_POINT_PATCH + D3D_PRIMITIVE_7_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_8_CONTROL_POINT_PATCH + D3D_PRIMITIVE_8_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_9_CONTROL_POINT_PATCH + D3D_PRIMITIVE_9_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_10_CONTROL_POINT_PATCH + D3D_PRIMITIVE_10_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_11_CONTROL_POINT_PATCH + D3D_PRIMITIVE_11_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_12_CONTROL_POINT_PATCH + D3D_PRIMITIVE_12_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_13_CONTROL_POINT_PATCH + D3D_PRIMITIVE_13_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_14_CONTROL_POINT_PATCH + D3D_PRIMITIVE_14_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_15_CONTROL_POINT_PATCH + D3D_PRIMITIVE_15_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_16_CONTROL_POINT_PATCH + D3D_PRIMITIVE_16_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_17_CONTROL_POINT_PATCH + D3D_PRIMITIVE_17_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_18_CONTROL_POINT_PATCH + D3D_PRIMITIVE_18_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_19_CONTROL_POINT_PATCH + D3D_PRIMITIVE_19_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_20_CONTROL_POINT_PATCH + D3D_PRIMITIVE_20_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_21_CONTROL_POINT_PATCH + D3D_PRIMITIVE_21_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_22_CONTROL_POINT_PATCH + D3D_PRIMITIVE_22_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_23_CONTROL_POINT_PATCH + D3D_PRIMITIVE_23_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_24_CONTROL_POINT_PATCH + D3D_PRIMITIVE_24_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_25_CONTROL_POINT_PATCH + D3D_PRIMITIVE_25_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_26_CONTROL_POINT_PATCH + D3D_PRIMITIVE_26_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_27_CONTROL_POINT_PATCH + D3D_PRIMITIVE_27_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_28_CONTROL_POINT_PATCH + D3D_PRIMITIVE_28_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_29_CONTROL_POINT_PATCH + D3D_PRIMITIVE_29_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_30_CONTROL_POINT_PATCH + D3D_PRIMITIVE_30_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_31_CONTROL_POINT_PATCH + D3D_PRIMITIVE_31_CONTROL_POINT_PATCH + + + + No documentation. + + + D3D_PRIMITIVE_32_CONTROL_POINT_PATCH + D3D_PRIMITIVE_32_CONTROL_POINT_PATCH + + + +

Values that identify the data types that can be stored in a register.

+
+ +

A register component type is specified in the ComponentType member of the structure.

+
+ + ff728727 + D3D_REGISTER_COMPONENT_TYPE + D3D_REGISTER_COMPONENT_TYPE +
+ + +

The data type is unknown.

+
+ + ff728727 + D3D_REGISTER_COMPONENT_UNKNOWN + D3D_REGISTER_COMPONENT_UNKNOWN +
+ + +

32-bit unsigned integer.

+
+ + ff728727 + D3D_REGISTER_COMPONENT_UINT32 + D3D_REGISTER_COMPONENT_UINT32 +
+ + +

32-bit signed integer.

+
+ + ff728727 + D3D_REGISTER_COMPONENT_SINT32 + D3D_REGISTER_COMPONENT_SINT32 +
+ + +

32-bit floating-point number.

+
+ + ff728727 + D3D_REGISTER_COMPONENT_FLOAT32 + D3D_REGISTER_COMPONENT_FLOAT32 +
+ + +

Values that identify the return type of a resource.

+
+ +

A resource return type is specified in the ReturnType member of the structure.

+
+ + ff728728 + D3D_RESOURCE_RETURN_TYPE + D3D_RESOURCE_RETURN_TYPE +
+ + +

Return type is an unsigned integer value normalized to a value between 0 and 1.

+
+ + ff728728 + D3D_RETURN_TYPE_UNORM + D3D_RETURN_TYPE_UNORM +
+ + +

Return type is a signed integer value normalized to a value between -1 and 1.

+
+ + ff728728 + D3D_RETURN_TYPE_SNORM + D3D_RETURN_TYPE_SNORM +
+ + +

Return type is a signed integer.

+
+ + ff728728 + D3D_RETURN_TYPE_SINT + D3D_RETURN_TYPE_SINT +
+ + +

Return type is an unsigned integer.

+
+ + ff728728 + D3D_RETURN_TYPE_UINT + D3D_RETURN_TYPE_UINT +
+ + +

Return type is a floating-point number.

+
+ + ff728728 + D3D_RETURN_TYPE_FLOAT + D3D_RETURN_TYPE_FLOAT +
+ + +

Return type is unknown.

+
+ + ff728728 + D3D_RETURN_TYPE_MIXED + D3D_RETURN_TYPE_MIXED +
+ + +

Return type is a double-precision value.

+
+ + ff728728 + D3D_RETURN_TYPE_DOUBLE + D3D_RETURN_TYPE_DOUBLE +
+ + +

Return type is a multiple-dword type, such as a double or uint64, and the component is continued from the previous component that was declared. The first component represents the lower bits.

+
+ + ff728728 + D3D_RETURN_TYPE_CONTINUED + D3D_RETURN_TYPE_CONTINUED +
+ + + No documentation. + + + D3DCOMPILE_SECDATA_FLAGS + D3DCOMPILE_SECDATA_FLAGS + + + + None. + + + None + None + + + +

Values that identify parts of the content of an arbitrary length data buffer.

+
+ +

These values are passed to the function.

+
+ + ff728720 + D3D_BLOB_PART + D3D_BLOB_PART +
+ + +

The blob part is an input signature.

+
+ + ff728720 + D3D_BLOB_INPUT_SIGNATURE_BLOB + D3D_BLOB_INPUT_SIGNATURE_BLOB +
+ + +

The blob part is an output signature.

+
+ + ff728720 + D3D_BLOB_OUTPUT_SIGNATURE_BLOB + D3D_BLOB_OUTPUT_SIGNATURE_BLOB +
+ + +

The blob part is an input and output signature.

+
+ + ff728720 + D3D_BLOB_INPUT_AND_OUTPUT_SIGNATURE_BLOB + D3D_BLOB_INPUT_AND_OUTPUT_SIGNATURE_BLOB +
+ + +

The blob part is a patch constant signature.

+
+ + ff728720 + D3D_BLOB_PATCH_CONSTANT_SIGNATURE_BLOB + D3D_BLOB_PATCH_CONSTANT_SIGNATURE_BLOB +
+ + +

The blob part is all signature.

+
+ + ff728720 + D3D_BLOB_ALL_SIGNATURE_BLOB + D3D_BLOB_ALL_SIGNATURE_BLOB +
+ + +

The blob part is debug information.

+
+ + ff728720 + D3D_BLOB_DEBUG_INFO + D3D_BLOB_DEBUG_INFO +
+ + +

The blob part is a legacy shader.

+
+ + ff728720 + D3D_BLOB_LEGACY_SHADER + D3D_BLOB_LEGACY_SHADER +
+ + +

The blob part is an XNA prepass shader.

+
+ + ff728720 + D3D_BLOB_XNA_PREPASS_SHADER + D3D_BLOB_XNA_PREPASS_SHADER +
+ + +

The blob part is an XNA shader.

+
+ + ff728720 + D3D_BLOB_XNA_SHADER + D3D_BLOB_XNA_SHADER +
+ + +

The blob part is a test alternate shader.

Note??This value identifies a test part and is only produced by special compiler versions. Therefore, this part type is typically not present in shaders.

+
+ + ff728720 + D3D_BLOB_TEST_ALTERNATE_SHADER + D3D_BLOB_TEST_ALTERNATE_SHADER +
+ + +

The blob part is test compilation details.

Note??This value identifies a test part and is only produced by special compiler versions. Therefore, this part type is typically not present in shaders.

+
+ + ff728720 + D3D_BLOB_TEST_COMPILE_DETAILS + D3D_BLOB_TEST_COMPILE_DETAILS +
+ + +

The blob part is test compilation performance.

Note??This value identifies a test part and is only produced by special compiler versions. Therefore, this part type is typically not present in shaders.

+
+ + ff728720 + D3D_BLOB_TEST_COMPILE_PERF + D3D_BLOB_TEST_COMPILE_PERF +
+ + + No documentation. + + + D3DCOMPILE_SHADER_FLAGS + D3DCOMPILE_SHADER_FLAGS + + + + No documentation. + + + D3DCOMPILE_DEBUG + D3DCOMPILE_DEBUG + + + + No documentation. + + + D3DCOMPILE_SKIP_VALIDATION + D3DCOMPILE_SKIP_VALIDATION + + + + No documentation. + + + D3DCOMPILE_SKIP_OPTIMIZATION + D3DCOMPILE_SKIP_OPTIMIZATION + + + + No documentation. + + + D3DCOMPILE_PACK_MATRIX_ROW_MAJOR + D3DCOMPILE_PACK_MATRIX_ROW_MAJOR + + + + No documentation. + + + D3DCOMPILE_PACK_MATRIX_COLUMN_MAJOR + D3DCOMPILE_PACK_MATRIX_COLUMN_MAJOR + + + + No documentation. + + + D3DCOMPILE_PARTIAL_PRECISION + D3DCOMPILE_PARTIAL_PRECISION + + + + No documentation. + + + D3DCOMPILE_FORCE_VS_SOFTWARE_NO_OPT + D3DCOMPILE_FORCE_VS_SOFTWARE_NO_OPT + + + + No documentation. + + + D3DCOMPILE_FORCE_PS_SOFTWARE_NO_OPT + D3DCOMPILE_FORCE_PS_SOFTWARE_NO_OPT + + + + No documentation. + + + D3DCOMPILE_NO_PRESHADER + D3DCOMPILE_NO_PRESHADER + + + + No documentation. + + + D3DCOMPILE_AVOID_FLOW_CONTROL + D3DCOMPILE_AVOID_FLOW_CONTROL + + + + No documentation. + + + D3DCOMPILE_PREFER_FLOW_CONTROL + D3DCOMPILE_PREFER_FLOW_CONTROL + + + + No documentation. + + + D3DCOMPILE_ENABLE_STRICTNESS + D3DCOMPILE_ENABLE_STRICTNESS + + + + No documentation. + + + D3DCOMPILE_ENABLE_BACKWARDS_COMPATIBILITY + D3DCOMPILE_ENABLE_BACKWARDS_COMPATIBILITY + + + + No documentation. + + + D3DCOMPILE_IEEE_STRICTNESS + D3DCOMPILE_IEEE_STRICTNESS + + + + No documentation. + + + D3DCOMPILE_OPTIMIZATION_LEVEL0 + D3DCOMPILE_OPTIMIZATION_LEVEL0 + + + + No documentation. + + + D3DCOMPILE_OPTIMIZATION_LEVEL1 + D3DCOMPILE_OPTIMIZATION_LEVEL1 + + + + No documentation. + + + D3DCOMPILE_OPTIMIZATION_LEVEL2 + D3DCOMPILE_OPTIMIZATION_LEVEL2 + + + + No documentation. + + + D3DCOMPILE_OPTIMIZATION_LEVEL3 + D3DCOMPILE_OPTIMIZATION_LEVEL3 + + + + No documentation. + + + D3DCOMPILE_RESERVED16 + D3DCOMPILE_RESERVED16 + + + + No documentation. + + + D3DCOMPILE_RESERVED17 + D3DCOMPILE_RESERVED17 + + + + No documentation. + + + D3DCOMPILE_WARNINGS_ARE_ERRORS + D3DCOMPILE_WARNINGS_ARE_ERRORS + + + + None. + + + None + None + + + +

Values that identify shader-input options.

+
+ +

-typed values are specified in the uFlags member of the structure.

+
+ + ff728730 + D3D_SHADER_INPUT_FLAGS + D3D_SHADER_INPUT_FLAGS +
+ + +

Assign a shader input to a register based on the register assignment in the HLSL code (instead of letting the compiler choose the register).

+
+ + ff728730 + D3D_SIF_USERPACKED + D3D_SIF_USERPACKED +
+ + +

Use a comparison sampler, which uses the SampleCmp (DirectX HLSL Texture Object) and SampleCmpLevelZero (DirectX HLSL Texture Object) sampling functions.

+
+ + ff728730 + D3D_SIF_COMPARISON_SAMPLER + D3D_SIF_COMPARISON_SAMPLER +
+ + +

A 2-bit value for encoding texture components.

+
+ + ff728730 + D3D_SIF_TEXTURE_COMPONENT_0 + D3D_SIF_TEXTURE_COMPONENT_0 +
+ + +

A 2-bit value for encoding texture components.

+
+ + ff728730 + D3D_SIF_TEXTURE_COMPONENT_1 + D3D_SIF_TEXTURE_COMPONENT_1 +
+ + +

A 2-bit value for encoding texture components.

+
+ + ff728730 + D3D_SIF_TEXTURE_COMPONENTS + D3D_SIF_TEXTURE_COMPONENTS +
+ + + None. + + + None + None + + + +

Values that identify resource types that can be bound to a shader and that are reflected as part of the resource description for the shader.

+
+ +

-typed values are specified in the Type member of the structure.

+
+ + ff728731 + D3D_SHADER_INPUT_TYPE + D3D_SHADER_INPUT_TYPE +
+ + +

The shader resource is a constant buffer.

+
+ + ff728731 + D3D_SIT_CBUFFER + D3D_SIT_CBUFFER +
+ + +

The shader resource is a texture buffer.

+
+ + ff728731 + D3D_SIT_TBUFFER + D3D_SIT_TBUFFER +
+ + +

The shader resource is a texture.

+
+ + ff728731 + D3D_SIT_TEXTURE + D3D_SIT_TEXTURE +
+ + +

The shader resource is a sampler.

+
+ + ff728731 + D3D_SIT_SAMPLER + D3D_SIT_SAMPLER +
+ + +

The shader resource is a read-and-write buffer.

+
+ + ff728731 + D3D_SIT_UAV_RWTYPED + D3D_SIT_UAV_RWTYPED +
+ + +

The shader resource is a structured buffer.

For more information about structured buffer, see the Remarks section.

+
+ + ff728731 + D3D_SIT_STRUCTURED + D3D_SIT_STRUCTURED +
+ + +

The shader resource is a read-and-write structured buffer.

+
+ + ff728731 + D3D_SIT_UAV_RWSTRUCTURED + D3D_SIT_UAV_RWSTRUCTURED +
+ + +

The shader resource is a byte-address buffer.

+
+ + ff728731 + D3D_SIT_BYTEADDRESS + D3D_SIT_BYTEADDRESS +
+ + +

The shader resource is a read-and-write byte-address buffer.

+
+ + ff728731 + D3D_SIT_UAV_RWBYTEADDRESS + D3D_SIT_UAV_RWBYTEADDRESS +
+ + +

The shader resource is an append-structured buffer.

+
+ + ff728731 + D3D_SIT_UAV_APPEND_STRUCTURED + D3D_SIT_UAV_APPEND_STRUCTURED +
+ + +

The shader resource is a consume-structured buffer.

+
+ + ff728731 + D3D_SIT_UAV_CONSUME_STRUCTURED + D3D_SIT_UAV_CONSUME_STRUCTURED +
+ + +

The shader resource is a read-and-write structured buffer that uses the built-in counter to append or consume.

+
+ + ff728731 + D3D_SIT_UAV_RWSTRUCTURED_WITH_COUNTER + D3D_SIT_UAV_RWSTRUCTURED_WITH_COUNTER +
+ + +

Values that identify the class of a shader variable.

+
+ +

The class of a shader variable is not a programming class; the class identifies the variable class such as scalar, vector, object, and so on. -typed values are specified in the Class member of the structure.

+
+ + ff728733 + D3D_SHADER_VARIABLE_CLASS + D3D_SHADER_VARIABLE_CLASS +
+ + +

The shader variable is a scalar.

+
+ + ff728733 + D3D_SVC_SCALAR + D3D_SVC_SCALAR +
+ + +

The shader variable is a vector.

+
+ + ff728733 + D3D_SVC_VECTOR + D3D_SVC_VECTOR +
+ + +

The shader variable is a row-major matrix.

+
+ + ff728733 + D3D_SVC_MATRIX_ROWS + D3D_SVC_MATRIX_ROWS +
+ + +

The shader variable is a column-major matrix.

+
+ + ff728733 + D3D_SVC_MATRIX_COLUMNS + D3D_SVC_MATRIX_COLUMNS +
+ + +

The shader variable is an object.

+
+ + ff728733 + D3D_SVC_OBJECT + D3D_SVC_OBJECT +
+ + +

The shader variable is a structure.

+
+ + ff728733 + D3D_SVC_STRUCT + D3D_SVC_STRUCT +
+ + +

The shader variable is a class.

+
+ + ff728733 + D3D_SVC_INTERFACE_CLASS + D3D_SVC_INTERFACE_CLASS +
+ + +

The shader variable is an interface.

+
+ + ff728733 + D3D_SVC_INTERFACE_POINTER + D3D_SVC_INTERFACE_POINTER +
+ + +

Values that identify information about a shader variable.

+
+ +

A call to the method returns values in the uFlags member of a structure.

+
+ + ff728734 + D3D_SHADER_VARIABLE_FLAGS + D3D_SHADER_VARIABLE_FLAGS +
+ + +

Indicates that the registers assigned to this shader variable were explicitly declared in shader code (instead of automatically assigned by the compiler).

+
+ + ff728734 + D3D_SVF_USERPACKED + D3D_SVF_USERPACKED +
+ + +

Indicates that this variable is used by this shader. This value confirms that a particular shader variable (which can be common to many different shaders) is indeed used by a particular shader.

+
+ + ff728734 + D3D_SVF_USED + D3D_SVF_USED +
+ + +

Indicates that this variable is an interface.

+
+ + ff728734 + D3D_SVF_INTERFACE_POINTER + D3D_SVF_INTERFACE_POINTER +
+ + +

Indicates that this variable is a parameter of an interface.

+
+ + ff728734 + D3D_SVF_INTERFACE_PARAMETER + D3D_SVF_INTERFACE_PARAMETER +
+ + + None. + + + None + None + + + +

Values that identify various data, texture, and buffer types that can be assigned to a shader variable.

+
+ +

A call to the method returns a value in the Type member of a structure.

The types in a structured buffer describe the structure of the elements in the buffer. The layout of these types generally match their C++ struct counterparts. The following examples show structured buffers:

struct mystruct {float4 val; uint ind;}; RWStructuredBuffer<mystruct> rwbuf;	
+            RWStructuredBuffer<float3> rwbuf2;
+
+ + ff728735 + D3D_SHADER_VARIABLE_TYPE + D3D_SHADER_VARIABLE_TYPE +
+ + +

The variable is a void reference.

+
+ + ff728735 + D3D_SVT_VOID + D3D_SVT_VOID +
+ + +

The variable is a boolean.

+
+ + ff728735 + D3D_SVT_BOOL + D3D_SVT_BOOL +
+ + +

The variable is an integer.

+
+ + ff728735 + D3D_SVT_INT + D3D_SVT_INT +
+ + +

The variable is a floating-point number.

+
+ + ff728735 + D3D_SVT_FLOAT + D3D_SVT_FLOAT +
+ + +

The variable is a string.

+
+ + ff728735 + D3D_SVT_STRING + D3D_SVT_STRING +
+ + +

The variable is a texture.

+
+ + ff728735 + D3D_SVT_TEXTURE + D3D_SVT_TEXTURE +
+ + +

The variable is a 1D texture.

+
+ + ff728735 + D3D_SVT_TEXTURE1D + D3D_SVT_TEXTURE1D +
+ + +

The variable is a 2D texture.

+
+ + ff728735 + D3D_SVT_TEXTURE2D + D3D_SVT_TEXTURE2D +
+ + +

The variable is a 3D texture.

+
+ + ff728735 + D3D_SVT_TEXTURE3D + D3D_SVT_TEXTURE3D +
+ + +

The variable is a texture cube.

+
+ + ff728735 + D3D_SVT_TEXTURECUBE + D3D_SVT_TEXTURECUBE +
+ + +

The variable is a sampler.

+
+ + ff728735 + D3D_SVT_SAMPLER + D3D_SVT_SAMPLER +
+ + +

The variable is a pixel shader.

+
+ + ff728735 + D3D_SVT_SAMPLER1D + D3D_SVT_SAMPLER1D +
+ + +

The variable is a vertex shader.

+
+ + ff728735 + D3D_SVT_SAMPLER2D + D3D_SVT_SAMPLER2D +
+ + +

The variable is an unsigned integer.

+
+ + ff728735 + D3D_SVT_SAMPLER3D + D3D_SVT_SAMPLER3D +
+ + +

The variable is an 8-bit unsigned integer.

+
+ + ff728735 + D3D_SVT_SAMPLERCUBE + D3D_SVT_SAMPLERCUBE +
+ + +

The variable is a geometry shader.

+
+ + ff728735 + D3D_SVT_PIXELSHADER + D3D_SVT_PIXELSHADER +
+ + +

The variable is a rasterizer-state object.

+
+ + ff728735 + D3D_SVT_VERTEXSHADER + D3D_SVT_VERTEXSHADER +
+ + +

The variable is a depth-stencil-state object.

+
+ + ff728735 + D3D_SVT_PIXELFRAGMENT + D3D_SVT_PIXELFRAGMENT +
+ + +

The variable is a blend-state object.

+
+ + ff728735 + D3D_SVT_VERTEXFRAGMENT + D3D_SVT_VERTEXFRAGMENT +
+ + +

The variable is a buffer.

+
+ + ff728735 + D3D_SVT_UINT + D3D_SVT_UINT +
+ + +

The variable is a constant buffer.

+
+ + ff728735 + D3D_SVT_UINT8 + D3D_SVT_UINT8 +
+ + +

The variable is a texture buffer.

+
+ + ff728735 + D3D_SVT_GEOMETRYSHADER + D3D_SVT_GEOMETRYSHADER +
+ + +

The variable is a 1D-texture array.

+
+ + ff728735 + D3D_SVT_RASTERIZER + D3D_SVT_RASTERIZER +
+ + +

The variable is a 2D-texture array.

+
+ + ff728735 + D3D_SVT_DEPTHSTENCIL + D3D_SVT_DEPTHSTENCIL +
+ + +

The variable is a render-target view.

+
+ + ff728735 + D3D_SVT_BLEND + D3D_SVT_BLEND +
+ + +

The variable is a depth-stencil view.

+
+ + ff728735 + D3D_SVT_BUFFER + D3D_SVT_BUFFER +
+ + +

The variable is a 2D-multisampled texture.

+
+ + ff728735 + D3D_SVT_CBUFFER + D3D_SVT_CBUFFER +
+ + +

The variable is a 2D-multisampled-texture array.

+
+ + ff728735 + D3D_SVT_TBUFFER + D3D_SVT_TBUFFER +
+ + +

The variable is a texture-cube array.

+
+ + ff728735 + D3D_SVT_TEXTURE1DARRAY + D3D_SVT_TEXTURE1DARRAY +
+ + +

The variable holds a compiled hull-shader binary.

+
+ + ff728735 + D3D_SVT_TEXTURE2DARRAY + D3D_SVT_TEXTURE2DARRAY +
+ + +

The variable holds a compiled domain-shader binary.

+
+ + ff728735 + D3D_SVT_RENDERTARGETVIEW + D3D_SVT_RENDERTARGETVIEW +
+ + +

The variable is an interface.

+
+ + ff728735 + D3D_SVT_DEPTHSTENCILVIEW + D3D_SVT_DEPTHSTENCILVIEW +
+ + +

The variable holds a compiled compute-shader binary.

+
+ + ff728735 + D3D_SVT_TEXTURE2DMS + D3D_SVT_TEXTURE2DMS +
+ + +

The variable is a double precision (64-bit) floating-point number.

+
+ + ff728735 + D3D_SVT_TEXTURE2DMSARRAY + D3D_SVT_TEXTURE2DMSARRAY +
+ + +

The variable is a 1D read-and-write texture.

+
+ + ff728735 + D3D_SVT_TEXTURECUBEARRAY + D3D_SVT_TEXTURECUBEARRAY +
+ + +

The variable is an array of 1D read-and-write textures.

+
+ + ff728735 + D3D_SVT_HULLSHADER + D3D_SVT_HULLSHADER +
+ + +

The variable is a 2D read-and-write texture.

+
+ + ff728735 + D3D_SVT_DOMAINSHADER + D3D_SVT_DOMAINSHADER +
+ + +

The variable is an array of 2D read-and-write textures.

+
+ + ff728735 + D3D_SVT_INTERFACE_POINTER + D3D_SVT_INTERFACE_POINTER +
+ + +

The variable is a 3D read-and-write texture.

+
+ + ff728735 + D3D_SVT_COMPUTESHADER + D3D_SVT_COMPUTESHADER +
+ + +

The variable is a read-and-write buffer.

+
+ + ff728735 + D3D_SVT_DOUBLE + D3D_SVT_DOUBLE +
+ + +

The variable is a byte-address buffer.

+
+ + ff728735 + D3D_SVT_RWTEXTURE1D + D3D_SVT_RWTEXTURE1D +
+ + +

The variable is a read-and-write byte-address buffer.

+
+ + ff728735 + D3D_SVT_RWTEXTURE1DARRAY + D3D_SVT_RWTEXTURE1DARRAY +
+ + +

The variable is a structured buffer.

For more information about structured buffer, see the Remarks section.

+
+ + ff728735 + D3D_SVT_RWTEXTURE2D + D3D_SVT_RWTEXTURE2D +
+ + +

The variable is a read-and-write structured buffer.

+
+ + ff728735 + D3D_SVT_RWTEXTURE2DARRAY + D3D_SVT_RWTEXTURE2DARRAY +
+ + +

The variable is an append structured buffer.

+
+ + ff728735 + D3D_SVT_RWTEXTURE3D + D3D_SVT_RWTEXTURE3D +
+ + +

The variable is a consume structured buffer.

+
+ + ff728735 + D3D_SVT_RWBUFFER + D3D_SVT_RWBUFFER +
+ + +

The variable is a void reference.

+
+ + ff728735 + D3D_SVT_BYTEADDRESS_BUFFER + D3D_SVT_BYTEADDRESS_BUFFER +
+ + +

The variable is a boolean.

+
+ + ff728735 + D3D_SVT_RWBYTEADDRESS_BUFFER + D3D_SVT_RWBYTEADDRESS_BUFFER +
+ + +

The variable is an integer.

+
+ + ff728735 + D3D_SVT_STRUCTURED_BUFFER + D3D_SVT_STRUCTURED_BUFFER +
+ + +

The variable is a floating-point number.

+
+ + ff728735 + D3D_SVT_RWSTRUCTURED_BUFFER + D3D_SVT_RWSTRUCTURED_BUFFER +
+ + +

The variable is a string.

+
+ + ff728735 + D3D_SVT_APPEND_STRUCTURED_BUFFER + D3D_SVT_APPEND_STRUCTURED_BUFFER +
+ + +

The variable is a texture.

+
+ + ff728735 + D3D_SVT_CONSUME_STRUCTURED_BUFFER + D3D_SVT_CONSUME_STRUCTURED_BUFFER +
+ + +

Indicates shader type.

+
+ + ff476214 + D3D11_SHADER_VERSION_TYPE + D3D11_SHADER_VERSION_TYPE +
+ + +

Pixel shader.

+
+ + ff476214 + D3D11_SHVER_PIXEL_SHADER + D3D11_SHVER_PIXEL_SHADER +
+ + +

Vertex shader.

+
+ + ff476214 + D3D11_SHVER_VERTEX_SHADER + D3D11_SHVER_VERTEX_SHADER +
+ + +

Geometry shader.

+
+ + ff476214 + D3D11_SHVER_GEOMETRY_SHADER + D3D11_SHVER_GEOMETRY_SHADER +
+ + +

Hull shader.

+
+ + ff476214 + D3D11_SHVER_HULL_SHADER + D3D11_SHVER_HULL_SHADER +
+ + +

Domain shader.

+
+ + ff476214 + D3D11_SHVER_DOMAIN_SHADER + D3D11_SHVER_DOMAIN_SHADER +
+ + +

Compute shader.

+
+ + ff476214 + D3D11_SHVER_COMPUTE_SHADER + D3D11_SHVER_COMPUTE_SHADER +
+ + +

Strip flag options.

+
+ +

These flags are used by .

+
+ + dd607325 + D3DCOMPILER_STRIP_FLAGS + D3DCOMPILER_STRIP_FLAGS +
+ + +

Remove reflection data.

+
+ + dd607325 + D3DCOMPILER_STRIP_REFLECTION_DATA + D3DCOMPILER_STRIP_REFLECTION_DATA +
+ + +

Remove debug information.

+
+ + dd607325 + D3DCOMPILER_STRIP_DEBUG_INFO + D3DCOMPILER_STRIP_DEBUG_INFO +
+ + +

Remove test blob data.

+
+ + dd607325 + D3DCOMPILER_STRIP_TEST_BLOBS + D3DCOMPILER_STRIP_TEST_BLOBS +
+ + + None. + + + None + None + + + +

Values that identify shader parameters that use system-value semantics.

+
+ +

The values identify shader parameters that have predefined system-value semantics. These values are used in a shader-signature description. For more information about shader-signature description, see .

+
+ + ff728724 + D3D_NAME + D3D_NAME +
+ + +

This parameter does not use a predefined system-value semantic.

+
+ + ff728724 + D3D_NAME_UNDEFINED + D3D_NAME_UNDEFINED +
+ + +

This parameter contains position data.

+
+ + ff728724 + D3D_NAME_POSITION + D3D_NAME_POSITION +
+ + +

This parameter contains clip-distance data.

+
+ + ff728724 + D3D_NAME_CLIP_DISTANCE + D3D_NAME_CLIP_DISTANCE +
+ + +

This parameter contains cull-distance data.

+
+ + ff728724 + D3D_NAME_CULL_DISTANCE + D3D_NAME_CULL_DISTANCE +
+ + +

This parameter contains a render-target-array index.

+
+ + ff728724 + D3D_NAME_RENDER_TARGET_ARRAY_INDEX + D3D_NAME_RENDER_TARGET_ARRAY_INDEX +
+ + +

This parameter contains a viewport-array index.

+
+ + ff728724 + D3D_NAME_VIEWPORT_ARRAY_INDEX + D3D_NAME_VIEWPORT_ARRAY_INDEX +
+ + +

This parameter contains a vertex ID.

+
+ + ff728724 + D3D_NAME_VERTEX_ID + D3D_NAME_VERTEX_ID +
+ + +

This parameter contains a primitive ID.

+
+ + ff728724 + D3D_NAME_PRIMITIVE_ID + D3D_NAME_PRIMITIVE_ID +
+ + +

This parameter contains an instance ID.

+
+ + ff728724 + D3D_NAME_INSTANCE_ID + D3D_NAME_INSTANCE_ID +
+ + +

This parameter contains data that identifies whether or not the primitive faces the camera.

+
+ + ff728724 + D3D_NAME_IS_FRONT_FACE + D3D_NAME_IS_FRONT_FACE +
+ + +

This parameter contains a sampler-array index.

+
+ + ff728724 + D3D_NAME_SAMPLE_INDEX + D3D_NAME_SAMPLE_INDEX +
+ + +

This parameter contains one of four tessellation factors that correspond to the amount of parts that a quad patch is broken into along the given edge. This flag is used to tessellate a quad patch.

+
+ + ff728724 + D3D_NAME_FINAL_QUAD_EDGE_TESSFACTOR + D3D_NAME_FINAL_QUAD_EDGE_TESSFACTOR +
+ + +

This parameter contains one of two tessellation factors that correspond to the amount of parts that a quad patch is broken into vertically and horizontally within the patch. This flag is used to tessellate a quad patch.

+
+ + ff728724 + D3D_NAME_FINAL_QUAD_INSIDE_TESSFACTOR + D3D_NAME_FINAL_QUAD_INSIDE_TESSFACTOR +
+ + +

This parameter contains one of three tessellation factors that correspond to the amount of parts that a tri patch is broken into along the given edge. This flag is used to tessellate a tri patch.

+
+ + ff728724 + D3D_NAME_FINAL_TRI_EDGE_TESSFACTOR + D3D_NAME_FINAL_TRI_EDGE_TESSFACTOR +
+ + +

This parameter contains the tessellation factor that corresponds to the amount of parts that a tri patch is broken into within the patch. This flag is used to tessellate a tri patch.

+
+ + ff728724 + D3D_NAME_FINAL_TRI_INSIDE_TESSFACTOR + D3D_NAME_FINAL_TRI_INSIDE_TESSFACTOR +
+ + +

This parameter contains the tessellation factor that corresponds to the number of lines broken into within the patch. This flag is used to tessellate an isolines patch.

+
+ + ff728724 + D3D_NAME_FINAL_LINE_DETAIL_TESSFACTOR + D3D_NAME_FINAL_LINE_DETAIL_TESSFACTOR +
+ + +

This parameter contains the tessellation factor that corresponds to the number of lines that are created within the patch. This flag is used to tessellate an isolines patch.

+
+ + ff728724 + D3D_NAME_FINAL_LINE_DENSITY_TESSFACTOR + D3D_NAME_FINAL_LINE_DENSITY_TESSFACTOR +
+ + +

This parameter contains render-target data.

+
+ + ff728724 + D3D_NAME_TARGET + D3D_NAME_TARGET +
+ + +

This parameter contains depth data.

+
+ + ff728724 + D3D_NAME_DEPTH + D3D_NAME_DEPTH +
+ + +

This parameter contains alpha-coverage data.

+
+ + ff728724 + D3D_NAME_COVERAGE + D3D_NAME_COVERAGE +
+ + +

This parameter signifies that the value is greater than or equal to a reference value. This flag is used to specify conservative depth for a pixel shader.

+
+ + ff728724 + D3D_NAME_DEPTH_GREATER_EQUAL + D3D_NAME_DEPTH_GREATER_EQUAL +
+ + +

This parameter signifies that the value is less than or equal to a reference value. This flag is used to specify conservative depth for a pixel shader.

+
+ + ff728724 + D3D_NAME_DEPTH_LESS_EQUAL + D3D_NAME_DEPTH_LESS_EQUAL +
+ + +

Values that identify domain options for tessellator data.

+
+ +

The data domain defines the type of data. This enumeration is used by .

+
+ + ff728737 + D3D_TESSELLATOR_DOMAIN + D3D_TESSELLATOR_DOMAIN +
+ + +

The data type is undefined.

+
+ + ff728737 + D3D_TESSELLATOR_DOMAIN_UNDEFINED + D3D_TESSELLATOR_DOMAIN_UNDEFINED +
+ + +

Isoline data.

+
+ + ff728737 + D3D_TESSELLATOR_DOMAIN_ISOLINE + D3D_TESSELLATOR_DOMAIN_ISOLINE +
+ + +

Triangle data.

+
+ + ff728737 + D3D_TESSELLATOR_DOMAIN_TRI + D3D_TESSELLATOR_DOMAIN_TRI +
+ + +

Quad data.

+
+ + ff728737 + D3D_TESSELLATOR_DOMAIN_QUAD + D3D_TESSELLATOR_DOMAIN_QUAD +
+ + +

Values that identify output primitive types.

+
+ +

The output primitive type determines how the tessellator output data is organized; this enumeration is used by .

+
+ + ff728738 + D3D_TESSELLATOR_OUTPUT_PRIMITIVE + D3D_TESSELLATOR_OUTPUT_PRIMITIVE +
+ + +

The output primitive type is undefined.

+
+ + ff728738 + D3D_TESSELLATOR_OUTPUT_UNDEFINED + D3D_TESSELLATOR_OUTPUT_UNDEFINED +
+ + +

The output primitive type is a point.

+
+ + ff728738 + D3D_TESSELLATOR_OUTPUT_POINT + D3D_TESSELLATOR_OUTPUT_POINT +
+ + +

The output primitive type is a line.

+
+ + ff728738 + D3D_TESSELLATOR_OUTPUT_LINE + D3D_TESSELLATOR_OUTPUT_LINE +
+ + +

The output primitive type is a clockwise triangle.

+
+ + ff728738 + D3D_TESSELLATOR_OUTPUT_TRIANGLE_CW + D3D_TESSELLATOR_OUTPUT_TRIANGLE_CW +
+ + +

The output primitive type is a counter clockwise triangle.

+
+ + ff728738 + D3D_TESSELLATOR_OUTPUT_TRIANGLE_CCW + D3D_TESSELLATOR_OUTPUT_TRIANGLE_CCW +
+ + +

Values that identify partitioning options.

+
+ +

During tessellation, the partition option helps to determine how the algorithm chooses the next partition value; this enumeration is used by .

+
+ + ff728739 + D3D_TESSELLATOR_PARTITIONING + D3D_TESSELLATOR_PARTITIONING +
+ + +

The partitioning type is undefined.

+
+ + ff728739 + D3D_TESSELLATOR_PARTITIONING_UNDEFINED + D3D_TESSELLATOR_PARTITIONING_UNDEFINED +
+ + +

Partition with integers only.

+
+ + ff728739 + D3D_TESSELLATOR_PARTITIONING_INTEGER + D3D_TESSELLATOR_PARTITIONING_INTEGER +
+ + +

Partition with a power-of-two number only.

+
+ + ff728739 + D3D_TESSELLATOR_PARTITIONING_POW2 + D3D_TESSELLATOR_PARTITIONING_POW2 +
+ + +

Partition with an odd, fractional number.

+
+ + ff728739 + D3D_TESSELLATOR_PARTITIONING_FRACTIONAL_ODD + D3D_TESSELLATOR_PARTITIONING_FRACTIONAL_ODD +
+ + +

Partition with an even, fractional number.

+
+ + ff728739 + D3D_TESSELLATOR_PARTITIONING_FRACTIONAL_EVEN + D3D_TESSELLATOR_PARTITIONING_FRACTIONAL_EVEN +
+ + +

This shader-reflection interface provides access to a constant buffer.

+
+ +

To create a constant-buffer interface, call or . This is not a COM interface; therefore, you do not need to worry about reference counts or releasing the interface when you are done with it.

+
+ + ff476591 + ID3D11ShaderReflectionConstantBuffer + ID3D11ShaderReflectionConstantBuffer +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a constant-buffer description.

+
+

A reference to a , which represents a shader-buffer description.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476592 + HRESULT ID3D11ShaderReflectionConstantBuffer::GetDesc([Out] D3D11_SHADER_BUFFER_DESC* pDesc) + ID3D11ShaderReflectionConstantBuffer::GetDesc +
+ + +

Get a shader-reflection variable by index.

+
+

Zero-based index.

+

A reference to a shader-reflection variable interface (see Interface).

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476593 + ID3D11ShaderReflectionVariable* ID3D11ShaderReflectionConstantBuffer::GetVariableByIndex([In] unsigned int Index) + ID3D11ShaderReflectionConstantBuffer::GetVariableByIndex +
+ + +

Get a shader-reflection variable by name.

+
+

Variable name.

+

Returns a sentinel object (end of list marker). To determine if GetVariableByName successfully completed, call and check the returned ; any return value other than success means that GetVariableByName failed.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476594 + ID3D11ShaderReflectionVariable* ID3D11ShaderReflectionConstantBuffer::GetVariableByName([In] const char* Name) + ID3D11ShaderReflectionConstantBuffer::GetVariableByName +
+ + +

Get a constant-buffer description.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476592 + GetDesc + GetDesc + HRESULT ID3D11ShaderReflectionConstantBuffer::GetDesc([Out] D3D11_SHADER_BUFFER_DESC* pDesc) +
+ + +

is an include interface that the user implements to allow an application to call user-overridable methods for opening and closing shader #include files.

+
+ +

To use this interface, create an interface that inherits from and implement custom behavior for the methods.

+
+ + ff728746 + ID3DInclude + ID3DInclude +
+ + + A user-implemented method for opening and reading the contents of a shader #include file. + + A -typed value that indicates the location of the #include file. + Name of the #include file. + Pointer to the container that includes the #include file. + Stream that is associated with fileName to be read. This reference remains valid until is called. + HRESULT Open([None] D3D_INCLUDE_TYPE IncludeType,[None] const char* pFileName,[None] LPCVOID pParentData,[None] LPCVOID* ppData,[None] UINT* pBytes) + + + + A user-implemented method for closing a shader #include file. + + + If was successful, Close is guaranteed to be called before the API using the interface returns. + + This is a reference that was returned by the corresponding call. + HRESULT Close([None] LPCVOID pData) + + + +

A shader-reflection interface accesses shader information.

+
+ +

An interface can be retrieved for a shader by using . The following code illustrates retrieving a from a shader.

 pd3dDevice->CreatePixelShader( pPixelShaderBuffer->GetBufferPointer(), pPixelShaderBuffer->GetBufferSize(), g_pPSClassLinkage, &g_pPixelShader ); * pReflector = null; 	
+            ( pPixelShaderBuffer->GetBufferPointer(), pPixelShaderBuffer->GetBufferSize(),  IID_ID3D11ShaderReflection, (void**) &pReflector); 
+
+ + ff476590 + ID3D11ShaderReflection + ID3D11ShaderReflection +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a shader description.

+
+

A reference to a shader description. See .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476615 + HRESULT ID3D11ShaderReflection::GetDesc([Out] D3D11_SHADER_DESC* pDesc) + ID3D11ShaderReflection::GetDesc +
+ + +

Get a constant buffer by index.

+
+

Zero-based index.

+

A reference to a constant buffer (see Interface).

+ +

A constant buffer supplies either scalar constants or texture constants to a shader. A shader can use one or more constant buffers. For best performance, separate constants into buffers based on the frequency they are updated.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476612 + ID3D11ShaderReflectionConstantBuffer* ID3D11ShaderReflection::GetConstantBufferByIndex([In] unsigned int Index) + ID3D11ShaderReflection::GetConstantBufferByIndex +
+ + +

Get a constant buffer by name.

+
+

The constant-buffer name.

+

A reference to a constant buffer (see Interface).

+ +

A constant buffer supplies either scalar constants or texture constants to a shader. A shader can use one or more constant buffers. For best performance, separate constants into buffers based on the frequency they are updated.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476613 + ID3D11ShaderReflectionConstantBuffer* ID3D11ShaderReflection::GetConstantBufferByName([In] const char* Name) + ID3D11ShaderReflection::GetConstantBufferByName +
+ + +

Get a description of how a resource is bound to a shader.

+
+

A zero-based resource index.

+

A reference to an input-binding description. See .

+ +

A shader consists of executable code (the compiled HLSL functions) and a set of resources that supply the shader with input data. GetResourceBindingDesc gets information about how one resource in the set is bound as an input to the shader. The ResourceIndex parameter specifies the index for the resource.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476624 + HRESULT ID3D11ShaderReflection::GetResourceBindingDesc([In] unsigned int ResourceIndex,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc) + ID3D11ShaderReflection::GetResourceBindingDesc +
+ + +

Get an input-parameter description for a shader.

+
+

A zero-based parameter index.

+

A reference to a shader-input-signature description. See .

+ +

An input-parameter description is also called a shader signature. The shader signature contains information about the input parameters such as the order or parameters, their data type, and a parameter semantic.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476617 + HRESULT ID3D11ShaderReflection::GetInputParameterDesc([In] unsigned int ParameterIndex,[Out] D3D11_SIGNATURE_PARAMETER_DESC* pDesc) + ID3D11ShaderReflection::GetInputParameterDesc +
+ + +

Get an output-parameter description for a shader.

+
+

A zero-based parameter index.

+

A reference to a shader-output-parameter description. See .

+ +

An output-parameter description is also called a shader signature. The shader signature contains information about the output parameters such as the order or parameters, their data type, and a parameter semantic.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476622 + HRESULT ID3D11ShaderReflection::GetOutputParameterDesc([In] unsigned int ParameterIndex,[Out] D3D11_SIGNATURE_PARAMETER_DESC* pDesc) + ID3D11ShaderReflection::GetOutputParameterDesc +
+ + +

Get a patch-constant parameter description for a shader.

+
+

A zero-based parameter index.

+

A reference to a shader-input-signature description. See .

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476623 + HRESULT ID3D11ShaderReflection::GetPatchConstantParameterDesc([In] unsigned int ParameterIndex,[Out] D3D11_SIGNATURE_PARAMETER_DESC* pDesc) + ID3D11ShaderReflection::GetPatchConstantParameterDesc +
+ + +

Gets a variable by name.

+
+

A reference to a string containing the variable name.

+

Returns a Interface interface.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476626 + ID3D11ShaderReflectionVariable* ID3D11ShaderReflection::GetVariableByName([In] const char* Name) + ID3D11ShaderReflection::GetVariableByName +
+ + +

Get a description of how a resource is bound to a shader.

+
+

The constant-buffer name of the resource.

+

A reference to an input-binding description. See .

+ +

A shader consists of executable code (the compiled HLSL functions) and a set of resources that supply the shader with input data. GetResourceBindingDescByName gets information about how one resource in the set is bound as an input to the shader. The Name parameter specifies the name of the resource.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476625 + HRESULT ID3D11ShaderReflection::GetResourceBindingDescByName([In] const char* Name,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc) + ID3D11ShaderReflection::GetResourceBindingDescByName +
+ + +

Gets the number of Mov instructions.

+
+

Returns the number of Mov instructions.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476620 + unsigned int ID3D11ShaderReflection::GetMovInstructionCount() + ID3D11ShaderReflection::GetMovInstructionCount +
+ + +

Gets the number of Movc instructions.

+
+

Returns the number of Movc instructions.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476619 + unsigned int ID3D11ShaderReflection::GetMovcInstructionCount() + ID3D11ShaderReflection::GetMovcInstructionCount +
+ + +

Gets the number of conversion instructions.

+
+

Returns the number of conversion instructions.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476614 + unsigned int ID3D11ShaderReflection::GetConversionInstructionCount() + ID3D11ShaderReflection::GetConversionInstructionCount +
+ + +

Gets the number of bitwise instructions.

+
+

The number of bitwise instructions.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476611 + unsigned int ID3D11ShaderReflection::GetBitwiseInstructionCount() + ID3D11ShaderReflection::GetBitwiseInstructionCount +
+ + +

Gets the geometry-shader input-primitive description.

+
+

The input-primitive description, see D3D10_PRIMITIVE_TOPOLOGY.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476616 + D3D_PRIMITIVE ID3D11ShaderReflection::GetGSInputPrimitive() + ID3D11ShaderReflection::GetGSInputPrimitive +
+ + +

Indicates whether a shader is a sample frequency shader.

+
+

Returns true if the shader is a sample frequency shader; otherwise returns false.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476627 + BOOL ID3D11ShaderReflection::IsSampleFrequencyShader() + ID3D11ShaderReflection::IsSampleFrequencyShader +
+ + +

Gets the number of interface slots in a shader.

+
+

The number of interface slots in the shader.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476621 + unsigned int ID3D11ShaderReflection::GetNumInterfaceSlots() + ID3D11ShaderReflection::GetNumInterfaceSlots +
+ + +

Gets the minimum feature level.

+
+

A reference to one of the enumerated values in , which represents the minimum feature level.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476618 + HRESULT ID3D11ShaderReflection::GetMinFeatureLevel([Out] D3D_FEATURE_LEVEL* pLevel) + ID3D11ShaderReflection::GetMinFeatureLevel +
+ + +

Retrieves the sizes, in thread groups, of the X, Y, and Z dimensions of the shader's thread-group grid.

+
+

A reference to the size, in thread groups, of the x-dimension of the thread-group grid. The maximum size is 65535.

+

A reference to the size, in thread groups, of the y-dimension of the thread-group grid. The maximum size is 65535.

+

A reference to the size, in thread groups, of the z-dimension of the thread-group grid. The maximum size is 65535.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff728742 + unsigned int ID3D11ShaderReflection::GetThreadGroupSize([Out, Optional] unsigned int* pSizeX,[Out, Optional] unsigned int* pSizeY,[Out, Optional] unsigned int* pSizeZ) + ID3D11ShaderReflection::GetThreadGroupSize +
+ + + Initializes a new instance of the class from a . + + + + + +

Get a shader description.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476615 + GetDesc + GetDesc + HRESULT ID3D11ShaderReflection::GetDesc([Out] D3D11_SHADER_DESC* pDesc) +
+ + +

Gets the number of Mov instructions.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476620 + GetMovInstructionCount + GetMovInstructionCount + unsigned int ID3D11ShaderReflection::GetMovInstructionCount() +
+ + +

Gets the number of Movc instructions.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476619 + GetMovcInstructionCount + GetMovcInstructionCount + unsigned int ID3D11ShaderReflection::GetMovcInstructionCount() +
+ + +

Gets the number of conversion instructions.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476614 + GetConversionInstructionCount + GetConversionInstructionCount + unsigned int ID3D11ShaderReflection::GetConversionInstructionCount() +
+ + +

Gets the number of bitwise instructions.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476611 + GetBitwiseInstructionCount + GetBitwiseInstructionCount + unsigned int ID3D11ShaderReflection::GetBitwiseInstructionCount() +
+ + +

Gets the geometry-shader input-primitive description.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476616 + GetGSInputPrimitive + GetGSInputPrimitive + D3D_PRIMITIVE ID3D11ShaderReflection::GetGSInputPrimitive() +
+ + +

Indicates whether a shader is a sample frequency shader.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476627 + IsSampleFrequencyShader + IsSampleFrequencyShader + BOOL ID3D11ShaderReflection::IsSampleFrequencyShader() +
+ + +

Gets the number of interface slots in a shader.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476621 + GetNumInterfaceSlots + GetNumInterfaceSlots + unsigned int ID3D11ShaderReflection::GetNumInterfaceSlots() +
+ + +

Gets the minimum feature level.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476618 + GetMinFeatureLevel + GetMinFeatureLevel + HRESULT ID3D11ShaderReflection::GetMinFeatureLevel([Out] D3D_FEATURE_LEVEL* pLevel) +
+ + +

This shader-reflection interface provides access to variable type.

+
+ +

The get a shader-reflection-type interface, call .

+
+ + ff476595 + ID3D11ShaderReflectionType + ID3D11ShaderReflectionType +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the description of a shader-reflection-variable type.

+
+

A reference to a shader-type description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476597 + HRESULT ID3D11ShaderReflectionType::GetDesc([Out] D3D11_SHADER_TYPE_DESC* pDesc) + ID3D11ShaderReflectionType::GetDesc +
+ + +

Get a shader-reflection-variable type by index.

+
+

Zero-based index.

+

A reference to a Interface.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476599 + ID3D11ShaderReflectionType* ID3D11ShaderReflectionType::GetMemberTypeByIndex([In] unsigned int Index) + ID3D11ShaderReflectionType::GetMemberTypeByIndex +
+ + +

Get a shader-reflection-variable type by name.

+
+

Member name.

+

A reference to a Interface.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476600 + ID3D11ShaderReflectionType* ID3D11ShaderReflectionType::GetMemberTypeByName([In] const char* Name) + ID3D11ShaderReflectionType::GetMemberTypeByName +
+ + +

Get a shader-reflection-variable type.

+
+

Zero-based index.

+

The variable type.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476601 + const char* ID3D11ShaderReflectionType::GetMemberTypeName([In] unsigned int Index) + ID3D11ShaderReflectionType::GetMemberTypeName +
+ + +

Indicates whether two Interface references have the same underlying type.

+
+ No documentation. +

Returns if the references have the same underlying type; otherwise returns S_FALSE.

+ +

IsEqual indicates whether the sources of the Interface references have the same underlying type. For example, if two Interface references were retrieved from variables, IsEqual can be used to see if the variables have the same type.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476605 + HRESULT ID3D11ShaderReflectionType::IsEqual([In] ID3D11ShaderReflectionType* pType) + ID3D11ShaderReflectionType::IsEqual +
+ + +

Gets the base class of a class.

+
+

Returns a reference to a Interface containing the base class type. Returns null if the class does not have a base class.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476603 + ID3D11ShaderReflectionType* ID3D11ShaderReflectionType::GetSubType() + ID3D11ShaderReflectionType::GetSubType +
+ + +

Gets an Interface interface containing the variable base class type.

+
+

Returns A reference to a Interface.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476596 + ID3D11ShaderReflectionType* ID3D11ShaderReflectionType::GetBaseClass() + ID3D11ShaderReflectionType::GetBaseClass +
+ + +

Gets the number of interfaces.

+
+

Returns the number of interfaces.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476602 + unsigned int ID3D11ShaderReflectionType::GetNumInterfaces() + ID3D11ShaderReflectionType::GetNumInterfaces +
+ + +

Get an interface by index.

+
+

Zero-based index.

+

A reference to a Interface.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476598 + ID3D11ShaderReflectionType* ID3D11ShaderReflectionType::GetInterfaceByIndex([In] unsigned int uIndex) + ID3D11ShaderReflectionType::GetInterfaceByIndex +
+ + +

Indicates whether a variable is of the specified type.

+
+

A reference to a Interface.

+

Returns if object being queried is equal to or inherits from the type in the pType parameter; otherwise returns S_FALSE.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476606 + HRESULT ID3D11ShaderReflectionType::IsOfType([In] ID3D11ShaderReflectionType* pType) + ID3D11ShaderReflectionType::IsOfType +
+ + +

Indicates whether a class type implements an interface.

+
+

A reference to a Interface.

+

Returns if the interface is implemented; otherwise return S_FALSE.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476604 + HRESULT ID3D11ShaderReflectionType::ImplementsInterface([In] ID3D11ShaderReflectionType* pBase) + ID3D11ShaderReflectionType::ImplementsInterface +
+ + + Indicates whether two references have the same underlying type. + + + IsEqual indicates whether the sources of the references have the same underlying type. For example, if two ID3D11ShaderReflectionType Interface references were retrieved from variables, IsEqual can be used to see if the variables have the same type. This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll. + + A reference to a . + Returns true if the references have the same underlying type; otherwise returns false. + HRESULT ID3D11ShaderReflectionType::IsEqual([In] ID3D11ShaderReflectionType* pType) + + + + Indicates whether a variable is of the specified type. + + + This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll. + + A reference to a . + Returns true if object being queried is equal to or inherits from the type in the pType parameter; otherwise returns false. + HRESULT ID3D11ShaderReflectionType::IsOfType([In] ID3D11ShaderReflectionType* pType) + + + + Indicates whether a class type implements an interface. + + + This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll. + + A reference to a . + Returns true if the interface is implemented; otherwise return false. + HRESULT ID3D11ShaderReflectionType::ImplementsInterface([In] ID3D11ShaderReflectionType* pBase) + + + +

Get the description of a shader-reflection-variable type.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476597 + GetDesc + GetDesc + HRESULT ID3D11ShaderReflectionType::GetDesc([Out] D3D11_SHADER_TYPE_DESC* pDesc) +
+ + +

Gets the base class of a class.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476603 + GetSubType + GetSubType + ID3D11ShaderReflectionType* ID3D11ShaderReflectionType::GetSubType() +
+ + +

Gets an Interface interface containing the variable base class type.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476596 + GetBaseClass + GetBaseClass + ID3D11ShaderReflectionType* ID3D11ShaderReflectionType::GetBaseClass() +
+ + +

Gets the number of interfaces.

+
+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476602 + GetNumInterfaces + GetNumInterfaces + unsigned int ID3D11ShaderReflectionType::GetNumInterfaces() +
+ + +

This shader-reflection interface provides access to a variable.

+
+ +

To get a shader-reflection-variable interface, call a method like .

+
+ + ff476607 + ID3D11ShaderReflectionVariable + ID3D11ShaderReflectionVariable +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a shader-variable description.

+
+

A reference to a shader-variable description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method can be used to determine if the Interface is valid, the method returns E_FAIL when the variable is not valid.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476608 + HRESULT ID3D11ShaderReflectionVariable::GetDesc([Out] D3D11_SHADER_VARIABLE_DESC* pDesc) + ID3D11ShaderReflectionVariable::GetDesc +
+ + +

Get a shader-variable type.

+
+

A reference to a Interface.

+ +

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476610 + ID3D11ShaderReflectionType* ID3D11ShaderReflectionVariable::GetType() + ID3D11ShaderReflectionVariable::GetType +
+ + + No documentation. + + No documentation. + + ID3D11ShaderReflectionConstantBuffer* ID3D11ShaderReflectionVariable::GetBuffer() + ID3D11ShaderReflectionVariable::GetBuffer + + + +

Gets the corresponding interface slot for a variable that represents an interface reference.

+
+

Index of the array element to get the slot number for. For a non-array variable this value will be zero.

+

Returns the index of the interface in the interface array.

+ +

GetInterfaceSlot gets the corresponding slot in an dynamic linkage array for an interface instance. The returned slot number is used to set an interface instance to a particular class instance. See the HLSL Interfaces and Classes overview for additional information.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476609 + unsigned int ID3D11ShaderReflectionVariable::GetInterfaceSlot([In] unsigned int uArrayIndex) + ID3D11ShaderReflectionVariable::GetInterfaceSlot +
+ + +

Get a shader-variable description.

+
+ +

This method can be used to determine if the Interface is valid, the method returns E_FAIL when the variable is not valid.

This method's interface is hosted in the out-of-box DLL D3DCompiler_xx.dll.

+
+ + ff476608 + GetDesc + GetDesc + HRESULT ID3D11ShaderReflectionVariable::GetDesc([Out] D3D11_SHADER_VARIABLE_DESC* pDesc) +
+ + + No documentation. + + + GetBuffer + GetBuffer + ID3D11ShaderReflectionConstantBuffer* ID3D11ShaderReflectionVariable::GetBuffer() + + + + Shadow callback for . + + + + + Return a pointer to the unamanged version of this callback. + + The callback. + A pointer to a shadow c++ callback + + + + Internal Include Callback + + + + + A user-implemented method for opening and reading the contents of a shader #include file. + + This pointer + A -typed value that indicates the location of the #include file. + Name of the #include file. + Pointer to the container that includes the #include file. + Pointer to the buffer that Open returns that contains the include directives. This pointer remains valid until is called. + Pointer to the number of bytes that Open returns in ppData. + The user-implemented method should return S_OK. If Open fails when reading the #include file, the application programming interface (API) that caused Open to be called fails. This failure can occur in one of the following situations:The high-level shader language (HLSL) shader fails one of the D3D10CompileShader*** functions.The effect fails one of the D3D10CreateEffect*** functions. + HRESULT Open([None] D3D_INCLUDE_TYPE IncludeType,[None] const char* pFileName,[None] LPCVOID pParentData,[None] LPCVOID* ppData,[None] UINT* pBytes) + + + + A user-implemented method for closing a shader #include file. + + + If was successful, Close is guaranteed to be called before the API using the interface returns. + + This pointer + Pointer to the buffer that contains the include directives. This is the pointer that was returned by the corresponding call. + The user-implemented Close method should return S_OK. If Close fails when it closes the #include file, the application programming interface (API) that caused Close to be called fails. This failure can occur in one of the following situations:The high-level shader language (HLSL) shader fails one of the D3D10CompileShader*** functions.The effect fails one of the D3D10CreateEffect*** functions. + HRESULT Close([None] LPCVOID pData) + + + + The namespace provides managed Direct3D Compiler API. + + dd607340 + D3DCompiler + D3DCompiler + + + + No documentation. + + D3D11_REGISTER_COMPONENT_MASK_FLAG + + + + No documentation. + + D3D11_REGISTER_COMPONENT_MASK_ALL + + + + No documentation. + + D3D11_REGISTER_COMPONENT_MASK_COMPONENT_W + + + + No documentation. + + D3D11_REGISTER_COMPONENT_MASK_COMPONENT_X + + + + No documentation. + + D3D11_REGISTER_COMPONENT_MASK_COMPONENT_Y + + + + No documentation. + + D3D11_REGISTER_COMPONENT_MASK_COMPONENT_Z + + + + None. + + None + + + +

Describes a shader constant-buffer.

+
+ +

Constants are supplied to shaders in a shader-constant buffer. Get the description of a shader-constant-buffer by calling .

+
+ + ff476208 + D3D11_SHADER_BUFFER_DESC + D3D11_SHADER_BUFFER_DESC +
+ + +

The name of the buffer.

+
+ + ff476208 + const char* Name + char Name +
+ + +

The intended use of the constant data.

+
+ + ff476208 + D3D_CBUFFER_TYPE Type + D3D_CBUFFER_TYPE Type +
+ + +

The number of unique variables.

+
+ + ff476208 + unsigned int Variables + unsigned int Variables +
+ + +

Buffer size (in bytes).

+
+ + ff476208 + unsigned int Size + unsigned int Size +
+ + +

Shader buffer properties.

+
+ + ff476208 + D3D_SHADER_CBUFFER_FLAGS uFlags + D3D_SHADER_CBUFFER_FLAGS uFlags +
+ + +

Describes how a shader resource is bound to a shader input.

+
+ +

Get a shader-input-signature description by calling or .

+
+ + ff476210 + D3D11_SHADER_INPUT_BIND_DESC + D3D11_SHADER_INPUT_BIND_DESC +
+ + +

Name of the shader resource.

+
+ + ff476210 + const char* Name + char Name +
+ + +

Identifies the type of data in the resource. See D3D10_SHADER_INPUT_TYPE.

+
+ + ff476210 + D3D_SHADER_INPUT_TYPE Type + D3D_SHADER_INPUT_TYPE Type +
+ + +

Starting bind point.

+
+ + ff476210 + unsigned int BindPoint + unsigned int BindPoint +
+ + +

Number of contiguous bind points for arrays.

+
+ + ff476210 + unsigned int BindCount + unsigned int BindCount +
+ + +

Shader input-parameter options. See D3D10_SHADER_INPUT_FLAGS.

+
+ + ff476210 + D3D_SHADER_INPUT_FLAGS uFlags + D3D_SHADER_INPUT_FLAGS uFlags +
+ + +

If the input is a texture, the return type. See D3D11_RESOURCE_RETURN_TYPE.

+
+ + ff476210 + D3D_RESOURCE_RETURN_TYPE ReturnType + D3D_RESOURCE_RETURN_TYPE ReturnType +
+ + +

Identifies the dimensions of the bound resource. For a list of values that or can return, see D3D11_SRV_DIMENSION.

+
+ + ff476210 + D3D_SRV_DIMENSION Dimension + D3D_SRV_DIMENSION Dimension +
+ + +

The number of samples for a multisampled texture; otherwise 0.

+
+ + ff476210 + unsigned int NumSamples + unsigned int NumSamples +
+ + +

Describes shader data.

+
+ +

An array of structures is passed to to compress the shader data into a more compact form.

+
+ + ff728721 + D3D_SHADER_DATA + D3D_SHADER_DATA +
+ + +

A reference to shader data.

+
+ + ff728721 + const void* pBytecode + void pBytecode +
+ + +

Length of shader data that pBytecode points to.

+
+ + ff728721 + SIZE_T BytecodeLength + SIZE_T BytecodeLength +
+ + +

Describes a shader.

+
+ +

A shader is written in HLSL and compiled into an intermediate language by the HLSL compiler. The shader description returns information about the compiled shader. Get a shader description by calling .

+
+ + ff476209 + D3D11_SHADER_DESC + D3D11_SHADER_DESC +
+ + +

Shader version.

+
+ + ff476209 + unsigned int Version + unsigned int Version +
+ + +

The name of the originator of the shader.

+
+ + ff476209 + const char* Creator + char Creator +
+ + +

Shader compilation/parse flags.

+
+ + ff476209 + D3DCOMPILE_SHADER_FLAGS Flags + D3DCOMPILE_SHADER_FLAGS Flags +
+ + +

The number of shader-constant buffers.

+
+ + ff476209 + unsigned int ConstantBuffers + unsigned int ConstantBuffers +
+ + +

The number of resource (textures and buffers) bound to a shader.

+
+ + ff476209 + unsigned int BoundResources + unsigned int BoundResources +
+ + +

The number of parameters in the input signature.

+
+ + ff476209 + unsigned int InputParameters + unsigned int InputParameters +
+ + +

The number of parameters in the output signature.

+
+ + ff476209 + unsigned int OutputParameters + unsigned int OutputParameters +
+ + +

The number of intermediate-language instructions in the compiled shader.

+
+ + ff476209 + unsigned int InstructionCount + unsigned int InstructionCount +
+ + +

The number of temporary registers in the compiled shader.

+
+ + ff476209 + unsigned int TempRegisterCount + unsigned int TempRegisterCount +
+ + +

Number of temporary arrays used.

+
+ + ff476209 + unsigned int TempArrayCount + unsigned int TempArrayCount +
+ + +

Number of constant defines.

+
+ + ff476209 + unsigned int DefCount + unsigned int DefCount +
+ + +

Number of declarations (input + output).

+
+ + ff476209 + unsigned int DclCount + unsigned int DclCount +
+ + +

Number of non-categorized texture instructions.

+
+ + ff476209 + unsigned int TextureNormalInstructions + unsigned int TextureNormalInstructions +
+ + +

Number of texture load instructions

+
+ + ff476209 + unsigned int TextureLoadInstructions + unsigned int TextureLoadInstructions +
+ + +

Number of texture comparison instructions

+
+ + ff476209 + unsigned int TextureCompInstructions + unsigned int TextureCompInstructions +
+ + +

Number of texture bias instructions

+
+ + ff476209 + unsigned int TextureBiasInstructions + unsigned int TextureBiasInstructions +
+ + +

Number of texture gradient instructions.

+
+ + ff476209 + unsigned int TextureGradientInstructions + unsigned int TextureGradientInstructions +
+ + +

Number of floating point arithmetic instructions used.

+
+ + ff476209 + unsigned int FloatInstructionCount + unsigned int FloatInstructionCount +
+ + +

Number of signed integer arithmetic instructions used.

+
+ + ff476209 + unsigned int IntInstructionCount + unsigned int IntInstructionCount +
+ + +

Number of unsigned integer arithmetic instructions used.

+
+ + ff476209 + unsigned int UintInstructionCount + unsigned int UintInstructionCount +
+ + +

Number of static flow control instructions used.

+
+ + ff476209 + unsigned int StaticFlowControlCount + unsigned int StaticFlowControlCount +
+ + +

Number of dynamic flow control instructions used.

+
+ + ff476209 + unsigned int DynamicFlowControlCount + unsigned int DynamicFlowControlCount +
+ + +

Number of macro instructions used.

+
+ + ff476209 + unsigned int MacroInstructionCount + unsigned int MacroInstructionCount +
+ + +

Number of array instructions used.

+
+ + ff476209 + unsigned int ArrayInstructionCount + unsigned int ArrayInstructionCount +
+ + +

Number of cut instructions used.

+
+ + ff476209 + unsigned int CutInstructionCount + unsigned int CutInstructionCount +
+ + +

Number of emit instructions used.

+
+ + ff476209 + unsigned int EmitInstructionCount + unsigned int EmitInstructionCount +
+ + +

The D3D10_PRIMITIVE_TOPOLOGY, which represents the shader output topology.

+
+ + ff476209 + D3D_PRIMITIVE_TOPOLOGY GSOutputTopology + D3D_PRIMITIVE_TOPOLOGY GSOutputTopology +
+ + +

Geometry shader maximum output vertex count.

+
+ + ff476209 + unsigned int GSMaxOutputVertexCount + unsigned int GSMaxOutputVertexCount +
+ + +

The D3D11_PRIMITIVE-typed value that represents the input primitive for a geometry shader or hull shader.

+
+ + ff476209 + D3D_PRIMITIVE InputPrimitive + D3D_PRIMITIVE InputPrimitive +
+ + +

Number of parameters in the patch-constant signature.

+
+ + ff476209 + unsigned int PatchConstantParameters + unsigned int PatchConstantParameters +
+ + +

Number of geometry shader instances.

+
+ + ff476209 + unsigned int cGSInstanceCount + unsigned int cGSInstanceCount +
+ + +

Number of control points in the hull shader and domain shader.

+
+ + ff476209 + unsigned int cControlPoints + unsigned int cControlPoints +
+ + +

The D3D11_TESSELLATOR_OUTPUT_PRIMITIVE, which represents the tessellator output-primitive type.

+
+ + ff476209 + D3D_TESSELLATOR_OUTPUT_PRIMITIVE HSOutputPrimitive + D3D_TESSELLATOR_OUTPUT_PRIMITIVE HSOutputPrimitive +
+ + +

The D3D11_TESSELLATOR_PARTITIONING, which represents the tessellator partitioning mode.

+
+ + ff476209 + D3D_TESSELLATOR_PARTITIONING HSPartitioning + D3D_TESSELLATOR_PARTITIONING HSPartitioning +
+ + +

The D3D11_TESSELLATOR_DOMAIN, which represents the tessellator domain.

+
+ + ff476209 + D3D_TESSELLATOR_DOMAIN TessellatorDomain + D3D_TESSELLATOR_DOMAIN TessellatorDomain +
+ + +

Number of barrier instructions in a compute shader.

+
+ + ff476209 + unsigned int cBarrierInstructions + unsigned int cBarrierInstructions +
+ + +

Number of interlocked instructions in a compute shader.

+
+ + ff476209 + unsigned int cInterlockedInstructions + unsigned int cInterlockedInstructions +
+ + +

Number of texture writes in a compute shader.

+
+ + ff476209 + unsigned int cTextureStoreInstructions + unsigned int cTextureStoreInstructions +
+ + +

Describes a shader signature.

+
+ +

A shader can take n inputs and can produce m outputs. The order of the input (or output) parameters, their associated types, and any attached semantics make up the shader signature. Each shader has an input and an output signature.

When compiling a shader or an effect, some API calls validate shader signatures That is, they compare the output signature of one shader (like a vertex shader) with the input signature of another shader (like a pixel shader). This ensures that a shader outputs data that is compatible with a downstream shader that is consuming that data. Compatible means that a shader signature is a exact-match subset of the preceding shader stage. Exact match means parameter types and semantics must exactly match. Subset means that a parameter that is not required by a downstream stage, does not need to include that parameter in its shader signature.

Get a shader-signature from a shader or an effect by calling APIs such as .

+
+ + ff476215 + D3D11_SIGNATURE_PARAMETER_DESC + D3D11_SIGNATURE_PARAMETER_DESC +
+ + +

A per-parameter string that identifies how the data will be used.

+
+ + ff476215 + const char* SemanticName + char SemanticName +
+ + +

Semantic index that modifies the semantic. Used to differentiate different parameters that use the same semantic.

+
+ + ff476215 + unsigned int SemanticIndex + unsigned int SemanticIndex +
+ + +

The register that will contain this variable's data.

+
+ + ff476215 + unsigned int Register + unsigned int Register +
+ + +

A predefined string that determines the functionality of certain pipeline stages. See D3D10_NAME.

+
+ + ff476215 + D3D_NAME SystemValueType + D3D_NAME SystemValueType +
+ + +

The per-component-data type that is stored in a register. See D3D10_REGISTER_COMPONENT_TYPE. Each register can store up to four-components of data.

+
+ + ff476215 + D3D_REGISTER_COMPONENT_TYPE ComponentType + D3D_REGISTER_COMPONENT_TYPE ComponentType +
+ + +

Mask which indicates which components of a register are used.

+
+ + ff476215 + D3D11_REGISTER_COMPONENT_MASK_FLAG Mask + D3D11_REGISTER_COMPONENT_MASK_FLAG Mask +
+ + +

Mask which indicates whether a given component is never written (if the signature is an output signature) or always read (if the signature is an input signature).

+
+ + ff476215 + D3D11_REGISTER_COMPONENT_MASK_FLAG ReadWriteMask + D3D11_REGISTER_COMPONENT_MASK_FLAG ReadWriteMask +
+ + +

Indicates which stream the geometry shader is using for the signature parameter.

+
+ + ff476215 + unsigned int Stream + unsigned int Stream +
+ + +

Describes a shader-variable type.

+
+ +

Get a shader-variable-type description by calling .

+
+ + ff476212 + D3D11_SHADER_TYPE_DESC + D3D11_SHADER_TYPE_DESC +
+ + +

Identifies the variable class as one of scalar, vector, matrix or object. See D3D10_SHADER_VARIABLE_CLASS.

+
+ + ff476212 + D3D_SHADER_VARIABLE_CLASS Class + D3D_SHADER_VARIABLE_CLASS Class +
+ + +

The variable type. See D3D10_SHADER_VARIABLE_TYPE.

+
+ + ff476212 + D3D_SHADER_VARIABLE_TYPE Type + D3D_SHADER_VARIABLE_TYPE Type +
+ + +

Number of rows in a matrix. Otherwise a numeric type returns 1, any other type returns 0.

+
+ + ff476212 + unsigned int Rows + unsigned int Rows +
+ + +

Number of columns in a matrix. Otherwise a numeric type returns 1, any other type returns 0.

+
+ + ff476212 + unsigned int Columns + unsigned int Columns +
+ + +

Number of elements in an array; otherwise 0.

+
+ + ff476212 + unsigned int Elements + unsigned int Elements +
+ + +

Number of members in the structure; otherwise 0.

+
+ + ff476212 + unsigned int Members + unsigned int Members +
+ + +

Offset, in bytes, between the start of the parent structure and this variable.

+
+ + ff476212 + unsigned int Offset + unsigned int Offset +
+ + + No documentation. + + + const char* Name + char Name + + + +

Describes a shader variable.

+
+ +

Get a shader-variable description using reflection by calling .

As of the June 2010 update, DefaultValue emits default values for reflection.

+
+ + ff476213 + D3D11_SHADER_VARIABLE_DESC + D3D11_SHADER_VARIABLE_DESC +
+ + +

The variable name.

+
+ + ff476213 + const char* Name + char Name +
+ + +

Offset from the start of the parent structure to the beginning of the variable.

+
+ + ff476213 + unsigned int StartOffset + unsigned int StartOffset +
+ + +

Size of the variable (in bytes).

+
+ + ff476213 + unsigned int Size + unsigned int Size +
+ + +

A combination of -typed values that are combined by using a bitwise OR operation. The resulting value identifies shader-variable properties.

+
+ + ff476213 + D3D_SHADER_VARIABLE_FLAGS uFlags + D3D_SHADER_VARIABLE_FLAGS uFlags +
+ + +

The default value for initializing the variable.

+
+ + ff476213 + void* DefaultValue + void DefaultValue +
+ + + No documentation. + + + unsigned int StartTexture + unsigned int StartTexture + + + + No documentation. + + + unsigned int TextureSize + unsigned int TextureSize + + + + No documentation. + + + unsigned int StartSampler + unsigned int StartSampler + + + + No documentation. + + + unsigned int SamplerSize + unsigned int SamplerSize + + + + Represents the compiled bytecode of a shader or effect. + + Blob + + + + Use this ShaderFlags constant in order to compile an effect with old D3D10CompileEffectFromMemory. + + + + + Initializes a new instance of the class. + + A containing the compiled bytecode. + + + + Initializes a new instance of the class. + + A containing the compiled bytecode. + + + + Initializes a new instance of the class. + + The buffer. + + + + Initializes a new instance of the class. + + a pointer to a compiler bytecode + size of the bytecode + + + + Initializes a new instance of the class. + + The BLOB. + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + Name of the source file. + + The compiled shader bytecode, or null if the method fails. + + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + Name of the source file. + + The compiled shader bytecode, or null if the method fails. + + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + Name of the source file. + + The compiled shader bytecode, or null if the method fails. + + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + The compiled shader bytecode, or null if the method fails. + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + A set of macros to define during compilation. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if compilation succeeded. + Name of the source file. + + The compiled shader bytecode, or null if the method fails. + + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + A set of macros to define during compilation. + An interface for handling include files. + Name of the source file. + + The compiled shader bytecode, or null if the method fails. + + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + A set of macros to define during compilation. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if compilation succeeded. + Name of the source file. + + The compiled shader bytecode, or null if the method fails. + + + + + Compiles a shader or effect from a file on disk. + + The name of the source file to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + A set of macros to define during compilation. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if compilation succeeded. + The compiled shader bytecode, or null if the method fails. + + + + Compiles a shader or effect from a file on disk. + + The name of the source file to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + A set of macros to define during compilation. + An interface for handling include files. + + The compiled shader bytecode, or null if the method fails. + + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + Effect compilation options. + A set of macros to define during compilation. + An interface for handling include files. + Name of the source file used for reporting errors. Default is "unknown" + + The compiled shader bytecode, or null if the method fails. + + + + + Saves to the specified file name. + + Name of the file. + + + + Compresses a set of shaders into a more compact form. + + An array of structures that describe the set of shaders to compress. + A compressed . + HRESULT D3DCompressShaders([In] int uNumShaders,[In, Buffer] D3D_SHADER_DATA* pShaderData,[In] int uFlags,[Out] ID3DBlob** ppCompressedData) + + + + Decompresses all shaders from a compressed set. + + Returns an array of decompresss shader bytecode. + HRESULT D3DDecompressShaders([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] unsigned int uNumShaders,[In] unsigned int uStartIndex,[In, Buffer, Optional] unsigned int* pIndices,[In] unsigned int uFlags,[Out, Buffer] ID3D10Blob** ppShaders,[Out, Optional] unsigned int* pTotalShaders) + + + + Decompresses one or more shaders from a compressed set. + + The number of shaders to decompress. + The index of the first shader to decompress. + Returns an array of decompresss shader bytecode. + HRESULT D3DDecompressShaders([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] unsigned int uNumShaders,[In] unsigned int uStartIndex,[In, Buffer, Optional] unsigned int* pIndices,[In] unsigned int uFlags,[Out, Buffer] ID3D10Blob** ppShaders,[Out, Optional] unsigned int* pTotalShaders) + + + + Decompresses one or more shaders from a compressed set. + + An array of indexes that represent the shaders to decompress. + Returns an array of decompresss shader bytecode. + HRESULT D3DDecompressShaders([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] unsigned int uNumShaders,[In] unsigned int uStartIndex,[In, Buffer, Optional] unsigned int* pIndices,[In] unsigned int uFlags,[Out, Buffer] ID3D10Blob** ppShaders,[Out, Optional] unsigned int* pTotalShaders) + + + + Disassembles compiled HLSL code back into textual source. + + The textual source of the shader or effect. + + + + Disassembles compiled HLSL code back into textual source. + + Flags affecting the output of the disassembly. + The textual source of the shader or effect. + + + + Disassembles compiled HLSL code back into textual source. + + Flags affecting the output of the disassembly. + Commenting information to embed in the disassembly. + The textual source of the shader or effect. + + + + Retrieves a specific part from a compilation result. + + + D3DGetBlobPart retrieves the part of a blob (arbitrary length data buffer) that contains the type of data that the Part parameter specifies. + + A -typed value that specifies the part of the buffer to retrieve. + Returns the extracted part. + HRESULT D3DGetBlobPart([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] D3D_BLOB_PART Part,[In] int Flags,[Out] ID3DBlob** ppPart) + + + + Loads from the specified stream. + + The stream. + A shader bytecode + + + + Saves this bycode to the specified stream. + + The stream. + + + + Preprocesses the provided shader or effect source. + + A string containing the source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + The preprocessed shader source. + + + + Preprocesses the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + The preprocessed shader source. + + + + Preprocesses the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + The preprocessed shader source. + + + + Preprocesses the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + The preprocessed shader source. + + + + Preprocesses the provided shader or effect source. + + A string containing the source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + The preprocessed shader source. + + + + Preprocesses a shader or effect from a file on disk. + + The name of the source file to compile. + The preprocessed shader source. + + + + Preprocesses a shader or effect from a file on disk. + + The name of the source file to compile. + A set of macros to define during preprocessing. + An interface for handling include files. + The preprocessed shader source. + + + + Preprocesses a shader or effect from a file on disk. + + The name of the source file to compile. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + The preprocessed shader source. + + + + Strips extraneous information from a compiled shader or effect. + + Options specifying what to remove from the shader. + A string containing any errors that may have occurred. + HRESULT D3DStripShader([In, Buffer] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In] D3DCOMPILER_STRIP_FLAGS uStripFlags,[Out] ID3D10Blob** ppStrippedBlob) + + + + Cast this to the underlying byte buffer. + + + A byte buffer + + + + Read a compiled shader bytecode from a Stream and return a ShaderBytecode + + + + + + + Read a compiled shader bytecode from a Stream and return a ShaderBytecode + + + + + + + Gets the buffer pointer. + + + + + Gets this instance is composed of compressed shaders. + + + true if this instance is compressed; otherwise, false. + + + + + Represents a shader signature. + + + + + Initializes a new instance of the class. + + A pointer to a shader signature bytecode. + The size. + + + + Initializes a new instance of the class. + + The BLOB. + + + + Initializes a new instance of the class. + + The data. + + + + Initializes a new instance of the class. + + The data. + + + + Extracts the input and output signatures from a compiled shader or effect. + + The bytecode of the compiled shader or effect. + The input and output signatures of the shader or effect. + dd607329 + HRESULT D3DGetInputAndOutputSignatureBlob([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppSignatureBlob) + D3DGetInputAndOutputSignatureBlob + + + + Extracts the input signature from a compiled shader or effect. + + The bytecode of the compiled shader or effect. + The input signature of the shader or effect. + dd607330 + HRESULT D3DGetInputSignatureBlob([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppSignatureBlob) + D3DGetInputSignatureBlob + + + + Extracts the output signature from a compiled shader or effect. + + The bytecode of the compiled shader or effect. + The output signature of the shader or effect. + HRESULT D3DGetOutputSignatureBlob([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppSignatureBlob) + dd607331 + HRESULT D3DGetOutputSignatureBlob([In, Buffer] const void* pSrcData,[In] SIZE_T SrcDataSize,[Out] ID3D10Blob** ppSignatureBlob) + D3DGetOutputSignatureBlob + + + + Cast this to the underlying byte buffer. + + + A byte buffer + + + + Gets the raw data of the shader signature. + + + + diff --git a/distribution/SharpDX.DXGI.dll b/distribution/SharpDX.DXGI.dll new file mode 100644 index 00000000..d7aaf7ca Binary files /dev/null and b/distribution/SharpDX.DXGI.dll differ diff --git a/distribution/SharpDX.DXGI.xml b/distribution/SharpDX.DXGI.xml new file mode 100644 index 00000000..796149ad --- /dev/null +++ b/distribution/SharpDX.DXGI.xml @@ -0,0 +1,4229 @@ + + + + SharpDX.DXGI + + + + +

The interface represents a display sub-system (including one or more GPU's, DACs and video memory).

+
+ +

A display sub-system is often referred to as a video card, however, on some machines the display sub-system is part of the mother board.

To enumerate the display sub-systems, use . To get an interface to the adapter for a particular device, use . To create a software adapter, use .

+
+ + bb174523 + IDXGIAdapter + IDXGIAdapter +
+ + +

An interface is a base interface for all DXGI objects; supports associating caller-defined (private data) with an object and retrieval of an interface to the parent object.

+
+ +

implements base class functionality for several other interfaces: , , ,

+
+ + bb174541 + IDXGIObject + IDXGIObject +
+ + + Gets the parent of the object. + + Type of the parent object + Returns the parent object based on the GUID of the type of the parent object. + bb174542 + HRESULT IDXGIObject::GetParent([In] const GUID& riid,[Out] void** ppParent) + IDXGIObject::GetParent + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets application-defined data to the object and associates that data with a .

+
+

A that identifies the data. Use this in a call to GetPrivateData to get the data.

+

The size of the object's data.

+

A reference to the object's data.

+

Returns one of the DXGI_ERROR values.

+ +

SetPrivateData makes a copy of the specified data and stores it with the object.

Private data that SetPrivateData stores in the object occupies the same storage space as private data that is stored by associated Direct3D objects (for example, by a Microsoft Direct3D?11 device through or by a Direct3D?11 child device through ).

The debug layer reports memory leaks by outputting a list of object interface references along with their friendly names. The default friendly name is "<unnamed>". You can set the friendly name so that you can determine if the corresponding object interface reference caused the leak. To set the friendly name, use the SetPrivateData method and the well-known private data () that is in D3Dcommon.h. For example, to give pContext a friendly name of My name, use the following code:

 static const char c_szName[] = "My name";	
+            hr = pContext->SetPrivateData( , sizeof( c_szName ) - 1, c_szName );	
+            

You can use to track down memory leaks and understand performance characteristics of your applications. This information is reflected in the output of the debug layer that is related to memory leaks () and with the event tracing for Windows events that we've added to Windows Developer Preview. +

+
+ + bb174544 + HRESULT IDXGIObject::SetPrivateData([In] const GUID& Name,[In] unsigned int DataSize,[In, Buffer] const void* pData) + IDXGIObject::SetPrivateData +
+ + +

Set an interface in the object's private data.

+
+

A identifying the interface.

+

The interface to set.

+

Returns one of the following DXGI_ERROR.

+ +

This API associates an interface reference with the object.

When the interface is set its reference count is incremented. When the data are overwritten (by calling SPD or SPDI with the same ) or the object is destroyed, ::Release() is called and the interface's reference count is decremented.

+
+ + bb174545 + HRESULT IDXGIObject::SetPrivateDataInterface([In] const GUID& Name,[In] const IUnknown* pUnknown) + IDXGIObject::SetPrivateDataInterface +
+ + +

Get a reference to the object's data.

+
+

A identifying the data.

+

The size of the data.

+

Pointer to the data.

+

Returns one of the following DXGI_ERROR.

+ +

If the data returned is a reference to an , or one of its derivative classes, previously set by , then ::Release() must be called on the reference before the reference is freed to decrement the reference count.

+
+ + bb174543 + HRESULT IDXGIObject::GetPrivateData([In] const GUID& Name,[InOut] unsigned int* pDataSize,[Out, Buffer] void* pData) + IDXGIObject::GetPrivateData +
+ + +

Gets the parent of the object.

+
+

The ID of the requested interface.

+

The address of a reference to the parent object.

+

Returns one of the DXGI_ERROR values.

+ + bb174542 + HRESULT IDXGIObject::GetParent([In] const GUID& riid,[Out] void** ppParent) + IDXGIObject::GetParent +
+ + + Checks to see if a device interface for a graphics component is supported by the system. + + The GUID of the interface of the device version for which support is being checked. For example, typeof(ID3D10Device).GUID. + + true if the interface is supported; otherwise, false. + + Bb174524 + HRESULT IDXGIAdapter::CheckInterfaceSupport([In] const GUID& InterfaceName,[Out] LARGE_INTEGER* pUMDVersion) + IDXGIAdapter::CheckInterfaceSupport + + + + Checks to see if a device interface for a graphics component is supported by the system. + + the interface of the device version for which support is being checked. + + true if the interface is supported; otherwise, false. + + Bb174524 + HRESULT IDXGIAdapter::CheckInterfaceSupport([In] const GUID& InterfaceName,[Out] LARGE_INTEGER* pUMDVersion) + IDXGIAdapter::CheckInterfaceSupport + + + + Checks to see if a device interface for a graphics component is supported by the system. + + the interface of the device version for which support is being checked. + The user mode driver version of InterfaceName. This is only returned if the interface is supported. + + true if the interface is supported; otherwise, false. + + Bb174524 + HRESULT IDXGIAdapter::CheckInterfaceSupport([In] const GUID& InterfaceName,[Out] LARGE_INTEGER* pUMDVersion) + IDXGIAdapter::CheckInterfaceSupport + + + + Checks to see if a device interface for a graphics component is supported by the system. + + The GUID of the interface of the device version for which support is being checked. For example, typeof(ID3D10Device).GUID. + The user mode driver version of InterfaceName. This is only returned if the interface is supported. + + true if the interface is supported; otherwise, false. + + Bb174524 + HRESULT IDXGIAdapter::CheckInterfaceSupport([In] const GUID& InterfaceName,[Out] LARGE_INTEGER* pUMDVersion) + IDXGIAdapter::CheckInterfaceSupport + + + + Gets an adapter (video card) outputs. + + The index of the output. + + An instance of + + HRESULT IDXGIAdapter::EnumOutputs([In] unsigned int Output,[Out] IDXGIOutput** ppOutput) + + When the EnumOutputs method succeeds and fills the ppOutput parameter with the address of the reference to the output interface, EnumOutputs increments the output interface's reference count. To avoid a memory leak, when you finish using the output interface, call the Release method to decrement the reference count.EnumOutputs first returns the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumOutputs then returns other outputs. + + if the index is greater than the number of outputs, result code + bb174525 + HRESULT IDXGIAdapter::EnumOutputs([In] unsigned int Output,[Out] IDXGIOutput** ppOutput) + IDXGIAdapter::EnumOutputs + + + + Return the number of available outputs from this adapter. + + The number of outputs + bb174525 + HRESULT IDXGIAdapter::EnumOutputs([In] unsigned int Output,[Out] IDXGIOutput** ppOutput) + IDXGIAdapter::EnumOutputs + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Enumerate adapter (video card) outputs.

+
+

The index of the output.

+

The address of a reference to an interface at the position specified by the Output parameter.

+

A code that indicates success or failure (see DXGI_ERROR). Will return if the index is greater than the number of outputs.

+ +

When the EnumOutputs method succeeds and fills the ppOutput parameter with the address of the reference to the output interface, EnumOutputs increments the output interface's reference count. To avoid a memory leak, when you finish using the output interface, call the Release method to decrement the reference count.

EnumOutputs first returns the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumOutputs then returns other outputs.

+
+ + bb174525 + HRESULT IDXGIAdapter::EnumOutputs([In] unsigned int Output,[Out] IDXGIOutput** ppOutput) + IDXGIAdapter::EnumOutputs +
+ + +

Gets a DXGI 1.0 description of an adapter (or video card).

+
+

A reference to a structure that describes the adapter. This parameter must not be null.

+

Returns if successful; otherwise returns E_INVALIDARG if the pDesc parameter is null.

+ +

Graphics applications can use the DXGI API to retrieve an accurate set of graphics memory values on systems that have WDDM drivers. The following are the critical steps involved.

  • Graphics driver model determination ? Because DXGI is only available on systems with WDDM drivers, the application must first confirm the driver model by using the following API.
     HasWDDMDriver()	
    +            { LPDIRECT3DCREATE9EX pD3D9Create9Ex = null; HMODULE             hD3D9          = null; hD3D9 = LoadLibrary( L"d3d9.dll" ); if ( null == hD3D9 ) { return false; } // /*  Try to create  interface (also known as a DX9L interface). This interface can only be created if the driver is a WDDM driver. */ // pD3D9Create9Ex = (LPDIRECT3DCREATE9EX) GetProcAddress( hD3D9, "Direct3DCreate9Ex" ); return pD3D9Create9Ex != null;	
    +            } 
  • Retrieval of graphics memory values.? After the driver model is determined to be WDDM, the application can use the DirectX 10 or later API and DXGI to get the amount of graphics memory. After creating a Direct3D device the following code can be used to obtain a structure containing the amount of available graphics memory.
      * pDXGIDevice;	
    +            hr = g_pd3dDevice->QueryInterface(__uuidof(), (void **)&pDXGIDevice);	
    +             * pDXGIAdapter;	
    +            pDXGIDevice->GetAdapter(&pDXGIAdapter);	
    +             adapterDesc;	
    +            pDXGIAdapter->GetDesc(&adapterDesc); 
+
+ + bb174526 + HRESULT IDXGIAdapter::GetDesc([Out] DXGI_ADAPTER_DESC* pDesc) + IDXGIAdapter::GetDesc +
+ + +

Checks whether the system supports a device interface for a graphics component.

+
+

The of the interface of the device version for which support is being checked. For example, __uuidof().

+

The user mode driver version of InterfaceName. This is returned only if the interface is supported. This parameter can be null.

+

indicates that the interface is supported, otherwise is returned (For more information, see DXGI_ERROR).

+ +

Note??You can use CheckInterfaceSupport only to check whether a Direct3D 10.x interface is supported, and only on Windows Vista SP1 and later versions of the operating system. If you try to use CheckInterfaceSupport to check whether a Direct3D 11.x and later version interface is supported, CheckInterfaceSupport returns . Therefore, do not use CheckInterfaceSupport. Instead, to verify whether the operating system supports a particular interface, try to create the interface. For example, if you call the method and it fails, the operating system does not support the interface.

+
+ + Bb174524 + HRESULT IDXGIAdapter::CheckInterfaceSupport([In] const GUID& InterfaceName,[Out] LARGE_INTEGER* pUMDVersion) + IDXGIAdapter::CheckInterfaceSupport +
+ + + Gets all outputs from this adapter. + + bb174525 + HRESULT IDXGIAdapter::EnumOutputs([In] unsigned int Output,[Out] IDXGIOutput** ppOutput) + IDXGIAdapter::EnumOutputs + + + +

Gets a DXGI 1.0 description of an adapter (or video card).

+
+ +

Graphics applications can use the DXGI API to retrieve an accurate set of graphics memory values on systems that have WDDM drivers. The following are the critical steps involved.

  • Graphics driver model determination ? Because DXGI is only available on systems with WDDM drivers, the application must first confirm the driver model by using the following API.
     HasWDDMDriver()	
    +            { LPDIRECT3DCREATE9EX pD3D9Create9Ex = null; HMODULE             hD3D9          = null; hD3D9 = LoadLibrary( L"d3d9.dll" ); if ( null == hD3D9 ) { return false; } // /*  Try to create  interface (also known as a DX9L interface). This interface can only be created if the driver is a WDDM driver. */ // pD3D9Create9Ex = (LPDIRECT3DCREATE9EX) GetProcAddress( hD3D9, "Direct3DCreate9Ex" ); return pD3D9Create9Ex != null;	
    +            } 
  • Retrieval of graphics memory values.? After the driver model is determined to be WDDM, the application can use the DirectX 10 or later API and DXGI to get the amount of graphics memory. After creating a Direct3D device the following code can be used to obtain a structure containing the amount of available graphics memory.
      * pDXGIDevice;	
    +            hr = g_pd3dDevice->QueryInterface(__uuidof(), (void **)&pDXGIDevice);	
    +             * pDXGIAdapter;	
    +            pDXGIDevice->GetAdapter(&pDXGIAdapter);	
    +             adapterDesc;	
    +            pDXGIAdapter->GetDesc(&adapterDesc); 
+
+ + bb174526 + GetDesc + GetDesc + HRESULT IDXGIAdapter::GetDesc([Out] DXGI_ADAPTER_DESC* pDesc) +
+ + + The assembly provides managed DXGI API. + + hh404534 + DXGI + DXGI + + + + The namespace provides a managed DXGI API. + + hh404534 + DXGI + DXGI + + + +

An interface implements a derived class for DXGI objects that produce image data.

+
+ +

The interface is designed for use by DXGI objects that need access to other DXGI objects. This interface is useful to applications that do not use Direct3D to communicate with DXGI.

The object returned by the Direct3D create device functions implements the interface and can be queried for the device's corresponding interface. To retrieve the interface of a Direct3D device the following code can be used.

 * pDXGIDevice;	
+            hr = g_pd3dDevice->QueryInterface(__uuidof(), (void **)&pDXGIDevice);	
+            
+
+ + bb174527 + IDXGIDevice + IDXGIDevice +
+ + + Gets the residency status of an array of resources. + + + The information returned by the pResidencyStatus argument array describes the residency status at the time that the QueryResourceResidency method was called. Note that the residency status will constantly change. If you call the QueryResourceResidency method during a device removed state, the pResidencyStatus argument will return the DXGI_RESIDENCY_EVICTED_TO_DISK flag. Note??This method should not be called every frame as it incurs a non-trivial amount of overhead. + + An array of interfaces. + Returns an array of flags. Each element describes the residency status for corresponding element in the ppResources argument array. + HRESULT IDXGIDevice::QueryResourceResidency([In, Buffer] const IUnknown** ppResources,[Out, Buffer] DXGI_RESIDENCY* pResidencyStatus,[None] int NumResources) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Returns the adapter for the specified device.

+
+

The address of an interface reference to the adapter. This parameter must not be null.

+

Returns if successful; otherwise, returns one of the DXGI_ERROR that indicates failure. If the pAdapter parameter is null this method returns E_INVALIDARG.

+ +

If the GetAdapter method succeeds, the reference count on the adapter interface will be incremented. To avoid a memory leak, be sure to release the interface when you are finished using it.

+
+ + bb174531 + HRESULT IDXGIDevice::GetAdapter([Out] IDXGIAdapter** pAdapter) + IDXGIDevice::GetAdapter +
+ + +

Returns a surface. This method is used internally and you should not call it directly in your application.

+
+

A reference to a structure that describes the surface.

+

The number of surfaces to create.

+

A DXGI_USAGE flag that specifies how the surface is expected to be used.

+

An optional reference to a structure that contains shared resource information for opening views of such resources.

+

The address of an interface reference to the first created surface.

+

Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR.

+ +

The CreateSurface method creates a buffer to exchange data between one or more devices. It is used internally, and you should not directly call it.

The runtime automatically creates an interface when it creates a Direct3D resource object that represents a surface. For example, the runtime creates an interface when it calls or to create a 2D texture. To retrieve the interface that represents the 2D texture surface, call ID3D11Texture2D::QueryInterface or ID3D10Texture2D::QueryInterface. In this call, you must pass the identifier of . If the 2D texture has only a single MIP-map level and does not consist of an array of textures, QueryInterface succeeds and returns a reference to the interface reference. Otherwise, QueryInterface fails and does not return the reference to . +

+
+ + bb174530 + HRESULT IDXGIDevice::CreateSurface([In] const DXGI_SURFACE_DESC* pDesc,[In] unsigned int NumSurfaces,[In] unsigned int Usage,[In, Optional] const DXGI_SHARED_RESOURCE* pSharedResource,[Out] IDXGISurface** ppSurface) + IDXGIDevice::CreateSurface +
+ + +

Gets the residency status of an array of resources.

+
+

An array of interfaces.

+

An array of flags. Each element describes the residency status for corresponding element in the ppResources argument array.

+

The number of resources in the ppResources argument array and pResidencyStatus argument array.

+

Returns if successfull; otherwise, returns , E_INVALIDARG, or E_POINTER (see WinError.h for more information).

+ +

The information returned by the pResidencyStatus argument array describes the residency status at the time that the QueryResourceResidency method was called. Note that the residency status will constantly change.

If you call the QueryResourceResidency method during a device removed state, the pResidencyStatus argument will return the flag.

Note??This method should not be called every frame as it incurs a non-trivial amount of overhead.

+
+ + bb174533 + HRESULT IDXGIDevice::QueryResourceResidency([In, Buffer] const IUnknown** ppResources,[Out, Buffer] DXGI_RESIDENCY* pResidencyStatus,[In] unsigned int NumResources) + IDXGIDevice::QueryResourceResidency +
+ + +

Gets the residency status of an array of resources.

+
+

An array of interfaces.

+

An array of flags. Each element describes the residency status for corresponding element in the ppResources argument array.

+

The number of resources in the ppResources argument array and pResidencyStatus argument array.

+

Returns if successfull; otherwise, returns , E_INVALIDARG, or E_POINTER (see WinError.h for more information).

+ +

The information returned by the pResidencyStatus argument array describes the residency status at the time that the QueryResourceResidency method was called. Note that the residency status will constantly change.

If you call the QueryResourceResidency method during a device removed state, the pResidencyStatus argument will return the flag.

Note??This method should not be called every frame as it incurs a non-trivial amount of overhead.

+
+ + bb174533 + HRESULT IDXGIDevice::QueryResourceResidency([In, Buffer] const IUnknown** ppResources,[Out, Buffer] DXGI_RESIDENCY* pResidencyStatus,[In] unsigned int NumResources) + IDXGIDevice::QueryResourceResidency +
+ + +

Sets the GPU thread priority.

+
+

A value that specifies the required GPU thread priority. This value must be between -7 and 7, inclusive, where 0 represents normal priority.

+

Return if successful; otherwise, returns E_INVALIDARG if the Priority parameter is invalid.

+ +

The values for the Priority parameter function as follows:

  • Positive values increase the likelihood that the GPU scheduler will grant GPU execution cycles to the device when rendering.
  • Negative values lessen the likelihood that the device will receive GPU execution cycles when devices compete for them.
  • The device is guaranteed to receive some GPU execution cycles at all settings.

To use the SetGPUThreadPriority method, you should have a comprehensive understanding of GPU scheduling. You should profile your application to ensure that it behaves as intended. If used inappropriately, the SetGPUThreadPriority method can impede rendering speed and result in a poor user experience.

+
+ + bb174534 + HRESULT IDXGIDevice::SetGPUThreadPriority([In] int Priority) + IDXGIDevice::SetGPUThreadPriority +
+ + +

Gets the GPU thread priority.

+
+

A reference to a variable that receives a value that indicates the current GPU thread priority. The value will be between -7 and 7, inclusive, where 0 represents normal priority.

+

Return if successful; otherwise, returns E_POINTER if the pPriority parameter is null.

+ + Bb174532 + HRESULT IDXGIDevice::GetGPUThreadPriority([Out] int* pPriority) + IDXGIDevice::GetGPUThreadPriority +
+ + +

Returns the adapter for the specified device.

+
+ +

If the GetAdapter method succeeds, the reference count on the adapter interface will be incremented. To avoid a memory leak, be sure to release the interface when you are finished using it.

+
+ + bb174531 + GetAdapter + GetAdapter + HRESULT IDXGIDevice::GetAdapter([Out] IDXGIAdapter** pAdapter) +
+ + +

Gets or sets the GPU thread priority.

+
+ + Bb174532 + GetGPUThreadPriority / SetGPUThreadPriority + GetGPUThreadPriority + HRESULT IDXGIDevice::GetGPUThreadPriority([Out] int* pPriority) +
+ + +

Inherited from objects that are tied to the device so that they can retrieve a reference to it.

+
+ + bb174528 + IDXGIDeviceSubObject + IDXGIDeviceSubObject +
+ + + Retrieves the device. + + The interface that is returned can be any interface published by the device. + The associated device. + HRESULT IDXGIDeviceSubObject::GetDevice([In] GUID* riid,[Out] void** ppDevice) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the device.

+
+

The reference id for the device.

+

The address of a reference to the device.

+

A code that indicates success or failure (see DXGI_ERROR).

+ +

The type of interface that is returned can be any interface published by the device. For example, it could be an * called pDevice, and therefore the REFIID would be obtained by calling __uuidof(pDevice).

+
+ + bb174529 + HRESULT IDXGIDeviceSubObject::GetDevice([In] const GUID& riid,[Out] void** ppDevice) + IDXGIDeviceSubObject::GetDevice +
+ + + Gets or sets the debug-name for this object. + + + The debug name. + + + + +

An interface implements methods for generating DXGI objects (which handle full screen transitions).

+
+ +

Create a factory by calling CreateDXGIFactory.

Because a Direct3D device can be created without creating a swap chain, you might need to retrieve the factory that is used to create the device in order to create a swap chain. + This can be accomplished by requesting the interface from the Direct3D device and then using to locate + the factory. The following code illustrates the process.

 * pDXGIDevice;	
+            hr = g_pd3dDevice->QueryInterface(__uuidof(), (void **)&pDXGIDevice);  * pDXGIAdapter;	
+            hr = pDXGIDevice->GetParent(__uuidof(), (void **)&pDXGIAdapter);  * pIDXGIFactory;	
+            pDXGIAdapter->GetParent(__uuidof(), (void **)&pIDXGIFactory);	
+            

See for a diagram of the relationship between DXGI objects.

+
+ + bb174535 + IDXGIFactory + IDXGIFactory +
+ + + Default Constructor for Factory + + + + + Create an adapter interface that represents a software adapter. + + + A software adapter is a DLL that implements the entirety of a device driver interface, plus emulation, if necessary, of kernel-mode graphics components for Windows. Details on implementing a software adapter can be found in the Windows Vista Driver Development Kit. This is a very complex development task, and is not recommended for general readers. Calling this method will increment the module's reference count by one. The reference count can be decremented by calling {{FreeLibrary}}. The typical calling scenario is to call {{LoadLibrary}}, pass the handle to CreateSoftwareAdapter, then immediately call {{FreeLibrary}} on the DLL and forget the DLL's {{HMODULE}}. Since the software adapter calls FreeLibrary when it is destroyed, the lifetime of the DLL will now be owned by the adapter, and the application is free of any further consideration of its lifetime. + + Handle to the software adapter's dll. + A reference to an adapter (see ). + HRESULT IDXGIFactory::CreateSoftwareAdapter([None] void* Module,[Out] IDXGIAdapter** ppAdapter) + + + + Gets both adapters (video cards) with or without outputs. + + The index of the adapter to enumerate. + a reference to an interface at the position specified by the Adapter parameter + + When you create a factory, the factory enumerates the set of adapters that are available in the system. Therefore, if you change the adapters in a system, you must destroy and recreate the object. The number of adapters in a system changes when you add or remove a display card, or dock or undock a laptop.When the EnumAdapters method succeeds and fills the ppAdapter parameter with the address of the reference to the adapter interface, EnumAdapters increments the adapter interface's reference count. When you finish using the adapter interface, call the Release method to decrement the reference count before you destroy the reference.EnumAdapters first returns the local adapter with the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumAdapters then returns other adapters with outputs. + + HRESULT IDXGIFactory::EnumAdapters([In] unsigned int Adapter,[Out] IDXGIAdapter** ppAdapter) + + + + Return the number of available adapters from this factory. + + The number of adapters + HRESULT IDXGIFactory::EnumAdapters([In] unsigned int Adapter,[Out] IDXGIAdapter** ppAdapter) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Enumerates the adapters (video cards).

+
+

The index of the adapter to enumerate.

+

The address of a reference to an interface at the position specified by the Adapter parameter. This parameter must not be null.

+

Returns if successful; otherwise, returns if the index is greater than or equal to the number of adapters in the local system, or if ppAdapter parameter is null.

+ +

When you create a factory, the factory enumerates the set of adapters that are available in the system. Therefore, if you change the adapters in a system, you must destroy and recreate the object. The number of adapters in a system changes when you add or remove a display card, or dock or undock a laptop.

When the EnumAdapters method succeeds and fills the ppAdapter parameter with the address of the reference to the adapter interface, EnumAdapters increments the adapter interface's reference count. When you finish using the adapter interface, call the Release method to decrement the reference count before you destroy the reference.

EnumAdapters first returns the local adapter with the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumAdapters then returns other adapters with outputs.

+
+ + bb174538 + HRESULT IDXGIFactory::EnumAdapters([In] unsigned int Adapter,[Out] IDXGIAdapter** ppAdapter) + IDXGIFactory::EnumAdapters +
+ + +

Allows DXGI to monitor an application's message queue for the alt-enter key sequence (which causes the application to switch from windowed to full screen or vice versa).

+
+

The handle of the window that is to be monitored. This parameter can be null; but only if the flags are also 0.

+

One or more of the following values:

  • - Prevent DXGI from monitoring an applications message queue; this makes DXGI unable to respond to mode changes.
  • - Prevent DXGI from responding to an alt-enter sequence.
  • - Prevent DXGI from responding to a print-screen key.
+

if WindowHandle is invalid, or E_OUTOFMEMORY.

+ +

The combination of WindowHandle and Flags informs DXGI to stop monitoring window messages for the previously-associated window.

If the application switches to full-screen mode, DXGI will choose a full-screen resolution to be the smallest supported resolution that is larger or the same size as the current back buffer size.

Applications can make some changes to make the transition from windowed to full screen more efficient. For example, on a WM_SIZE message, the application should release any outstanding swap-chain back buffers, call , then re-acquire the back buffers from the swap chain(s). This gives the swap chain(s) an opportunity to resize the back buffers, and/or recreate them to enable full-screen flipping operation. If the application does not perform this sequence, DXGI will still make the full-screen/windowed transition, but may be forced to use a stretch operation (since the back buffers may not be the correct size), which may be less efficient. Even if a stretch is not required, presentation may not be optimal because the back buffers might not be directly interchangeable with the front buffer. Thus, a call to ResizeBuffers on WM_SIZE is always recommended, since WM_SIZE is always sent during a fullscreen transition.

While windowed, the application can, if it chooses, restrict the size of its window's client area to sizes to which it is comfortable rendering. A fully flexible application would make no such restriction, but UI elements or other design considerations can, of course, make this flexibility untenable. If the application further chooses to restrict its window's client area to just those that match supported full-screen resolutions, the application can field WM_SIZING, then check against . If a matching mode is found, allow the resize. (The can be retrieved from . Absent subsequent changes to desktop topology, this will be the same output that will be chosen when alt-enter is fielded and fullscreen mode is begun for that swap chain.)

Applications that want to handle mode changes or Alt+Enter themselves should call MakeWindowAssociation with the flag after swap chain creation. The WindowHandle argument, if non-null, specifies that the application message queues will not be handled by the DXGI runtime for all swap chains of a particular target . Calling MakeWindowAssociation with the flag after swapchain creation ensures that DXGI will not interfere with application's handling of window mode changes or Alt+Enter.

Notes for Metro style apps

If a Metro style app calls MakeWindowAssociation, it fails with .

A Microsoft Win32 application can use MakeWindowAssociation to control full-screen transitions through the Alt+Enter key combination and print screen behavior for full screen. For Metro style apps, because DXGI cannot perform full-screen transitions, Metro style app have no way to control full-screen transitions.

+
+ + bb174540 + HRESULT IDXGIFactory::MakeWindowAssociation([In] HWND WindowHandle,[In] DXGI_MWA_FLAGS Flags) + IDXGIFactory::MakeWindowAssociation +
+ + +

Get the window through which the user controls the transition to and from full screen.

+
+

A reference to a window handle.

+ + Notes for Metro style apps

If a Metro style app calls GetWindowAssociation, it fails with .

+
+ + Bb174539 + HRESULT IDXGIFactory::GetWindowAssociation([Out] HWND* pWindowHandle) + IDXGIFactory::GetWindowAssociation +
+ + +

[Starting with Direct3D 11.1, we recommend not to use CreateSwapChain anymore to create a swap chain. Instead, use CreateSwapChainForHwnd, CreateSwapChainForImmersiveWindow, or CreateSwapChainForCompositionSurface depending on how you want to create the swap chain.]

Creates a swap chain.

+
+ No documentation. + No documentation. + No documentation. +

if pDesc or ppSwapChain is null, if you request full-screen mode and it is unavailable, or E_OUTOFMEMORY. Other error codes defined by the type of device passed in may also be returned.

+ +

If you attempt to create a swap chain in full-screen mode, and full-screen mode is unavailable, the swap chain will be created in windowed mode and will be returned.

If the buffer width or the buffer height is zero, the sizes will be inferred from the output window size in the swap-chain description.

Because the target output cannot be chosen explicitly when the swap-chain is created, you should not create a full-screen swap chain. This can reduce presentation performance if the swap chain size and the output window size do not match. Here are two ways to ensure that the sizes match:

  • Create a windowed swap chain and then set it full-screen using .
  • Save a reference to the swap chain immediately after creation, and use it to get the output window size during a WM_SIZE event. Then resize the swap chain buffers (with ) during the transition from windowed to full-screen.

If the swap chain is in full-screen mode, before you release it you must use SetFullscreenState to switch it to windowed mode. For more information about releasing a swap chain, see the "Destroying a Swap Chain" section of DXGI Overview.

You can specify and values in the swap-chain description that pDesc points to. These values allow you to use features like flip-model presentation and content protection by using pre-Windows Developer Preview APIs.

However, to use stereo presentation and to change resize behavior for the flip model, applications must use the IDXGIFactory2::CreateSwapChainForHwnd method. Otherwise, the back-buffer contents implicitly scale to fit the presentation target size; that is, you can't turn off scaling.

Notes for Metro style apps

If a Metro style app calls CreateSwapChain with full screen specified, CreateSwapChain fails.

Metro style apps call the IDXGIFactory2::CreateSwapChainForImmersiveWindow method to create a swap chain.

+
+ + bb174537 + HRESULT IDXGIFactory::CreateSwapChain([In] IUnknown* pDevice,[In] DXGI_SWAP_CHAIN_DESC* pDesc,[Out, Fast] IDXGISwapChain** ppSwapChain) + IDXGIFactory::CreateSwapChain +
+ + +

Create an adapter interface that represents a software adapter.

+
+

Handle to the software adapter's dll. HMODULE can be obtained with GetModuleHandle or LoadLibrary.

+

Address of a reference to an adapter (see ).

+ +

A software adapter is a DLL that implements the entirety of a device driver interface, plus emulation, if necessary, of kernel-mode graphics components for Windows. Details on implementing a software adapter can be found in the Windows Vista Driver Development Kit. This is a very complex development task, and is not recommended for general readers.

Calling this method will increment the module's reference count by one. The reference count can be decremented by calling FreeLibrary.

The typical calling scenario is to call LoadLibrary, pass the handle to CreateSoftwareAdapter, then immediately call FreeLibrary on the DLL and forget the DLL's HMODULE. Since the software adapter calls FreeLibrary when it is destroyed, the lifetime of the DLL will now be owned by the adapter, and the application is free of any further consideration of its lifetime.

+
+ + bb174536 + HRESULT IDXGIFactory::CreateSoftwareAdapter([In] HINSTANCE Module,[Out] IDXGIAdapter** ppAdapter) + IDXGIFactory::CreateSoftwareAdapter +
+ + + Return an array of available from this factory. + + HRESULT IDXGIFactory::EnumAdapters([In] unsigned int Adapter,[Out] IDXGIAdapter** ppAdapter) + + + +

The interface implements methods for generating DXGI objects.

+
+ +

This interface is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

To create a factory, call the CreateDXGIFactory1 function.

+
+ + ff471335 + IDXGIFactory1 + IDXGIFactory1 +
+ + + Default Constructor for Factory1. + + + + + Gets both adapters (video cards) with or without outputs. + + The index of the adapter to enumerate. + a reference to an interface at the position specified by the Adapter parameter + + This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).When you create a factory, the factory enumerates the set of adapters that are available in the system. Therefore, if you change the adapters in a system, you must destroy and recreate the object. The number of adapters in a system changes when you add or remove a display card, or dock or undock a laptop.When the EnumAdapters1 method succeeds and fills the ppAdapter parameter with the address of the reference to the adapter interface, EnumAdapters1 increments the adapter interface's reference count. When you finish using the adapter interface, call the Release method to decrement the reference count before you destroy the reference.EnumAdapters1 first returns the local adapter with the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumAdapters1 next returns other adapters with outputs. EnumAdapters1 finally returns adapters without outputs. + + HRESULT IDXGIFactory1::EnumAdapters1([In] unsigned int Adapter,[Out] IDXGIAdapter1** ppAdapter) + + + + Return the number of available adapters from this factory. + + The number of adapters + HRESULT IDXGIFactory1::EnumAdapters1([In] unsigned int Adapter,[Out] IDXGIAdapter1** ppAdapter) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Enumerates both adapters (video cards) with or without outputs.

+
+

The index of the adapter to enumerate.

+

The address of a reference to an interface at the position specified by the Adapter parameter. This parameter must not be null.

+

Returns if successful; otherwise, returns if the index is greater than or equal to the number of adapters in the local system, or if ppAdapter parameter is null.

+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

When you create a factory, the factory enumerates the set of adapters that are available in the system. Therefore, if you change the adapters in a system, you must destroy and recreate the object. The number of adapters in a system changes when you add or remove a display card, or dock or undock a laptop.

When the EnumAdapters1 method succeeds and fills the ppAdapter parameter with the address of the reference to the adapter interface, EnumAdapters1 increments the adapter interface's reference count. When you finish using the adapter interface, call the Release method to decrement the reference count before you destroy the reference.

EnumAdapters1 first returns the local adapter with the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumAdapters1 next returns other adapters with outputs. EnumAdapters1 finally returns adapters without outputs.

+
+ + ff471336 + HRESULT IDXGIFactory1::EnumAdapters1([In] unsigned int Adapter,[Out] IDXGIAdapter1** ppAdapter) + IDXGIFactory1::EnumAdapters1 +
+ + +

Informs an application of the possible need to re-enumerate adapters.

+
+

, if a new adapter is becoming available or the current adapter is going away. TRUE, no adapter changes.

IsCurrent returns to inform the calling application to re-enumerate adapters.

+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

+
+ + ff471337 + BOOL IDXGIFactory1::IsCurrent() + IDXGIFactory1::IsCurrent +
+ + + Return an array of available from this factory. + + HRESULT IDXGIFactory1::EnumAdapters1([In] unsigned int Adapter,[Out] IDXGIAdapter1** ppAdapter) + + + +

Informs an application of the possible need to re-enumerate adapters.

+
+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

+
+ + ff471337 + IsCurrent + IsCurrent + BOOL IDXGIFactory1::IsCurrent() +
+ + + Helper to use with . + + + + + Calculates the size of a in bytes. + + The dxgi format. + size of in bytes + + + + Calculates the size of a in bits. + + The dxgi format. + size of in bits + + + + Returns true if the is valid. + + A format to validate + True if the is valid. + + + + Returns true if the is a compressed format. + + The format to check for compressed. + True if the is a compressed format + + + + Determines whether the specified is packed. + + The DXGI Format. + true if the specified is packed; otherwise, false. + + + + Determines whether the specified is video. + + The . + true if the specified is video; otherwise, false. + + + + Determines whether the specified is a SRGB format. + + The . + true if the specified is a SRGB format; otherwise, false. + + + + Determines whether the specified is typeless. + + The . + true if the specified is typeless; otherwise, false. + + + + Computes the scanline count (number of scanlines). + + The . + The height. + The scanline count. + + + + Static initializer to speed up size calculation (not sure the JIT is enough "smart" for this kind of thing). + + + + +

Identifies the type of DXGI adapter.

+
+ +

The enumerated type is used by the Flags member of the or DXGI_ADAPTER_DESC2 structure to identify the type of DXGI adapter.

+
+ + ff471327 + DXGI_ADAPTER_FLAG + DXGI_ADAPTER_FLAG +
+ + +

Specifies no flags.

+
+ + ff471327 + DXGI_ADAPTER_FLAG_NONE + DXGI_ADAPTER_FLAG_NONE +
+ + +

Value always set to 0. This flag is reserved.

+
+ + ff471327 + DXGI_ADAPTER_FLAG_REMOTE + DXGI_ADAPTER_FLAG_REMOTE +
+ + + No documentation. + + + DXGI_ENUM_MODES_FLAGS + DXGI_ENUM_MODES_FLAGS + + + + No documentation. + + + DXGI_ENUM_MODES_INTERLACED + DXGI_ENUM_MODES_INTERLACED + + + + No documentation. + + + DXGI_ENUM_MODES_SCALING + DXGI_ENUM_MODES_SCALING + + + +

Flags that indicate how the back buffers should be rotated to fit the physical rotation of a monitor.

+
+ + bb173065 + DXGI_MODE_ROTATION + DXGI_MODE_ROTATION +
+ + +

Unspecified rotation.

+
+ + bb173065 + DXGI_MODE_ROTATION_UNSPECIFIED + DXGI_MODE_ROTATION_UNSPECIFIED +
+ + +

Specifies no rotation.

+
+ + bb173065 + DXGI_MODE_ROTATION_IDENTITY + DXGI_MODE_ROTATION_IDENTITY +
+ + +

Specifies 90 degrees of rotation.

+
+ + bb173065 + DXGI_MODE_ROTATION_ROTATE90 + DXGI_MODE_ROTATION_ROTATE90 +
+ + +

Specifies 180 degrees of rotation.

+
+ + bb173065 + DXGI_MODE_ROTATION_ROTATE180 + DXGI_MODE_ROTATION_ROTATE180 +
+ + +

Specifies 270 degrees of rotation.

+
+ + bb173065 + DXGI_MODE_ROTATION_ROTATE270 + DXGI_MODE_ROTATION_ROTATE270 +
+ + +

Flags indicating how an image is stretched to fit a given monitor's resolution.

+
+ + bb173066 + DXGI_MODE_SCALING + DXGI_MODE_SCALING +
+ + +

Unspecified scaling.

+
+ + bb173066 + DXGI_MODE_SCALING_UNSPECIFIED + DXGI_MODE_SCALING_UNSPECIFIED +
+ + +

Specifies no scaling. The image is centered on the display. This flag is typically used for a fixed-dot-pitch display (such as an LED display).

+
+ + bb173066 + DXGI_MODE_SCALING_CENTERED + DXGI_MODE_SCALING_CENTERED +
+ + +

Specifies stretched scaling.

+
+ + bb173066 + DXGI_MODE_SCALING_STRETCHED + DXGI_MODE_SCALING_STRETCHED +
+ + +

Flags indicating the method the raster uses to create an image on a surface.

+
+ + bb173067 + DXGI_MODE_SCANLINE_ORDER + DXGI_MODE_SCANLINE_ORDER +
+ + +

Scanline order is unspecified.

+
+ + bb173067 + DXGI_MODE_SCANLINE_ORDER_UNSPECIFIED + DXGI_MODE_SCANLINE_ORDER_UNSPECIFIED +
+ + +

The image is created from the first scanline to the last without skipping any.

+
+ + bb173067 + DXGI_MODE_SCANLINE_ORDER_PROGRESSIVE + DXGI_MODE_SCANLINE_ORDER_PROGRESSIVE +
+ + +

The image is created beginning with the upper field.

+
+ + bb173067 + DXGI_MODE_SCANLINE_ORDER_UPPER_FIELD_FIRST + DXGI_MODE_SCANLINE_ORDER_UPPER_FIELD_FIRST +
+ + +

The image is created beginning with the lower field.

+
+ + bb173067 + DXGI_MODE_SCANLINE_ORDER_LOWER_FIELD_FIRST + DXGI_MODE_SCANLINE_ORDER_LOWER_FIELD_FIRST +
+ + +

Status codes that can be returned by DXGI functions.

+
+ + cc308061 + DXGI_STATUS + DXGI_STATUS +
+ + + No documentation. + + + DXGI_STATUS_OCCLUDED + DXGI_STATUS_OCCLUDED + + + + No documentation. + + + DXGI_STATUS_CLIPPED + DXGI_STATUS_CLIPPED + + + + No documentation. + + + DXGI_STATUS_NO_REDIRECTION + DXGI_STATUS_NO_REDIRECTION + + + + No documentation. + + + DXGI_STATUS_NO_DESKTOP_ACCESS + DXGI_STATUS_NO_DESKTOP_ACCESS + + + + No documentation. + + + DXGI_STATUS_GRAPHICS_VIDPN_SOURCE_IN_USE + DXGI_STATUS_GRAPHICS_VIDPN_SOURCE_IN_USE + + + + No documentation. + + + DXGI_STATUS_MODE_CHANGED + DXGI_STATUS_MODE_CHANGED + + + + No documentation. + + + DXGI_STATUS_MODE_CHANGE_IN_PROGRESS + DXGI_STATUS_MODE_CHANGE_IN_PROGRESS + + + +

Resource data formats which includes fully-typed and typeless formats. There is a list of format modifiers at the bottom of the page, that more fully describes each format type.

+
+ +

A few formats have additional restrictions.

  1. A resource declared with the DXGI_FORMAT_R32G32B32 family of formats cannot be used simultaneously for vertex and texture data. That is, you may not create a buffer resource with the DXGI_FORMAT_R32G32B32 family of formats that uses any of the following bind flags: , , , or (see ).
  2. is designed specifically for text filtering, and must be used with a format-specific, configurable 8x8 filter mode. When calling an HLSL sampling function using this format, the address offset parameter must be set to (0,0).
  3. A resource using a sub-sampled format (such as DXGI_FORMAT_R8G8_B8G8) must have a size that is a multiple of 2 in the x dimension.
  4. Format is not available in Direct3D 10 and Direct3D 10.1

The following topics provide lists of the formats that particular hardware feature levels support:

  • Hardware Support for Direct3D 11.1 Formats
  • Hardware Support for Direct3D 11 Formats
  • Hardware Support for Direct3D 10.1 Formats
  • Hardware Support for Direct3D 10 Formats
  • Hardware Support for Direct3D 10Level9 Formats

For a list of the DirectXMath types that map to values, see DirectXMath Library Internals.

Format Modifiers

Each enumeration value contains a format modifier which describes the data type.

Format ModifiersDescription
_FLOATA floating-point value; 32-bit floating-point formats use IEEE 754 single-precision (s23e8 format): sign bit, 8-bit biased (127) exponent, and 23-bit mantissa. 16-bit floating-point formats use half-precision (s10e5 format): sign bit, 5-bit biased (15) exponent, and 10-bit mantissa.
_SINTTwo's complement signed integer. For example, a 3-bit SINT represents the values -4, -3, -2, -1, 0, 1, 2, 3.
_SNORMSigned normalized integer; which is interpreted in a resource as a signed integer, and is interpreted in a shader as a signed normalized floating-point value in the range [-1, 1]. For an 2's complement number, the maximum value is 1.0f (a 5-bit value 01111 maps to 1.0f), and the minimum value is -1.0f (a 5-bit value 10000 maps to -1.0f). In addition, the second-minimum number maps to -1.0f (a 5-bit value 10001 maps to -1.0f). The resulting integer representations are evenly spaced floating-point values in the range (-1.0f...0.0f), and also a complementary set of representations for numbers in the range (0.0f...1.0f).
_SRGBStandard RGB data, which roughly displays colors in a linear ramp of luminosity levels such that an average observer, under average viewing conditions, can view them on an average display.

All 0's maps to 0.0f, and all 1's maps to 1.0f. The sequence of unsigned integer encodings between all 0's and all 1's represent a nonlinear progression in the floating-point interpretation of the numbers between 0.0f to 1.0f. For more detail, see the SRGB color standard, IEC 61996-2-1, at IEC (International Electrotechnical Commission).

Conversion to or from sRGB space is automatically done by D3DX10 or D3DX9 texture-load functions. If the format has an alpha channel, the alpha data is also stored in sRGB color space.
_TYPELESSTypeless data, with a defined number of bits. Typeless formats are designed for creating typeless resources; that is, a resource whose size is known, but whose data type is not yet fully defined. When a typeless resource is bound to a shader, the application or shader must resolve the format type (which must match the number of bits per component in the typeless format).

A typeless format contains one or more subformats; each subformat resolves the data type. For example, in the R32G32B32 group, which defines types for three-component 96-bit data, there is one typeless format and three fully typed subformats.

 , , , ,	
+            
_UINTUnsigned integer. For instance, a 3-bit UINT represents the values 0, 1, 2, 3, 4, 5, 6, 7.
_UNORMUnsigned normalized integer; which is interpreted in a resource as an unsigned integer, and is interpreted in a shader as an unsigned normalized floating-point value in the range [0, 1]. All 0's maps to 0.0f, and all 1's maps to 1.0f. A sequence of evenly spaced floating-point values from 0.0f to 1.0f are represented. For instance, a 2-bit UNORM represents 0.0f, 1/3, 2/3, and 1.0f.

?

New Resource Formats

Direct3D 10 offers new data compression formats for compressing high-dynamic range (HDR) lighting data, normal maps and heightfields to a fraction of their original size. These compression types include:

  • Shared-Exponent high-dynamic range (HDR) format (RGBE)
  • New Block-Compressed 1-2 channel UNORM/SNORM formats

The block compression formats can be used for any of the 2D or 3D texture types ( Texture2D, Texture2DArray, Texture3D, or TextureCube) including mipmap surfaces. The block compression techniques require texture dimensions to be a multiple of 4 (since the implementation compresses on blocks of 4x4 texels). In the texture sampler, compressed formats are always decompressed before texture filtering.

+
+ + bb173059 + DXGI_FORMAT + DXGI_FORMAT +
+ + +

The format is not known.

+
+ + bb173059 + DXGI_FORMAT_UNKNOWN + DXGI_FORMAT_UNKNOWN +
+ + +

A four-component, 128-bit typeless format that supports 32 bits per channel including alpha. 1

+
+ + bb173059 + DXGI_FORMAT_R32G32B32A32_TYPELESS + DXGI_FORMAT_R32G32B32A32_TYPELESS +
+ + +

A four-component, 128-bit floating-point format that supports 32 bits per channel including alpha. 1

+
+ + bb173059 + DXGI_FORMAT_R32G32B32A32_FLOAT + DXGI_FORMAT_R32G32B32A32_FLOAT +
+ + +

A four-component, 128-bit unsigned-integer format that supports 32 bits per channel including alpha. 1

+
+ + bb173059 + DXGI_FORMAT_R32G32B32A32_UINT + DXGI_FORMAT_R32G32B32A32_UINT +
+ + +

A four-component, 128-bit signed-integer format that supports 32 bits per channel including alpha. 1

+
+ + bb173059 + DXGI_FORMAT_R32G32B32A32_SINT + DXGI_FORMAT_R32G32B32A32_SINT +
+ + +

A three-component, 96-bit typeless format that supports 32 bits per color channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32B32_TYPELESS + DXGI_FORMAT_R32G32B32_TYPELESS +
+ + +

A three-component, 96-bit floating-point format that supports 32 bits per color channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32B32_FLOAT + DXGI_FORMAT_R32G32B32_FLOAT +
+ + +

A three-component, 96-bit unsigned-integer format that supports 32 bits per color channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32B32_UINT + DXGI_FORMAT_R32G32B32_UINT +
+ + +

A three-component, 96-bit signed-integer format that supports 32 bits per color channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32B32_SINT + DXGI_FORMAT_R32G32B32_SINT +
+ + +

A four-component, 64-bit typeless format that supports 16 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R16G16B16A16_TYPELESS + DXGI_FORMAT_R16G16B16A16_TYPELESS +
+ + +

A four-component, 64-bit floating-point format that supports 16 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R16G16B16A16_FLOAT + DXGI_FORMAT_R16G16B16A16_FLOAT +
+ + +

A four-component, 64-bit unsigned-normalized-integer format that supports 16 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R16G16B16A16_UNORM + DXGI_FORMAT_R16G16B16A16_UNORM +
+ + +

A four-component, 64-bit unsigned-integer format that supports 16 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R16G16B16A16_UINT + DXGI_FORMAT_R16G16B16A16_UINT +
+ + +

A four-component, 64-bit signed-normalized-integer format that supports 16 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R16G16B16A16_SNORM + DXGI_FORMAT_R16G16B16A16_SNORM +
+ + +

A four-component, 64-bit signed-integer format that supports 16 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R16G16B16A16_SINT + DXGI_FORMAT_R16G16B16A16_SINT +
+ + +

A two-component, 64-bit typeless format that supports 32 bits for the red channel and 32 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32_TYPELESS + DXGI_FORMAT_R32G32_TYPELESS +
+ + +

A two-component, 64-bit floating-point format that supports 32 bits for the red channel and 32 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32_FLOAT + DXGI_FORMAT_R32G32_FLOAT +
+ + +

A two-component, 64-bit unsigned-integer format that supports 32 bits for the red channel and 32 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32_UINT + DXGI_FORMAT_R32G32_UINT +
+ + +

A two-component, 64-bit signed-integer format that supports 32 bits for the red channel and 32 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R32G32_SINT + DXGI_FORMAT_R32G32_SINT +
+ + +

A two-component, 64-bit typeless format that supports 32 bits for the red channel, 8 bits for the green channel, and 24 bits are unused.

+
+ + bb173059 + DXGI_FORMAT_R32G8X24_TYPELESS + DXGI_FORMAT_R32G8X24_TYPELESS +
+ + +

A 32-bit floating-point component, and two unsigned-integer components (with an additional 32 bits). This format supports 32-bit depth, 8-bit stencil, and 24 bits are unused.

+
+ + bb173059 + DXGI_FORMAT_D32_FLOAT_S8X24_UINT + DXGI_FORMAT_D32_FLOAT_S8X24_UINT +
+ + +

A 32-bit floating-point component, and two typeless components (with an additional 32 bits). This format supports 32-bit red channel, 8 bits are unused, and 24 bits are unused.

+
+ + bb173059 + DXGI_FORMAT_R32_FLOAT_X8X24_TYPELESS + DXGI_FORMAT_R32_FLOAT_X8X24_TYPELESS +
+ + +

A 32-bit typeless component, and two unsigned-integer components (with an additional 32 bits). This format has 32 bits unused, 8 bits for green channel, and 24 bits are unused.

+
+ + bb173059 + DXGI_FORMAT_X32_TYPELESS_G8X24_UINT + DXGI_FORMAT_X32_TYPELESS_G8X24_UINT +
+ + +

A four-component, 32-bit typeless format that supports 10 bits for each color and 2 bits for alpha.

+
+ + bb173059 + DXGI_FORMAT_R10G10B10A2_TYPELESS + DXGI_FORMAT_R10G10B10A2_TYPELESS +
+ + +

A four-component, 32-bit unsigned-normalized-integer format that supports 10 bits for each color and 2 bits for alpha.

+
+ + bb173059 + DXGI_FORMAT_R10G10B10A2_UNORM + DXGI_FORMAT_R10G10B10A2_UNORM +
+ + +

A four-component, 32-bit unsigned-integer format that supports 10 bits for each color and 2 bits for alpha.

+
+ + bb173059 + DXGI_FORMAT_R10G10B10A2_UINT + DXGI_FORMAT_R10G10B10A2_UINT +
+ + +

Three partial-precision floating-point numbers encoded into a single 32-bit value (a variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent). There are no sign bits, and there is a 5-bit biased (15) exponent for each channel, 6-bit mantissa for R and G, and a 5-bit mantissa for B, as shown in the following illustration.

+
+ + bb173059 + DXGI_FORMAT_R11G11B10_FLOAT + DXGI_FORMAT_R11G11B10_FLOAT +
+ + +

A four-component, 32-bit typeless format that supports 8 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R8G8B8A8_TYPELESS + DXGI_FORMAT_R8G8B8A8_TYPELESS +
+ + +

A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R8G8B8A8_UNORM + DXGI_FORMAT_R8G8B8A8_UNORM +
+ + +

A four-component, 32-bit unsigned-normalized integer sRGB format that supports 8 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R8G8B8A8_UNORM_SRGB + DXGI_FORMAT_R8G8B8A8_UNORM_SRGB +
+ + +

A four-component, 32-bit unsigned-integer format that supports 8 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R8G8B8A8_UINT + DXGI_FORMAT_R8G8B8A8_UINT +
+ + +

A four-component, 32-bit signed-normalized-integer format that supports 8 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R8G8B8A8_SNORM + DXGI_FORMAT_R8G8B8A8_SNORM +
+ + +

A four-component, 32-bit signed-integer format that supports 8 bits per channel including alpha.

+
+ + bb173059 + DXGI_FORMAT_R8G8B8A8_SINT + DXGI_FORMAT_R8G8B8A8_SINT +
+ + +

A two-component, 32-bit typeless format that supports 16 bits for the red channel and 16 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R16G16_TYPELESS + DXGI_FORMAT_R16G16_TYPELESS +
+ + +

A two-component, 32-bit floating-point format that supports 16 bits for the red channel and 16 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R16G16_FLOAT + DXGI_FORMAT_R16G16_FLOAT +
+ + +

A two-component, 32-bit unsigned-normalized-integer format that supports 16 bits each for the green and red channels.

+
+ + bb173059 + DXGI_FORMAT_R16G16_UNORM + DXGI_FORMAT_R16G16_UNORM +
+ + +

A two-component, 32-bit unsigned-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R16G16_UINT + DXGI_FORMAT_R16G16_UINT +
+ + +

A two-component, 32-bit signed-normalized-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R16G16_SNORM + DXGI_FORMAT_R16G16_SNORM +
+ + +

A two-component, 32-bit signed-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R16G16_SINT + DXGI_FORMAT_R16G16_SINT +
+ + +

A single-component, 32-bit typeless format that supports 32 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R32_TYPELESS + DXGI_FORMAT_R32_TYPELESS +
+ + +

A single-component, 32-bit floating-point format that supports 32 bits for depth.

+
+ + bb173059 + DXGI_FORMAT_D32_FLOAT + DXGI_FORMAT_D32_FLOAT +
+ + +

A single-component, 32-bit floating-point format that supports 32 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R32_FLOAT + DXGI_FORMAT_R32_FLOAT +
+ + +

A single-component, 32-bit unsigned-integer format that supports 32 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R32_UINT + DXGI_FORMAT_R32_UINT +
+ + +

A single-component, 32-bit signed-integer format that supports 32 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R32_SINT + DXGI_FORMAT_R32_SINT +
+ + +

A two-component, 32-bit typeless format that supports 24 bits for the red channel and 8 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R24G8_TYPELESS + DXGI_FORMAT_R24G8_TYPELESS +
+ + +

A 32-bit z-buffer format that supports 24 bits for depth and 8 bits for stencil.

+
+ + bb173059 + DXGI_FORMAT_D24_UNORM_S8_UINT + DXGI_FORMAT_D24_UNORM_S8_UINT +
+ + +

A 32-bit format, that contains a 24 bit, single-component, unsigned-normalized integer, with an additional typeless 8 bits. This format has 24 bits red channel and 8 bits unused.

+
+ + bb173059 + DXGI_FORMAT_R24_UNORM_X8_TYPELESS + DXGI_FORMAT_R24_UNORM_X8_TYPELESS +
+ + +

A 32-bit format, that contains a 24 bit, single-component, typeless format, with an additional 8 bit unsigned integer component. This format has 24 bits unused and 8 bits green channel.

+
+ + bb173059 + DXGI_FORMAT_X24_TYPELESS_G8_UINT + DXGI_FORMAT_X24_TYPELESS_G8_UINT +
+ + +

A two-component, 16-bit typeless format that supports 8 bits for the red channel and 8 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R8G8_TYPELESS + DXGI_FORMAT_R8G8_TYPELESS +
+ + +

A two-component, 16-bit unsigned-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R8G8_UNORM + DXGI_FORMAT_R8G8_UNORM +
+ + +

A two-component, 16-bit unsigned-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R8G8_UINT + DXGI_FORMAT_R8G8_UINT +
+ + +

A two-component, 16-bit signed-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R8G8_SNORM + DXGI_FORMAT_R8G8_SNORM +
+ + +

A two-component, 16-bit signed-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

+
+ + bb173059 + DXGI_FORMAT_R8G8_SINT + DXGI_FORMAT_R8G8_SINT +
+ + +

A single-component, 16-bit typeless format that supports 16 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R16_TYPELESS + DXGI_FORMAT_R16_TYPELESS +
+ + +

A single-component, 16-bit floating-point format that supports 16 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R16_FLOAT + DXGI_FORMAT_R16_FLOAT +
+ + +

A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for depth.

+
+ + bb173059 + DXGI_FORMAT_D16_UNORM + DXGI_FORMAT_D16_UNORM +
+ + +

A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R16_UNORM + DXGI_FORMAT_R16_UNORM +
+ + +

A single-component, 16-bit unsigned-integer format that supports 16 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R16_UINT + DXGI_FORMAT_R16_UINT +
+ + +

A single-component, 16-bit signed-normalized-integer format that supports 16 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R16_SNORM + DXGI_FORMAT_R16_SNORM +
+ + +

A single-component, 16-bit signed-integer format that supports 16 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R16_SINT + DXGI_FORMAT_R16_SINT +
+ + +

A single-component, 8-bit typeless format that supports 8 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R8_TYPELESS + DXGI_FORMAT_R8_TYPELESS +
+ + +

A single-component, 8-bit unsigned-normalized-integer format that supports 8 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R8_UNORM + DXGI_FORMAT_R8_UNORM +
+ + +

A single-component, 8-bit unsigned-integer format that supports 8 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R8_UINT + DXGI_FORMAT_R8_UINT +
+ + +

A single-component, 8-bit signed-normalized-integer format that supports 8 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R8_SNORM + DXGI_FORMAT_R8_SNORM +
+ + +

A single-component, 8-bit signed-integer format that supports 8 bits for the red channel.

+
+ + bb173059 + DXGI_FORMAT_R8_SINT + DXGI_FORMAT_R8_SINT +
+ + +

A single-component, 8-bit unsigned-normalized-integer format for alpha only.

+
+ + bb173059 + DXGI_FORMAT_A8_UNORM + DXGI_FORMAT_A8_UNORM +
+ + +

A single-component, 1-bit unsigned-normalized integer format that supports 1 bit for the red channel. 2.

+
+ + bb173059 + DXGI_FORMAT_R1_UNORM + DXGI_FORMAT_R1_UNORM +
+ + +

Three partial-precision floating-point numbers encoded into a single 32-bit value all sharing the same 5-bit exponent (variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent). There is no sign bit, and there is a shared 5-bit biased (15) exponent and a 9-bit mantissa for each channel, as shown in the following illustration. 2.

+
+ + bb173059 + DXGI_FORMAT_R9G9B9E5_SHAREDEXP + DXGI_FORMAT_R9G9B9E5_SHAREDEXP +
+ + +

A four-component, 32-bit unsigned-normalized-integer format. This packed RGB format is analogous to the UYVY format. Each 32-bit block describes a pair of pixels: (R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel. 3

+
+ + bb173059 + DXGI_FORMAT_R8G8_B8G8_UNORM + DXGI_FORMAT_R8G8_B8G8_UNORM +
+ + +

A four-component, 32-bit unsigned-normalized-integer format. This packed RGB format is analogous to the YUY2 format. Each 32-bit block describes a pair of pixels: (R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel. 3

+
+ + bb173059 + DXGI_FORMAT_G8R8_G8B8_UNORM + DXGI_FORMAT_G8R8_G8B8_UNORM +
+ + +

Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC1_TYPELESS + DXGI_FORMAT_BC1_TYPELESS +
+ + +

Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC1_UNORM + DXGI_FORMAT_BC1_UNORM +
+ + +

Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC1_UNORM_SRGB + DXGI_FORMAT_BC1_UNORM_SRGB +
+ + +

Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC2_TYPELESS + DXGI_FORMAT_BC2_TYPELESS +
+ + +

Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC2_UNORM + DXGI_FORMAT_BC2_UNORM +
+ + +

Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC2_UNORM_SRGB + DXGI_FORMAT_BC2_UNORM_SRGB +
+ + +

Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC3_TYPELESS + DXGI_FORMAT_BC3_TYPELESS +
+ + +

Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC3_UNORM + DXGI_FORMAT_BC3_UNORM +
+ + +

Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC3_UNORM_SRGB + DXGI_FORMAT_BC3_UNORM_SRGB +
+ + +

One-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC4_TYPELESS + DXGI_FORMAT_BC4_TYPELESS +
+ + +

One-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC4_UNORM + DXGI_FORMAT_BC4_UNORM +
+ + +

One-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC4_SNORM + DXGI_FORMAT_BC4_SNORM +
+ + +

Two-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC5_TYPELESS + DXGI_FORMAT_BC5_TYPELESS +
+ + +

Two-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC5_UNORM + DXGI_FORMAT_BC5_UNORM +
+ + +

Two-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC5_SNORM + DXGI_FORMAT_BC5_SNORM +
+ + +

A three-component, 16-bit unsigned-normalized-integer format that supports 5 bits for blue, 6 bits for green, and 5 bits for red.

+
+ + bb173059 + DXGI_FORMAT_B5G6R5_UNORM + DXGI_FORMAT_B5G6R5_UNORM +
+ + +

A four-component, 16-bit unsigned-normalized-integer format that supports 5 bits for each color channel and 1-bit alpha.

+
+ + bb173059 + DXGI_FORMAT_B5G5R5A1_UNORM + DXGI_FORMAT_B5G5R5A1_UNORM +
+ + +

A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8-bit alpha.

+
+ + bb173059 + DXGI_FORMAT_B8G8R8A8_UNORM + DXGI_FORMAT_B8G8R8A8_UNORM +
+ + +

A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8 bits unused.

+
+ + bb173059 + DXGI_FORMAT_B8G8R8X8_UNORM + DXGI_FORMAT_B8G8R8X8_UNORM +
+ + +

A four-component, 32-bit 2.8-biased fixed-point format that supports 10 bits for each color channel and 2-bit alpha.

+
+ + bb173059 + DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM + DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM +
+ + +

A four-component, 32-bit typeless format that supports 8 bits for each channel including alpha. 4

+
+ + bb173059 + DXGI_FORMAT_B8G8R8A8_TYPELESS + DXGI_FORMAT_B8G8R8A8_TYPELESS +
+ + +

A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each channel including alpha. 4

+
+ + bb173059 + DXGI_FORMAT_B8G8R8A8_UNORM_SRGB + DXGI_FORMAT_B8G8R8A8_UNORM_SRGB +
+ + +

A four-component, 32-bit typeless format that supports 8 bits for each color channel, and 8 bits are unused. 4

+
+ + bb173059 + DXGI_FORMAT_B8G8R8X8_TYPELESS + DXGI_FORMAT_B8G8R8X8_TYPELESS +
+ + +

A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each color channel, and 8 bits are unused. 4

+
+ + bb173059 + DXGI_FORMAT_B8G8R8X8_UNORM_SRGB + DXGI_FORMAT_B8G8R8X8_UNORM_SRGB +
+ + +

A typeless block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC6H_TYPELESS + DXGI_FORMAT_BC6H_TYPELESS +
+ + +

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC6H_UF16 + DXGI_FORMAT_BC6H_UF16 +
+ + +

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC6H_SF16 + DXGI_FORMAT_BC6H_SF16 +
+ + +

A typeless block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC7_TYPELESS + DXGI_FORMAT_BC7_TYPELESS +
+ + +

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC7_UNORM + DXGI_FORMAT_BC7_UNORM +
+ + +

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

+
+ + bb173059 + DXGI_FORMAT_BC7_UNORM_SRGB + DXGI_FORMAT_BC7_UNORM_SRGB +
+ + + No documentation. + + + DXGI_MAP_FLAGS + DXGI_MAP_FLAGS + + + + No documentation. + + + DXGI_MAP_READ + DXGI_MAP_READ + + + + No documentation. + + + DXGI_MAP_WRITE + DXGI_MAP_WRITE + + + + No documentation. + + + DXGI_MAP_DISCARD + DXGI_MAP_DISCARD + + + + No documentation. + + + DXGI_PRESENT_FLAGS + DXGI_PRESENT_FLAGS + + + + No documentation. + + + DXGI_PRESENT_TEST + DXGI_PRESENT_TEST + + + + No documentation. + + + DXGI_PRESENT_DO_NOT_SEQUENCE + DXGI_PRESENT_DO_NOT_SEQUENCE + + + + No documentation. + + + DXGI_PRESENT_RESTART + DXGI_PRESENT_RESTART + + + + None. + + + None + None + + + +

Flags indicating the memory location of a resource.

+
+ + bb173070 + DXGI_RESIDENCY + DXGI_RESIDENCY +
+ + +

The resource is located in video memory.

+
+ + bb173070 + DXGI_RESIDENCY_FULLY_RESIDENT + DXGI_RESIDENCY_FULLY_RESIDENT +
+ + +

At least some of the resource is located in CPU memory.

+
+ + bb173070 + DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY + DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY +
+ + +

At least some of the resource has been paged out to the hard drive.

+
+ + bb173070 + DXGI_RESIDENCY_EVICTED_TO_DISK + DXGI_RESIDENCY_EVICTED_TO_DISK +
+ + + No documentation. + + + DXGI_RESOURCE_PRIORITY + DXGI_RESOURCE_PRIORITY + + + + No documentation. + + + DXGI_RESOURCE_PRIORITY_MINIMUM + DXGI_RESOURCE_PRIORITY_MINIMUM + + + + No documentation. + + + DXGI_RESOURCE_PRIORITY_LOW + DXGI_RESOURCE_PRIORITY_LOW + + + + No documentation. + + + DXGI_RESOURCE_PRIORITY_NORMAL + DXGI_RESOURCE_PRIORITY_NORMAL + + + + No documentation. + + + DXGI_RESOURCE_PRIORITY_HIGH + DXGI_RESOURCE_PRIORITY_HIGH + + + + No documentation. + + + DXGI_RESOURCE_PRIORITY_MAXIMUM + DXGI_RESOURCE_PRIORITY_MAXIMUM + + + + No documentation. + + + DXGI_SHARED_RESOURCE_FLAGS + DXGI_SHARED_RESOURCE_FLAGS + + + + None. + + + None + None + + + +

Options for swap-chain behavior.

+
+ +

This enumeration is used by the structure and the method.

This enumeration is also used by the DXGI_SWAP_CHAIN_DESC1 structure.

Swap chains that you create in full-screen mode with the method behave as if DXGI_SWAP_CHAIN_FLAG_DISPLAY_ONLY is set even though the flag is not set. That is, presented content is not accessible by remote access or through the desktop duplication APIs.

Swap chains that you create with the IDXGIFactory2::CreateSwapChainForHwnd, IDXGIFactory2::CreateSwapChainForImmersiveWindow, and IDXGIFactory2::CreateSwapChainForCompositionSurface methods are not protected if DXGI_SWAP_CHAIN_FLAG_DISPLAY_ONLY is not set and are protected if DXGI_SWAP_CHAIN_FLAG_DISPLAY_ONLY is set. When swap chains are protected, screen scraping is prevented and, in full-screen mode, presented content is not accessible through the desktop duplication APIs.

+
+ + bb173076 + DXGI_SWAP_CHAIN_FLAG + DXGI_SWAP_CHAIN_FLAG +
+ + +

Set this flag to turn off automatic image rotation; that is, do not perform a rotation when transferring the contents of the front buffer to the monitor. Use this flag to avoid a bandwidth penalty when an application expects to handle rotation. This option is valid only during full-screen mode.

+
+ + bb173076 + DXGI_SWAP_CHAIN_FLAG_NONPREROTATED + DXGI_SWAP_CHAIN_FLAG_NONPREROTATED +
+ + +

Set this flag to enable an application to switch modes by calling . When switching from windowed to full-screen mode, the display mode (or monitor resolution) will be changed to match the dimensions of the application window.

+
+ + bb173076 + DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH + DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH +
+ + +

Set this flag to enable an application to render using GDI on a swap chain or a surface. This will allow the application to call on the 0th back buffer or a surface.

+
+ + bb173076 + DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE + DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE +
+ + + None. + + + None + None + + + +

Options for handling pixels in a display surface after calling .

+
+ +

This enumeration is used by the structure.

This enumeration is also used by the DXGI_SWAP_CHAIN_DESC1 structure.

The primary difference between presentation models is how back-buffer contents get to the Desktop Window Manager (DWM) for composition. In the bitblt model, which is used with the and values, contents of the back buffer get copied into the redirection surface on each call to . In the flip model, which is used with the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value, all back buffers are shared with the DWM. Therefore, the DWM can compose straight from those back buffers without any additional copy operations. + In general, the flip model is the more efficient model. The flip model also provides more features, such as enhanced present statistics. +

Regardless of whether the flip model is more efficient, an application still might choose the bitblt model for the following reasons:

  • The bitblt model is the only way to mix GDI and DirectX presentation.

    In the flip model, the application must create the swap chain with , and then must use GetDC on the back buffer explicitly. After the first successful call to on a flip-model swap chain, GDI no longer works with the that is associated with that swap chain, even after the destruction of the swap chain. This restriction even extends to methods like ScrollWindowEx.

  • The flip model requires at least three window-sized buffers if the application uses child windows. For the bitblt model, this minimum is two buffers.

+
+ + bb173077 + DXGI_SWAP_EFFECT + DXGI_SWAP_EFFECT +
+ + + No documentation. + + + DXGI_SWAP_EFFECT_DISCARD + DXGI_SWAP_EFFECT_DISCARD + + + + No documentation. + + + DXGI_SWAP_EFFECT_SEQUENTIAL + DXGI_SWAP_EFFECT_SEQUENTIAL + + + + No documentation. + + + DXGI_USAGE_ENUM + DXGI_USAGE_ENUM + + + + No documentation. + + + DXGI_USAGE_SHADER_INPUT + DXGI_USAGE_SHADER_INPUT + + + + No documentation. + + + DXGI_USAGE_RENDER_TARGET_OUTPUT + DXGI_USAGE_RENDER_TARGET_OUTPUT + + + + No documentation. + + + DXGI_USAGE_BACK_BUFFER + DXGI_USAGE_BACK_BUFFER + + + + No documentation. + + + DXGI_USAGE_SHARED + DXGI_USAGE_SHARED + + + + No documentation. + + + DXGI_USAGE_READ_ONLY + DXGI_USAGE_READ_ONLY + + + + No documentation. + + + DXGI_USAGE_DISCARD_ON_PRESENT + DXGI_USAGE_DISCARD_ON_PRESENT + + + + No documentation. + + + DXGI_USAGE_UNORDERED_ACCESS + DXGI_USAGE_UNORDERED_ACCESS + + + + No documentation. + + + DXGI_MWA_FLAGS + DXGI_MWA_FLAGS + + + + No documentation. + + + DXGI_MWA_NO_WINDOW_CHANGES + DXGI_MWA_NO_WINDOW_CHANGES + + + + No documentation. + + + DXGI_MWA_NO_ALT_ENTER + DXGI_MWA_NO_ALT_ENTER + + + + No documentation. + + + DXGI_MWA_NO_PRINT_SCREEN + DXGI_MWA_NO_PRINT_SCREEN + + + + No documentation. + + + DXGI_MWA_VALID + DXGI_MWA_VALID + + + + None. + + + None + None + + + + Functions + + + + + +

Creates a DXGI 1.1 factory that generates objects used to enumerate and specify video graphics settings.

+
+

The globally unique identifier () of the object referenced by the ppFactory parameter.

+

Address of a reference to an object.

+

Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR.

+ +

Use a DXGI 1.1 factory to generate objects that enumerate adapters, create swap chains, and associate a window with the alt+enter key sequence for toggling to and from the full-screen display mode.

If the CreateDXGIFactory1 function succeeds, the reference count on the interface is incremented. To avoid a memory leak, when you finish using the interface, call the IDXGIFactory1::Release method to release the interface.

This entry point is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

Note??Do not mix the use of DXGI 1.0 () and DXGI 1.1 () in an application. Use or , but not both in an application.

+
+ + ff471318 + HRESULT CreateDXGIFactory1([In] const GUID& riid,[Out] void** ppFactory) + CreateDXGIFactory1 +
+ + +

Creates a DXGI 1.0 factory that generates objects used to enumerate and specify video graphics settings.

+
+

The globally unique identifier () of the object referenced by the ppFactory parameter.

+

Address of a reference to an object.

+

Returns if successful; otherwise, returns one of the following DXGI_ERROR.

+ +

Use a DXGI factory to generate objects that enumerate adapters, create swap chains, and associate a window with the alt+enter key sequence for toggling to and from the fullscreen display mode.

If the CreateDXGIFactory function succeeds, the reference count on the interface is incremented. To avoid a memory leak, when you finish using the interface, call the IDXGIFactory::Release method to release the interface.

Note??Do not mix the use of DXGI 1.0 () and DXGI 1.1 () in an application. Use or , but not both in an application.

The CreateDXGIFactory function does not exist for Metro style apps. Instead, Metro style apps use the CreateDXGIFactory1 function.

+
+ + bb204862 + HRESULT CreateDXGIFactory([In] const GUID& riid,[Out] void** ppFactory) + CreateDXGIFactory +
+ + + Functions + + + + + Constant FrameStatisticsDisjoint. + DXGI_ERROR_FRAME_STATISTICS_DISJOINT + + + Constant DeviceReset. + DXGI_ERROR_DEVICE_RESET + + + Constant NotFound. + DXGI_ERROR_NOT_FOUND + + + Constant DriverInternalError. + DXGI_ERROR_DRIVER_INTERNAL_ERROR + + + Constant InvalidCall. + DXGI_ERROR_INVALID_CALL + + + Constant WasStillDrawing. + DXGI_ERROR_WAS_STILL_DRAWING + + + Constant Unsupported. + DXGI_ERROR_UNSUPPORTED + + + Constant RemoteClientDisconnected. + DXGI_ERROR_REMOTE_CLIENT_DISCONNECTED + + + Constant DeviceRemoved. + DXGI_ERROR_DEVICE_REMOVED + + + Constant DeviceHung. + DXGI_ERROR_DEVICE_HUNG + + + Constant RemoteOufOfMemory. + DXGI_ERROR_REMOTE_OUTOFMEMORY + + + Constant MoreData. + DXGI_ERROR_MORE_DATA + + + Constant Nonexclusive. + DXGI_ERROR_NONEXCLUSIVE + + + Constant GraphicsVidpnSourceInUse. + DXGI_ERROR_GRAPHICS_VIDPN_SOURCE_IN_USE + + + Constant NotCurrentlyAvailable. + DXGI_ERROR_NOT_CURRENTLY_AVAILABLE + + + +

The interface represents a display sub-system (including one or more GPU's, DACs and video memory).

+
+ +

This interface is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

A display sub-system is often referred to as a video card, however, on some machines the display sub-system is part of the mother board.

To enumerate the display sub-systems, use . To get an interface to the adapter for a particular device, use . To create a software adapter, use .

+
+ + ff471329 + IDXGIAdapter1 + IDXGIAdapter1 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets a DXGI 1.1 description of an adapter (or video card).

+
+

A reference to a structure that describes the adapter. This parameter must not be null.

+

Returns if successful; otherwise, returns E_INVALIDARG if the pDesc parameter is null.

+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

Use the GetDesc1 method to get a DXGI 1.1 description of an adapter. To get a DXGI 1.0 description, use the method.

+
+ + ff471330 + HRESULT IDXGIAdapter1::GetDesc1([Out] DXGI_ADAPTER_DESC1* pDesc) + IDXGIAdapter1::GetDesc1 +
+ + +

Gets a DXGI 1.1 description of an adapter (or video card).

+
+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

Use the GetDesc1 method to get a DXGI 1.1 description of an adapter. To get a DXGI 1.0 description, use the method.

+
+ + ff471330 + GetDesc1 + GetDesc1 + HRESULT IDXGIAdapter1::GetDesc1([Out] DXGI_ADAPTER_DESC1* pDesc) +
+ + +

An interface implements a derived class for DXGI objects that produce image data.

+
+ +

This interface is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

The interface is designed for use by DXGI objects that need access to other DXGI objects. This interface is useful to applications that do not use Direct3D to communicate with DXGI.

+
+ + ff471331 + IDXGIDevice1 + IDXGIDevice1 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets the number of frames that the system is allowed to queue for rendering.

+
+

The maximum number of back buffer frames that a driver can queue. The value defaults to 3, but can range from 1 to 16. A value of 0 will reset latency to the default. For multi-head devices, this value is specified per-head.

+

Returns if successful; otherwise, if the device was removed.

+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data.

+
+ + ff471334 + HRESULT IDXGIDevice1::SetMaximumFrameLatency([In] unsigned int MaxLatency) + IDXGIDevice1::SetMaximumFrameLatency +
+ + +

Gets the number of frames that the system is allowed to queue for rendering.

+
+

This value is set to the number of frames that can be queued for render. This value defaults to 3, but can range from 1 to 16.

+

Returns if successful; otherwise, returns one of the following members of the D3DERR enumerated type:

+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data.

+
+ + ff471332 + HRESULT IDXGIDevice1::GetMaximumFrameLatency([Out] unsigned int* pMaxLatency) + IDXGIDevice1::GetMaximumFrameLatency +
+ + +

Gets or sets the number of frames that the system is allowed to queue for rendering.

+
+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data.

+
+ + ff471332 + GetMaximumFrameLatency / SetMaximumFrameLatency + GetMaximumFrameLatency + HRESULT IDXGIDevice1::GetMaximumFrameLatency([Out] unsigned int* pMaxLatency) +
+ + +

Using a key, acquires exclusive rendering access to a shared resource.

+
+ +

The AcquireSync method creates a lock to a surface that is shared between multiple devices, allowing only one device to render to a surface at a time. This method uses a key to determine which device currently has exclusive access to the surface.

When a surface is created using the value of the enumeration, you must call the AcquireSync method before rendering to the surface. You must call the ReleaseSync method when you are done rendering to a surface.

To acquire a reference to the keyed mutex object of a shared resource, call the QueryInterface method of the resource and pass in the UUID of the interface. For more information about acquiring this reference, see the following code example.

The AcquireSync method uses the key as follows, depending on the state of the surface:

  • On initial creation, the surface is unowned and any device can call the AcquireSync method to gain access. For an unowned device, only a key of 0 will succeed. Calling the AcquireSync method for any other key will stall the calling CPU thread.
  • If the surface is owned by a device when you call the AcquireSync method, the CPU thread that called the AcquireSync method will stall until the owning device calls the ReleaseSync method using the same Key.
  • If the surface is unowned when you call the AcquireSync method (for example, the last owning device has already called the ReleaseSync method), the AcquireSync method will succeed if you specify the same key that was specified when the ReleaseSync method was last called. Calling the AcquireSync method using any other key will cause a stall.
  • When the owning device calls the ReleaseSync method with a particular key, and more than one device is waiting after calling the AcquireSync method using the same key, any one of the waiting devices could be woken up first. The order in which devices are woken up is undefined.
  • A keyed mutex does not support recursive calls to the AcquireSync method.
+
+ + ff471339 + IDXGIKeyedMutex + IDXGIKeyedMutex +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Using a key, acquires exclusive rendering access to a shared resource.

+
+

A value that indicates which device to give access to. This method will succeed when the device that currently owns the surface calls the method using the same value. This value can be any UINT64 value.

+

The time-out interval, in milliseconds. This method will return if the interval elapses, and the keyed mutex has not been released using the specified Key. If this value is set to zero, the AcquireSync method will test to see if the keyed mutex has been released and returns immediately. If this value is set to INFINITE, the time-out interval will never elapse.

+

Return if successful.

If the owning device attempted to create another keyed mutex on the same shared resource, AcquireSync returns E_FAIL.

AcquireSync can also return the following DWORD constants. Therefore, you should explicitly check for these constants. If you only use the SUCCEEDED macro on the return value to determine if AcquireSync succeeded, you will not catch these constants.

  • WAIT_ABANDONED - The shared surface and keyed mutex are no longer in a consistent state. If AcquireSync returns this value, you should release and recreate both the keyed mutex and the shared surface.
  • WAIT_TIMEOUT - The time-out interval elapsed before the specified key was released.
+ +

The AcquireSync method creates a lock to a surface that is shared between multiple devices, allowing only one device to render to a surface at a time. This method uses a key to determine which device currently has exclusive access to the surface.

When a surface is created using the value of the enumeration, you must call the AcquireSync method before rendering to the surface. You must call the ReleaseSync method when you are done rendering to a surface.

To acquire a reference to the keyed mutex object of a shared resource, call the QueryInterface method of the resource and pass in the UUID of the interface. For more information about acquiring this reference, see the following code example.

The AcquireSync method uses the key as follows, depending on the state of the surface:

  • On initial creation, the surface is unowned and any device can call the AcquireSync method to gain access. For an unowned device, only a key of 0 will succeed. Calling the AcquireSync method for any other key will stall the calling CPU thread.
  • If the surface is owned by a device when you call the AcquireSync method, the CPU thread that called the AcquireSync method will stall until the owning device calls the ReleaseSync method using the same Key.
  • If the surface is unowned when you call the AcquireSync method (for example, the last owning device has already called the ReleaseSync method), the AcquireSync method will succeed if you specify the same key that was specified when the ReleaseSync method was last called. Calling the AcquireSync method using any other key will cause a stall.
  • When the owning device calls the ReleaseSync method with a particular key, and more than one device is waiting after calling the AcquireSync method using the same key, any one of the waiting devices could be woken up first. The order in which devices are woken up is undefined.
  • A keyed mutex does not support recursive calls to the AcquireSync method.
+
+ + ff471339 + HRESULT IDXGIKeyedMutex::AcquireSync([In] unsigned longlong Key,[In] unsigned int dwMilliseconds) + IDXGIKeyedMutex::AcquireSync +
+ + +

Using a key, releases exclusive rendering access to a shared resource.

+
+

A value that indicates which device to give access to. This method succeeds when the device that currently owns the surface calls the ReleaseSync method using the same value. This value can be any UINT64 value.

+

Returns if successful.

If the device attempted to release a keyed mutex that is not valid or owned by the device, ReleaseSync returns E_FAIL.

+ +

The ReleaseSync method releases a lock to a surface that is shared between multiple devices. This method uses a key to determine which device currently has exclusive access to the surface.

When a surface is created using the value of the enumeration, you must call the method before rendering to the surface. You must call the ReleaseSync method when you are done rendering to a surface.

After you call the ReleaseSync method, the shared resource is unset from the rendering pipeline.

To acquire a reference to the keyed mutex object of a shared resource, call the QueryInterface method of the resource and pass in the UUID of the interface. For more information about acquiring this reference, see the following code example.

+
+ + ff471340 + HRESULT IDXGIKeyedMutex::ReleaseSync([In] unsigned longlong Key) + IDXGIKeyedMutex::ReleaseSync +
+ + +

An interface represents an adapter output (such as a monitor).

+
+ +

To see the outputs available, use . To see the specific output that the swap chain will update, use .

+
+ + bb174546 + IDXGIOutput + IDXGIOutput +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a description of the output.

+
+

A reference to the output description (see ).

+

Returns a code that indicates success or failure. if successful, if pDesc is passed in as null.

+ + bb174548 + HRESULT IDXGIOutput::GetDesc([Out] DXGI_OUTPUT_DESC* pDesc) + IDXGIOutput::GetDesc +
+ + +

[Starting with Direct3D 11.1, we recommend not to use GetDisplayModeList anymore to retrieve the matching display mode. Instead, use IDXGIOutput1::GetDisplayModeList1, which supports stereo display mode.]

Gets the display modes that match the requested format and other input options.

+
+ No documentation. + No documentation. + No documentation. + No documentation. +

Returns one of the following DXGI_ERROR. It is rare, but possible, that the display modes available can change immediately after calling this method, in which case is returned (if there is not enough room for all the display modes). If GetDisplayModeList is called from a Remote Desktop Services session (formerly Terminal Services session), is returned.

+ +

In general, when switching from windowed to full-screen mode, a swap chain automatically chooses a display mode that meets (or exceeds) the resolution, color depth and refresh rate of the swap chain. To exercise more control over the display mode, use this API to poll the set of display modes that are validated against monitor capabilities, or all modes that match the desktop (if the desktop settings are not validated against the monitor).

As shown, this API is designed to be called twice. First to get the number of modes available, and second to return a description of the modes.

 UINT num = 0;	
+             format = ;	
+            UINT flags         = ; pOutput->GetDisplayModeList( format, flags, &num, 0); ...  * pDescs = new [num];	
+            pOutput->GetDisplayModeList( format, flags, &num, pDescs); 
+
+ + bb174549 + HRESULT IDXGIOutput::GetDisplayModeList([In] DXGI_FORMAT EnumFormat,[In] unsigned int Flags,[InOut] unsigned int* pNumModes,[Out, Buffer, Optional] DXGI_MODE_DESC* pDesc) + IDXGIOutput::GetDisplayModeList +
+ + +

[Starting with Direct3D 11.1, we recommend not to use FindClosestMatchingMode anymore to find the display mode that most closely matches the requested display mode. Instead, use IDXGIOutput1::FindClosestMatchingMode1, which supports stereo display mode.]

Finds the display mode that most closely matches the requested display mode.

+
+ No documentation. + No documentation. + No documentation. +

Returns one of the following DXGI_ERROR.

+ +

FindClosestMatchingMode behaves similarly to the IDXGIOutput1::FindClosestMatchingMode1 except FindClosestMatchingMode considers only the mono display modes. IDXGIOutput1::FindClosestMatchingMode1 considers only stereo modes if you set the Stereo member in the DXGI_MODE_DESC1 structure that pModeToMatch points to, and considers only mono modes if Stereo is not set.

IDXGIOutput1::FindClosestMatchingMode1 returns a matched display-mode set with only stereo modes or only mono modes. + FindClosestMatchingMode behaves as though you specified the input mode as mono.

+
+ + bb174547 + HRESULT IDXGIOutput::FindClosestMatchingMode([In] const DXGI_MODE_DESC* pModeToMatch,[Out] DXGI_MODE_DESC* pClosestMatch,[In, Optional] IUnknown* pConcernedDevice) + IDXGIOutput::FindClosestMatchingMode +
+ + +

Halt a thread until the next vertical blank occurs.

+
+

Returns one of the following DXGI_ERROR.

+ +

A vertical blank occurs when the raster moves from the lower right corner to the upper left corner to begin drawing the next frame.

+
+ + bb174559 + HRESULT IDXGIOutput::WaitForVBlank() + IDXGIOutput::WaitForVBlank +
+ + +

Takes ownership of an output.

+
+

A reference to the interface of a device (such as an ).

+

Set to TRUE to enable other threads or applications to take ownership of the device; otherwise, set to .

+

Returns one of the DXGI_ERROR values.

+ +

When you are finished with the output, call .

TakeOwnership should not be called directly by applications, since results will be unpredictable. It is called implicitly by the DXGI swap chain object during full-screen transitions, and should not be used as a substitute for swap-chain methods.

Notes for Metro style apps

If a Metro style app uses TakeOwnership, it fails with .

+
+ + Bb174558 + HRESULT IDXGIOutput::TakeOwnership([In] IUnknown* pDevice,[In] BOOL Exclusive) + IDXGIOutput::TakeOwnership +
+ + +

Releases ownership of the output.

+
+ +

If you are not using a swap chain, get access to an output by calling and release it when you are finished by calling . An application that uses a swap chain will typically not call either of these methods.

+
+ + Bb174554 + void IDXGIOutput::ReleaseOwnership() + IDXGIOutput::ReleaseOwnership +
+ + +

Gets a description of the gamma-control capabilities.

+
+

A reference to a description of the gamma-control capabilities (see ).

+

Returns one of the DXGI_ERROR values.

+ +

Note??Calling this method is only supported while in full-screen mode.

+
+ + bb174553 + HRESULT IDXGIOutput::GetGammaControlCapabilities([Out] DXGI_GAMMA_CONTROL_CAPABILITIES* pGammaCaps) + IDXGIOutput::GetGammaControlCapabilities +
+ + +

Sets the gamma controls.

+
+

A reference to an array of gamma controls (see ).

+

Returns one of the DXGI_ERROR values.

+ +

Note??Calling this method is only supported while in full-screen mode.

+
+ + Bb174557 + HRESULT IDXGIOutput::SetGammaControl([In] const DXGI_GAMMA_CONTROL* pArray) + IDXGIOutput::SetGammaControl +
+ + +

Gets the gamma control settings.

+
+

An array of gamma control settings (see ).

+

Returns one of the DXGI_ERROR values.

+ +

Note??Calling this method is only supported while in full-screen mode.

+
+ + bb174552 + HRESULT IDXGIOutput::GetGammaControl([Out] DXGI_GAMMA_CONTROL* pArray) + IDXGIOutput::GetGammaControl +
+ + +

Changes the display mode.

+
+

A reference to a surface (see ) used for rendering an image to the screen. The surface must have been created as a back buffer (DXGI_USAGE_BACKBUFFER).

+

Returns one of the DXGI_ERROR values.

+ +

should not be called directly by applications, since results will be unpredictable. It is called implicitly by the DXGI swap chain object during full-screen transitions, and should not be used as a substitute for swap-chain methods.

This method should only be called between and calls.

Notes for Metro style apps

If a Metro style app uses SetDisplaySurface, it fails with .

+
+ + bb174556 + HRESULT IDXGIOutput::SetDisplaySurface([In] IDXGISurface* pScanoutSurface) + IDXGIOutput::SetDisplaySurface +
+ + +

[Starting with Direct3D 11.1, we recommend not to use GetDisplaySurfaceData anymore to retrieve the current display surface. Instead, use IDXGIOutput1::GetDisplaySurfaceData1, which supports stereo display mode.]

Gets a copy of the current display surface.

+
+ No documentation. +

Returns one of the DXGI_ERROR values.

+ +

can only be called when an output is in full-screen mode. If the method succeeds, DXGI fills the destination surface.

Use to determine the size (width and height) of the output when you want to allocate space for the destination surface. This is true regardless of target monitor rotation. A destination surface created by a graphics component (such as Direct3D 10) must be created with CPU-write permission (see ). Other surfaces should be created with CPU read-write permission (see D3D10_CPU_ACCESS_READ_WRITE). This method will modify the surface data to fit the destination surface (stretch, shrink, convert format, rotate). The stretch and shrink is performed with point-sampling.

+
+ + bb174550 + HRESULT IDXGIOutput::GetDisplaySurfaceData([In] IDXGISurface* pDestination) + IDXGIOutput::GetDisplaySurfaceData +
+ + +

Gets statistics about recently rendered frames.

+
+

A reference to frame statistics (see ).

+

If this function succeeds, it returns . Otherwise, it might return .

+ +

This API is similar to .

Note??Calling this method is only supported while in full-screen mode.

+
+ + bb174551 + HRESULT IDXGIOutput::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats) + IDXGIOutput::GetFrameStatistics +
+ + + Find the display mode that most closely matches the requested display mode. + + + Direct3D devices require UNORM formats. This method finds the closest matching available display mode to the mode specified in pModeToMatch. Similarly ranked fields (ie. all specified, or all unspecified, etc) are resolved in the following order. ScanlineOrdering Scaling Format Resolution RefreshRate When determining the closest value for a particular field, previously matched fields are used to filter the display mode list choices, and other fields are ignored. For example, when matching Resolution, the display mode list will have already been filtered by a certain ScanlineOrdering, Scaling, and Format, while RefreshRate is ignored. This ordering doesn't define the absolute ordering for every usage scenario of FindClosestMatchingMode, because the application can choose some values initially, effectively changing the order that fields are chosen. Fields of the display mode are matched one at a time, generally in a specified order. If a field is unspecified, FindClosestMatchingMode gravitates toward the values for the desktop related to this output. If this output is not part of the desktop, then the default desktop output is used to find values. If an application uses a fully unspecified display mode, FindClosestMatchingMode will typically return a display mode that matches the desktop settings for this output. Unspecified fields are lower priority than specified fields and will be resolved later than specified fields. + + A reference to the Direct3D device interface. If this parameter is NULL, only modes whose format matches that of pModeToMatch will be returned; otherwise, only those formats that are supported for scan-out by the device are returned. + The desired display mode (see ). Members of DXGI_MODE_DESC can be unspecified indicating no preference for that member. A value of 0 for Width or Height indicates the value is unspecified. If either Width or Height are 0 both must be 0. A numerator and denominator of 0 in RefreshRate indicate it is unspecified. Other members of DXGI_MODE_DESC have enumeration values indicating the member is unspecified. If pConnectedDevice is NULL Format cannot be DXGI_FORMAT_UNKNOWN. + The mode that most closely matches pModeToMatch. + Returns one of the following . + HRESULT IDXGIOutput::FindClosestMatchingMode([In] const DXGI_MODE_DESC* pModeToMatch,[Out] DXGI_MODE_DESC* pClosestMatch,[In, Optional] IUnknown* pConcernedDevice) + + + + Gets the display modes that match the requested format and other input options. + + + In general, when switching from windowed to full-screen mode, a swap chain automatically chooses a display mode that meets (or exceeds) the resolution, color depth and refresh rate of the swap chain. To exercise more control over the display mode, use this API to poll the set of display modes that are validated against monitor capabilities, or all modes that match the desktop (if the desktop settings are not validated against the monitor). As shown, this API is designed to be called twice. First to get the number of modes available, and second to return a description of the modes. + UINT num = 0; + DXGI_FORMAT format = DXGI_FORMAT_R32G32B32A32_FLOAT; + UINT flags = DXGI_ENUM_MODES_INTERLACED; pOutput->GetDisplayModeList( format, flags, &num, 0); ... DXGI_MODE_DESC * pDescs = new DXGI_MODE_DESC[num]; + pOutput->GetDisplayModeList( format, flags, &num, pDescs); + + + + The color format (see ). + format for modes to include (see {{DXGI_ENUM_MODES}}). DXGI_ENUM_MODES_SCALING needs to be specified to expose the display modes that require scaling. Centered modes, requiring no scaling and corresponding directly to the display output, are enumerated by default. + Returns a list of display modes (see ); + HRESULT IDXGIOutput::GetDisplayModeList([None] DXGI_FORMAT EnumFormat,[None] int Flags,[InOut] int* pNumModes,[Out, Buffer, Optional] DXGI_MODE_DESC* pDesc) + + + +

Get a description of the output.

+
+ + bb174548 + GetDesc + GetDesc + HRESULT IDXGIOutput::GetDesc([Out] DXGI_OUTPUT_DESC* pDesc) +
+ + +

Gets a description of the gamma-control capabilities.

+
+ +

Note??Calling this method is only supported while in full-screen mode.

+
+ + bb174553 + GetGammaControlCapabilities + GetGammaControlCapabilities + HRESULT IDXGIOutput::GetGammaControlCapabilities([Out] DXGI_GAMMA_CONTROL_CAPABILITIES* pGammaCaps) +
+ + +

Gets or sets the gamma control settings.

+
+ +

Note??Calling this method is only supported while in full-screen mode.

+
+ + bb174552 + GetGammaControl / SetGammaControl + GetGammaControl + HRESULT IDXGIOutput::GetGammaControl([Out] DXGI_GAMMA_CONTROL* pArray) +
+ + +

Gets statistics about recently rendered frames.

+
+ +

This API is similar to .

Note??Calling this method is only supported while in full-screen mode.

+
+ + bb174551 + GetFrameStatistics + GetFrameStatistics + HRESULT IDXGIOutput::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats) +
+ + +

An interface allows resource sharing and identifies the memory that a resource resides in.

+
+ +

To find out what type of memory a resource is currently located in, use . To share resources between processes, use . For information about how to share resources between multiple Windows graphics APIs, including Direct3D 11, Direct2D, Direct3D 10, and Direct3D 9Ex, see Surface Sharing Between Windows Graphics APIs.

You can retrieve the interface from any video memory resource that you create from a Direct3D 10 and later function. Any Direct3D object that supports or also supports . For example, the Direct3D 2D texture object that you create from supports . You can call QueryInterface on the 2D texture object () to retrieve the interface. For example, to retrieve the interface from the 2D texture object, use the following code.

 * pDXGIResource;	
+            hr = g_pd3dTexture2D->QueryInterface(__uuidof(), (void **)&pDXGIResource);	
+            
+
+ + bb174560 + IDXGIResource + IDXGIResource +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

[Starting with Direct3D 11.1, we recommend not to use GetSharedHandle anymore to retrieve the handle to a shared resource. Instead, use IDXGIResource1::CreateSharedHandle to get a handle for sharing. To use IDXGIResource1::CreateSharedHandle, you must create the resource as shared and specify that it uses NT handles (that is, you set the D3D11_RESOURCE_MISC_SHARED_NTHANDLE flag). We also recommend that you create shared resources that use NT handles so you can use CloseHandle, DuplicateHandle, and so on on those shared resources.]

Gets the handle to a shared resource.

+
+ No documentation. +

Returns one of the DXGI_ERROR values.

+ +

You can pass the handle that GetSharedHandle returns in a call to the method to give a device access to a shared resource that you created on a different device.

GetSharedHandle doesn't always return a handle. GetSharedHandle only returns the handle when you created the resource as shared (that is, you set the or flag).

The handle that GetSharedHandle returns is not an NT handle. Therefore, don't use the handle with CloseHandle, DuplicateHandle, and so on. The creator of a shared resource must not destroy the resource until all entities that opened the resource have destroyed the resource. The validity of the handle is tied to the lifetime of the underlying video memory. If no resource objects exist on any devices that refer to this resource, the handle is no longer valid. To extend the lifetime of the handle and video memory, you must open the shared resource on a device.

+
+ + bb174562 + HRESULT IDXGIResource::GetSharedHandle([Out] void** pSharedHandle) + IDXGIResource::GetSharedHandle +
+ + +

Get the expected resource usage.

+
+

A reference to a usage flag (see DXGI_USAGE). For Direct3D 10, a surface can be used as a shader input or a render-target output.

+

Returns one of the following DXGI_ERROR.

+ + bb174563 + HRESULT IDXGIResource::GetUsage([Out] unsigned int* pUsage) + IDXGIResource::GetUsage +
+ + +

Set the priority for evicting the resource from memory.

+
+

The priority is one of the following values:

ValueMeaning
(0x28000000)

The resource is unused and can be evicted as soon as another resource requires the memory that the resource occupies.

(0x50000000)

The eviction priority of the resource is low. The placement of the resource is not critical, and minimal work is performed to find a location for the resource. For example, if a GPU can render with a vertex buffer from either local or non-local memory with little difference in performance, that vertex buffer is low priority. Other more critical resources (for example, a render target or texture) can then occupy the faster memory.

(0x78000000)

The eviction priority of the resource is normal. The placement of the resource is important, but not critical, for performance. The resource is placed in its preferred location instead of a low-priority resource.

(0xa0000000)

The eviction priority of the resource is high. The resource is placed in its preferred location instead of a low-priority or normal-priority resource.

(0xc8000000)

The resource is evicted from memory only if there is no other way of resolving the memory requirement.

?

+

Returns one of the following DXGI_ERROR.

+ +

The eviction priority is a memory-management variable that is used by DXGI for determining how to populate overcommitted memory.

You can set priority levels other than the defined values when appropriate. For example, you can set a resource with a priority level of 0x78000001 to indicate that the resource is slightly above normal.

+
+ + Bb174564 + HRESULT IDXGIResource::SetEvictionPriority([In] unsigned int EvictionPriority) + IDXGIResource::SetEvictionPriority +
+ + +

Get the eviction priority.

+
+

A reference to the eviction priority, which determines when a resource can be evicted from memory.

The following defined values are possible.

ValueMeaning
(0x28000000)

The resource is unused and can be evicted as soon as another resource requires the memory that the resource occupies.

(0x50000000)

The eviction priority of the resource is low. The placement of the resource is not critical, and minimal work is performed to find a location for the resource. For example, if a GPU can render with a vertex buffer from either local or non-local memory with little difference in performance, that vertex buffer is low priority. Other more critical resources (for example, a render target or texture) can then occupy the faster memory.

(0x78000000)

The eviction priority of the resource is normal. The placement of the resource is important, but not critical, for performance. The resource is placed in its preferred location instead of a low-priority resource.

(0xa0000000)

The eviction priority of the resource is high. The resource is placed in its preferred location instead of a low-priority or normal-priority resource.

(0xc8000000)

The resource is evicted from memory only if there is no other way of resolving the memory requirement.

?

+

Returns one of the following DXGI_ERROR.

+ +

The eviction priority is a memory-management variable that is used by DXGI to determine how to manage overcommitted memory.

Priority levels other than the defined values are used when appropriate. For example, a resource with a priority level of 0x78000001 indicates that the resource is slightly above normal.

+
+ + bb174561 + HRESULT IDXGIResource::GetEvictionPriority([Out] unsigned int* pEvictionPriority) + IDXGIResource::GetEvictionPriority +
+ + +

[Starting with Direct3D 11.1, we recommend not to use GetSharedHandle anymore to retrieve the handle to a shared resource. Instead, use IDXGIResource1::CreateSharedHandle to get a handle for sharing. To use IDXGIResource1::CreateSharedHandle, you must create the resource as shared and specify that it uses NT handles (that is, you set the D3D11_RESOURCE_MISC_SHARED_NTHANDLE flag). We also recommend that you create shared resources that use NT handles so you can use CloseHandle, DuplicateHandle, and so on on those shared resources.]

Gets the handle to a shared resource.

+
+ +

You can pass the handle that GetSharedHandle returns in a call to the method to give a device access to a shared resource that you created on a different device.

GetSharedHandle doesn't always return a handle. GetSharedHandle only returns the handle when you created the resource as shared (that is, you set the or flag).

The handle that GetSharedHandle returns is not an NT handle. Therefore, don't use the handle with CloseHandle, DuplicateHandle, and so on. The creator of a shared resource must not destroy the resource until all entities that opened the resource have destroyed the resource. The validity of the handle is tied to the lifetime of the underlying video memory. If no resource objects exist on any devices that refer to this resource, the handle is no longer valid. To extend the lifetime of the handle and video memory, you must open the shared resource on a device.

+
+ + bb174562 + GetSharedHandle + GetSharedHandle + HRESULT IDXGIResource::GetSharedHandle([Out] void** pSharedHandle) +
+ + +

Get the expected resource usage.

+
+ + bb174563 + GetUsage + GetUsage + HRESULT IDXGIResource::GetUsage([Out] unsigned int* pUsage) +
+ + +

Get or sets the eviction priority.

+
+ +

The eviction priority is a memory-management variable that is used by DXGI to determine how to manage overcommitted memory.

Priority levels other than the defined values are used when appropriate. For example, a resource with a priority level of 0x78000001 indicates that the resource is slightly above normal.

+
+ + bb174561 + GetEvictionPriority / SetEvictionPriority + GetEvictionPriority + HRESULT IDXGIResource::GetEvictionPriority([Out] unsigned int* pEvictionPriority) +
+ + +

The interface implements methods for image-data objects.

+
+ +

An image-data object is a 2D section of memory, commonly called a surface. To get the surface from an output, call .

The runtime automatically creates an interface when it creates a Direct3D resource object that represents a surface. For example, the runtime creates an interface when you call or to create a 2D texture. To retrieve the interface that represents the 2D texture surface, call ID3D11Texture2D::QueryInterface or ID3D10Texture2D::QueryInterface. In this call, you must pass the identifier of . If the 2D texture has only a single MIP-map level and does not consist of an array of textures, QueryInterface succeeds and returns a reference to the interface reference. Otherwise, QueryInterface fails and does not return the reference to .

+
+ + bb174565 + IDXGISurface + IDXGISurface +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a description of the surface.

+
+

A reference to the surface description (see ).

+

Returns if successful; otherwise, returns one of the error codes that are described in the DXGI_ERROR topic.

+ + bb174566 + HRESULT IDXGISurface::GetDesc([Out] DXGI_SURFACE_DESC* pDesc) + IDXGISurface::GetDesc +
+ + +

Get a reference to the data contained in the surface, and deny GPU access to the surface.

+
+

A reference to the surface data (see ).

+

CPU read-write flags. These flags can be combined with a logical OR.

  • - Allow CPU read access.
  • - Allow CPU write access.
  • - Discard the previous contents of a resource when it is mapped.
+

Returns if successful; otherwise, returns one of the error codes that are described in the DXGI_ERROR topic.

+ +

Use to access a surface from the CPU. To release a mapped surface (and allow GPU access) call .

+
+ + bb174567 + HRESULT IDXGISurface::Map([Out] DXGI_MAPPED_RECT* pLockedRect,[In] unsigned int MapFlags) + IDXGISurface::Map +
+ + +

Invalidate the reference to the surface retrieved by and re-enable GPU access to the resource.

+
+

Returns if successful; otherwise, returns one of the error codes that are described in the DXGI_ERROR topic.

+ + bb174568 + HRESULT IDXGISurface::Unmap() + IDXGISurface::Unmap +
+ + + Acquires access to the surface data. + + Flags specifying CPU access permissions. + A for accessing the mapped data, or null on failure.. + + + + Acquires access to the surface data. + + Flags specifying CPU access permissions. + A for accessing the mapped data, or null on failure.. + + + + Gets a swap chain back buffer. + + The swap chain to get the buffer from. + The index of the desired buffer. + The buffer interface, or null on failure. + + + +

Get a description of the surface.

+
+ + bb174566 + GetDesc + GetDesc + HRESULT IDXGISurface::GetDesc([Out] DXGI_SURFACE_DESC* pDesc) +
+ + +

The interface extends the by adding support for using Windows Graphics Device Interface (GDI) to render to a Microsoft DirectX Graphics Infrastructure (DXGI) surface.

+
+ +

This interface is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

An image-data object is a 2D section of memory, commonly called a surface. To get the surface from an output, call . Then, call QueryInterface on the object that returns to retrieve the interface.

Any object that supports also supports .

The runtime automatically creates an interface when it creates a Direct3D resource object that represents a surface. For example, the runtime creates an interface when you call or to create a 2D texture. To retrieve the interface that represents the 2D texture surface, call ID3D11Texture2D::QueryInterface or ID3D10Texture2D::QueryInterface. In this call, you must pass the identifier of . If the 2D texture has only a single MIP-map level and does not consist of an array of textures, QueryInterface succeeds and returns a reference to the interface reference. Otherwise, QueryInterface fails and does not return the reference to .

+
+ + ff471343 + IDXGISurface1 + IDXGISurface1 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Returns a device context (DC) that allows you to render to a Microsoft DirectX Graphics Infrastructure (DXGI) surface using Windows Graphics Device Interface (GDI).

+
+

A Boolean value that specifies whether to preserve Direct3D contents in the GDI DC. TRUE directs the runtime not to preserve Direct3D contents in the GDI DC; that is, the runtime discards the Direct3D contents. guarantees that Direct3D contents are available in the GDI DC.

+

A reference to an handle that represents the current device context for GDI rendering.

+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

After you use the GetDC method to retrieve a DC, you can render to the DXGI surface by using GDI. The GetDC method readies the surface for GDI rendering and allows inter-operation between DXGI and GDI technologies.

Keep the following in mind when using this method:

  • You must create the surface by using the flag for a surface or by using the flag for swap chains, otherwise this method fails.
  • You must release the device and call the method before you issue any new Direct3D commands.
  • This method fails if an outstanding DC has already been created by this method.
  • The format for the surface or swap chain must be or .
  • On GetDC, the render target in the output merger of the Direct3D pipeline is unbound from the surface. You must call the method on the device prior to Direct3D rendering after GDI rendering.
  • Prior to resizing buffers you must release all outstanding DCs.

You can also call GetDC on the back buffer at index 0 of a swap chain by obtaining an from the swap chain. The following code illustrates the process.

 * g_pSwapChain = null;	
+            * g_pSurface1 = null;	
+            ...	
+            //Setup the device and and swapchain	
+            g_pSwapChain->GetBuffer(0, __uuidof(), (void**) &g_pSurface1);	
+            g_pSurface1->GetDC( , &g_hDC );	
+            ...      	
+            //Draw on the DC using GDI	
+            ...	
+            //When finish drawing release the DC	
+            g_pSurface1->ReleaseDC( null ); 
+
+ + ff471345 + HRESULT IDXGISurface1::GetDC([In] BOOL Discard,[Out] HDC* phdc) + IDXGISurface1::GetDC +
+ + +

Releases the GDI device context (DC) that is associated with the current surface and allows you to use Direct3D to render.

+
+

A reference to a structure that identifies the dirty region of the surface. A dirty region is any part of the surface that you used for GDI rendering and that you want to preserve. This area is used as a performance hint to graphics subsystem in certain scenarios. Do not use this parameter to restrict rendering to the specified rectangular region. If you pass in null, ReleaseDC considers the whole surface as dirty. Otherwise, ReleaseDC uses the area specified by the as a performance hint to indicate what areas have been manipulated by GDI rendering.

You can pass a reference to an empty structure (a rectangle with no position or area) if you didn't change any content.

+

If this method succeeds, it returns . Otherwise, it returns an error code.

+ +

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).

Use the ReleaseDC method to release the DC and indicate that your application finished all GDI rendering to this surface. You must call the ReleaseDC method before you can use Direct3D to perform additional rendering.

Prior to resizing buffers you must release all outstanding DCs.

+
+ + ff471346 + HRESULT IDXGISurface1::ReleaseDC([In, Optional] RECT* pDirtyRect) + IDXGISurface1::ReleaseDC +
+ + + Releases the GDI device context (DC) associated with the current surface and allows rendering using Direct3D. The whole surface to be considered dirty. + + + Use the ReleaseDC method to release the DC and indicate that your application has finished all GDI rendering to this surface. You must call the ReleaseDC method before you perform addition rendering using Direct3D. Prior to resizing buffers all outstanding DCs must be released. + + If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + HRESULT IDXGISurface1::ReleaseDC([In, Optional] RECT* pDirtyRect) + + + + Releases the GDI device context (DC) associated with the current surface and allows rendering using Direct3D. + + + Use the ReleaseDC method to release the DC and indicate that your application has finished all GDI rendering to this surface. You must call the ReleaseDC method before you perform addition rendering using Direct3D. Prior to resizing buffers all outstanding DCs must be released. + + A reference to a structure that identifies the dirty region of the surface. A dirty region is any part of the surface that you have used for GDI rendering and that you want to preserve. This is used as a performance hint to graphics subsystem in certain scenarios. Do not use this parameter to restrict rendering to the specified rectangular region. The area specified by the will be used as a performance hint to indicate what areas have been manipulated by GDI rendering. + If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + HRESULT IDXGISurface1::ReleaseDC([In, Optional] RECT* pDirtyRect) + + + +

An interface implements one or more surfaces for storing rendered data before presenting it to an output.

+
+ +

You can create a swap chain in several ways. If your application uses Direct3D, create a swap chain when you create a device by + calling or . If your application does not need Direct3D, create a swap chain for use directly with DXGI by + calling , IDXGIFactory2::CreateSwapChainForHwnd, IDXGIFactory2::CreateSwapChainForImmersiveWindow, or IDXGIFactory2::CreateSwapChainForCompositionSurface.

+
+ + bb174569 + IDXGISwapChain + IDXGISwapChain +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

[Starting with Direct3D 11.1, we recommend not to use Present anymore to present a rendered image. Instead, use IDXGISwapChain1::Present1.]

Presents a rendered image to the user.

+
+ No documentation. + No documentation. +

Possible return values include: , or (see DXGI_ERROR), (see ), or D3DDDIERR_DEVICEREMOVED.

Note??The Present method can return either or D3DDDIERR_DEVICEREMOVED if a video card has been physically removed from the computer, or a driver upgrade for the video card has occurred.

+ +

For the best performance when flipping swap-chain buffers in a full-screen application, see Full-Screen Application Performance Hints.

Because calling Present might cause the render thread to wait on the message-pump thread, be careful when calling this method in an application that uses multiple threads. For more details, see Multithreading Considerations.

Differences between Direct3D 9 and Direct3D 10:

Specifying in the Flags parameter is analogous to in Direct3D 9.

?

For flip presentation model swap chains that you create with the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value set, a successful presentation unbinds back buffer 0 from the graphics pipeline, except for when you pass the flag in the Flags parameter.

Flip presentation model queue

Suppose the following frames with sync-interval values are queued from oldest (A) to newest (E) before you call Present.

A: 3, B: 0, C: 0, D: 1, E: 0

When you call Present, the runtime shows frame A for 3 vertical blank intervals, then frame D for 1 vertical blank interval, and then frame E until you submit a new presentation. The runtime discards frames C and D.

+
+ + bb174576 + HRESULT IDXGISwapChain::Present([In] unsigned int SyncInterval,[In] DXGI_PRESENT_FLAGS Flags) + IDXGISwapChain::Present +
+ + +

Accesses one of the swap-chain's back buffers.

+
+

A zero-based buffer index.

If the swap chain's swap effect is , this method can only access the first buffer; for this situation, set the index to zero.

If the swap chain's swap effect is either or DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL, this method can only access read-only buffers with indexes greater than zero. Read-only back buffers have the BufferUsage member of the or DXGI_SWAP_CHAIN_DESC1 structure set to .

+

The type of interface used to manipulate the buffer. See remarks.

+

A reference to a back-buffer interface.

+

Returns one of the following DXGI_ERROR.

+ + bb174570 + HRESULT IDXGISwapChain::GetBuffer([In] unsigned int Buffer,[In] const GUID& riid,[Out] void** ppSurface) + IDXGISwapChain::GetBuffer +
+ + +

Sets the display state to windowed or full screen.

+
+

A Boolean value that specifies whether to set the display state to windowed or full screen. TRUE for full screen, and for windowed.

+

If you pass TRUE to the Fullscreen parameter to set the display state to full screen, you can optionally set this parameter to a reference to an interface for the output target that contains the swap chain. If you set this parameter to null, DXGI will choose the output based on the swap-chain's device and the output window's placement. If you pass to Fullscreen, you must set this parameter to null.

+

This methods returns:

  • if the action succeeded and the swap chain was placed in the requested state.
  • if the action failed. There are many reasons why a windowed-mode swap chain cannot switch to full-screen mode. For instance:
    • The application is running over Terminal Server.
    • The output window is occluded.
    • The output window does not have keyboard focus.
    • Another application is already in full-screen mode.

    When this error is returned, an application can continue to run in windowed mode and try to switch to full-screen mode later.

  • is returned if a fullscreen/windowed mode transition is occurring when this API is called.
  • Other error codes if you run out of memory or encounter another unexpected fault; these codes may be treated as hard, non-continuable errors.
+ +

DXGI may change the display state of a swap chain in response to end user or system requests.

We recommend that you create a windowed swap chain and allow the end user to change the swap chain to full screen through SetFullscreenState; that is, do not set the Windowed member of to to force the swap chain to be full screen. However, if you create the swap chain as full screen, also provide the end user with a list of supported display modes because a swap chain that is created with an unsupported display mode might cause the display to go black and prevent the end user from seeing anything. Also, we recommend that you have a time-out confirmation screen or other fallback mechanism when you allow the end user to change display modes.

Notes for Metro style apps

If a Metro style app calls SetFullscreenState to set the display state to full screen, SetFullscreenState fails with .

You cannot call SetFullscreenState on a windowless swap chain that you created with IDXGIFactory2::CreateSwapChainForCompositionSurface.

For the flip presentation model, after you transition the display state to full screen, you must call ResizeBuffers to ensure that your call to IDXGISwapChain1::Present1 succeeds.

+
+ + bb174579 + HRESULT IDXGISwapChain::SetFullscreenState([In] BOOL Fullscreen,[In, Optional] IDXGIOutput* pTarget) + IDXGISwapChain::SetFullscreenState +
+ + +

Get the state associated with full-screen mode.

+
+

A reference to a boolean whose value is either:

  • TRUE if the swap chain is in full-screen mode
  • if the swap chain is in windowed mode
+

A reference to the output target (see ) when the mode is full screen; otherwise null.

+

Returns one of the following DXGI_ERROR.

+ +

When the swap chain is in full-screen mode, a reference to the target output will be returned and its reference count will be incremented.

+
+ + bb174574 + HRESULT IDXGISwapChain::GetFullscreenState([Out] BOOL* pFullscreen,[Out] IDXGIOutput** ppTarget) + IDXGISwapChain::GetFullscreenState +
+ + +

[Starting with Direct3D 11.1, we recommend not to use GetDesc anymore to get a description of the swap chain. Instead, use IDXGISwapChain1::GetDesc1.]

Get a description of the swap chain.

+
+ No documentation. +

Returns one of the following DXGI_ERROR.

+ + bb174572 + HRESULT IDXGISwapChain::GetDesc([Out] DXGI_SWAP_CHAIN_DESC* pDesc) + IDXGISwapChain::GetDesc +
+ + +

Changes the swap chain's back buffer size, format, and number of buffers. This should be called when the application window is resized.

+
+

The number of buffers in the swap chain (including all back and front buffers). This number can be different from the number of buffers with which you created the swap chain. This number can't be greater than DXGI_MAX_SWAP_CHAIN_BUFFERS. Set this number to zero to preserve the existing number of buffers in the swap chain. You can't specify greater than two buffers for the flip presentation model.

+

New width of the back buffer. If you specify zero, DXGI will use the width of the client area of the target window. You can't specify the width as zero if you called the IDXGIFactory2::CreateSwapChainForCompositionSurface method to create the swap chain for a composition surface.

+

New height of the back buffer. If you specify zero, DXGI will use the height of the client area of the target window. You can't specify the height as zero if you called the IDXGIFactory2::CreateSwapChainForCompositionSurface method to create the swap chain for a composition surface.

+

A -typed value for the new format of the back buffer. Set this value to to preserve the existing format of the back buffer. The flip presentation model supports a more restricted set of formats than the bit-block transfer (bitblt) model.

+

A combination of -typed values that are combined by using a bitwise OR operation. The resulting value specifies options for swap-chain behavior.

+

Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR.

+ +

You can't resize a swap chain unless you release all outstanding references to its back buffers. You must release all of its direct and indirect references on the back buffers in order for ResizeBuffers to succeed.

Direct references are held by the application after it calls AddRef on a resource.

Indirect references are held by views to a resource, binding a view of the resource to a device context, a command list that used the resource, a command list that used a view to that resource, a command list that executed another command list that used the resource, and so on.

Before you call ResizeBuffers, ensure that the application releases all references (by calling the appropriate number of Release invocations) on the resources, any views to the resource, and any command lists that use either the resources or views, and ensure that neither the resource nor a view is still bound to a device context. You can use to ensure that all references are released. If a view is bound to a deferred context, you must discard the partially built command list as well (by calling ClearState, , then Release on the command list). After you call ResizeBuffers, you can re-query interfaces via .

For swap chains that you created with , before you call ResizeBuffers, also call on the swap chain's back-buffer surface to ensure that you have no outstanding GDI device contexts (DCs) open.

We recommend that you call ResizeBuffers when a client window is resized (that is, when an application receives a WM_SIZE message).

The only difference between ResizeBuffers in Windows Developer Preview and ResizeBuffers in Windows?7 is with flip presentation model swap chains that you create with the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value set. In Windows Developer Preview, you must call ResizeBuffers to realize a transition between full-screen mode and windowed mode; otherwise, your next call to the Present method fails.

+
+ + bb174577 + HRESULT IDXGISwapChain::ResizeBuffers([In] unsigned int BufferCount,[In] unsigned int Width,[In] unsigned int Height,[In] DXGI_FORMAT NewFormat,[In] DXGI_SWAP_CHAIN_FLAG SwapChainFlags) + IDXGISwapChain::ResizeBuffers +
+ + +

Resizes the output target.

+
+

A reference to a structure that describes the mode, which specifies the new width, height, format, and refresh rate of the target. If the format is , ResizeTarget uses the existing format. We only recommend that you use when the swap chain is in full-screen mode as this method is not thread safe.

+

Returns a code that indicates success or failure. is returned if a fullscreen/windowed mode transition is occurring when this API is called. See DXGI_ERROR for additional DXGI error codes.

+ +

ResizeTarget resizes the target window when the swap chain is in windowed mode, and changes the display mode on the target output when the swap chain is in full-screen mode. Therefore, applications can call ResizeTarget to resize the target window (rather than a Microsoft Win32API such as SetWindowPos) without knowledge of the swap chain display mode.

If a Metro style app calls ResizeTarget, it fails with .

You cannot call ResizeTarget on a windowless swap chain that you created with IDXGIFactory2::CreateSwapChainForCompositionSurface.

+
+ + bb174578 + HRESULT IDXGISwapChain::ResizeTarget([In] const DXGI_MODE_DESC* pNewTargetParameters) + IDXGISwapChain::ResizeTarget +
+ + +

Get the output (the display monitor) that contains the majority of the client area of the target window.

+
+

A reference to the output interface (see ).

+

Returns one of the following DXGI_ERROR.

+ +

If the method succeeds, the output interface will be filled and its reference count incremented. When you are finished with it, be sure to release the interface to avoid a memory leak.

The output is also owned by the adapter on which the swap chain's device was created.

You cannot call GetContainingOutput on a windowless swap chain that you created with IDXGIFactory2::CreateSwapChainForCompositionSurface.

+
+ + bb174571 + HRESULT IDXGISwapChain::GetContainingOutput([Out] IDXGIOutput** ppOutput) + IDXGISwapChain::GetContainingOutput +
+ + +

Gets performance statistics about the last render frame.

+
+

A reference to a structure for the frame statistics.

+

Returns one of the DXGI_ERROR values.

+ +

You cannot use GetFrameStatistics for swap chains that both use the bit-block transfer (bitblt) presentation model and draw in windowed mode.

You can only use GetFrameStatistics for swap chains that either use the flip presentation model or draw in full-screen mode. You set the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value in the SwapEffect member of the DXGI_SWAP_CHAIN_DESC1 structure to specify that the swap chain uses the flip presentation model.

+
+ + bb174573 + HRESULT IDXGISwapChain::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats) + IDXGISwapChain::GetFrameStatistics +
+ + +

Gets the number of times that or IDXGISwapChain1::Present1 has been called.

+
+ No documentation. +

Returns one of the DXGI_ERROR values.

+ +

For info about presentation statistics for a frame, see .

+
+ + bb174575 + HRESULT IDXGISwapChain::GetLastPresentCount([Out] unsigned int* pLastPresentCount) + IDXGISwapChain::GetLastPresentCount +
+ + + Creates a swap chain. + + + If you attempt to create a swap chain in full-screen mode, and full-screen mode is unavailable, the swap chain will be created in windowed mode and DXGI_STATUS_OCCLUDED will be returned. If the buffer width or the buffer height are zero, the sizes will be inferred from the output window size in the swap-chain description. Since the target output cannot be chosen explicitly when the swap-chain is created, you should not create a full-screen swap chain. This can reduce presentation performance if the swap chain size and the output window size do not match. Here are two ways to ensure the sizes match: Create a windowed swap chain and then set it full-screen using . Save a reference to the swap-chain immediately after creation, and use it to get the output window size during a WM_SIZE event. Then resize the swap chain buffers (with ) during the transition from windowed to full-screen. If the swap chain is in full-screen mode, before you release it, you must use {{SetFullscreenState}} to switch it to windowed mode. For more information about releasing a swap chain, see the Destroying a Swap Chain section of {{DXGI Overview}}. + + a reference to a . + A reference to the device that will write 2D images to the swap chain. + A reference to the swap-chain description (see ). + HRESULT IDXGIFactory::CreateSwapChain([In] IUnknown* pDevice,[In] DXGI_SWAP_CHAIN_DESC* pDesc,[Out] IDXGISwapChain** ppSwapChain) + bb174537 + HRESULT IDXGIFactory::CreateSwapChain([In] IUnknown* pDevice,[In] DXGI_SWAP_CHAIN_DESC* pDesc,[Out, Fast] IDXGISwapChain** ppSwapChain) + IDXGIFactory::CreateSwapChain + + + + Access one of the swap-chain back buffers. + + The interface of the surface to resolve from the back buffer + A zero-based buffer index. If the swap effect is not DXGI_SWAP_EFFECT_SEQUENTIAL, this method only has access to the first buffer; for this case, set the index to zero. + + Returns a reference to a back-buffer interface. + + bb174570 + HRESULT IDXGISwapChain::GetBuffer([In] unsigned int Buffer,[In] const GUID& riid,[Out] void** ppSurface) + IDXGISwapChain::GetBuffer + + + +

[Starting with Direct3D 11.1, we recommend not to use GetDesc anymore to get a description of the swap chain. Instead, use IDXGISwapChain1::GetDesc1.]

Get a description of the swap chain.

+
+ + bb174572 + GetDesc + GetDesc + HRESULT IDXGISwapChain::GetDesc([Out] DXGI_SWAP_CHAIN_DESC* pDesc) +
+ + +

Get the output (the display monitor) that contains the majority of the client area of the target window.

+
+ +

If the method succeeds, the output interface will be filled and its reference count incremented. When you are finished with it, be sure to release the interface to avoid a memory leak.

The output is also owned by the adapter on which the swap chain's device was created.

You cannot call GetContainingOutput on a windowless swap chain that you created with IDXGIFactory2::CreateSwapChainForCompositionSurface.

+
+ + bb174571 + GetContainingOutput + GetContainingOutput + HRESULT IDXGISwapChain::GetContainingOutput([Out] IDXGIOutput** ppOutput) +
+ + +

Gets performance statistics about the last render frame.

+
+ +

You cannot use GetFrameStatistics for swap chains that both use the bit-block transfer (bitblt) presentation model and draw in windowed mode.

You can only use GetFrameStatistics for swap chains that either use the flip presentation model or draw in full-screen mode. You set the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value in the SwapEffect member of the DXGI_SWAP_CHAIN_DESC1 structure to specify that the swap chain uses the flip presentation model.

+
+ + bb174573 + GetFrameStatistics + GetFrameStatistics + HRESULT IDXGISwapChain::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats) +
+ + +

Gets the number of times that or IDXGISwapChain1::Present1 has been called.

+
+ +

For info about presentation statistics for a frame, see .

+
+ + bb174575 + GetLastPresentCount + GetLastPresentCount + HRESULT IDXGISwapChain::GetLastPresentCount([Out] unsigned int* pLastPresentCount) +
+ + + Gets or sets a value indicating whether the swapchain is in fullscreen. + + + true if this swapchain is in fullscreen; otherwise, false. + + bb174574 + HRESULT IDXGISwapChain::GetFullscreenState([Out] BOOL* pFullscreen,[Out] IDXGIOutput** ppTarget) + IDXGISwapChain::GetFullscreenState + + + +

Describes an adapter (or video card) by using DXGI 1.0.

+
+ +

The structure provides a description of an adapter. This structure is initialized by using the method.

+
+ + bb173058 + DXGI_ADAPTER_DESC + DXGI_ADAPTER_DESC +
+ + +

A string that contains the adapter description.

+
+ + bb173058 + wchar_t Description[128] + wchar_t Description +
+ + +

The PCI ID of the hardware vendor.

+
+ + bb173058 + unsigned int VendorId + unsigned int VendorId +
+ + +

The PCI ID of the hardware device.

+
+ + bb173058 + unsigned int DeviceId + unsigned int DeviceId +
+ + +

The PCI ID of the sub system.

+
+ + bb173058 + unsigned int SubSysId + unsigned int SubSysId +
+ + +

The PCI ID of the revision number of the adapter.

+
+ + bb173058 + unsigned int Revision + unsigned int Revision +
+ + +

The number of bytes of dedicated video memory that are not shared with the CPU.

+
+ + bb173058 + SIZE_T DedicatedVideoMemory + SIZE_T DedicatedVideoMemory +
+ + +

The number of bytes of dedicated system memory that are not shared with the CPU. This memory is allocated from available system memory at boot time.

+
+ + bb173058 + SIZE_T DedicatedSystemMemory + SIZE_T DedicatedSystemMemory +
+ + +

The number of bytes of shared system memory. This is the maximum value of system memory that may be consumed by the adapter during operation. Any incidental memory consumed by the driver as it manages and uses video memory is additional.

+
+ + bb173058 + SIZE_T SharedSystemMemory + SIZE_T SharedSystemMemory +
+ + +

A unique value that identifies the adapter. See for a definition of the structure. is defined in dxgi.h.

+
+ + bb173058 + LUID AdapterLuid + LUID AdapterLuid +
+ + +

Describes an adapter (or video card) using DXGI 1.1.

+
+ +

The structure provides a DXGI 1.1 description of an adapter. This structure is initialized by using the method.

+
+ + ff471326 + DXGI_ADAPTER_DESC1 + DXGI_ADAPTER_DESC1 +
+ + +

A string that contains the adapter description.

+
+ + ff471326 + wchar_t Description[128] + wchar_t Description +
+ + +

The PCI ID of the hardware vendor.

+
+ + ff471326 + unsigned int VendorId + unsigned int VendorId +
+ + +

The PCI ID of the hardware device.

+
+ + ff471326 + unsigned int DeviceId + unsigned int DeviceId +
+ + +

The PCI ID of the sub system.

+
+ + ff471326 + unsigned int SubSysId + unsigned int SubSysId +
+ + +

The PCI ID of the revision number of the adapter.

+
+ + ff471326 + unsigned int Revision + unsigned int Revision +
+ + +

The number of bytes of dedicated video memory that are not shared with the CPU.

+
+ + ff471326 + SIZE_T DedicatedVideoMemory + SIZE_T DedicatedVideoMemory +
+ + +

The number of bytes of dedicated system memory that are not shared with the CPU. This memory is allocated from available system memory at boot time.

+
+ + ff471326 + SIZE_T DedicatedSystemMemory + SIZE_T DedicatedSystemMemory +
+ + +

The number of bytes of shared system memory. This is the maximum value of system memory that may be consumed by the adapter during operation. Any incidental memory consumed by the driver as it manages and uses video memory is additional.

+
+ + ff471326 + SIZE_T SharedSystemMemory + SIZE_T SharedSystemMemory +
+ + +

A unique value that identifies the adapter. See for a definition of the structure. is defined in dxgi.h.

+
+ + ff471326 + LUID AdapterLuid + LUID AdapterLuid +
+ + +

A value of the enumerated type that describes the adapter type. The flag is reserved.

+
+ + ff471326 + DXGI_ADAPTER_FLAG Flags + DXGI_ADAPTER_FLAG Flags +
+ + +

Describes timing and presentation statistics for a frame.

+
+ +

You initialize the structure with the or method.

You can only use for swap chains that either use the flip presentation model or draw in full-screen mode. You set the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value in the SwapEffect member of the DXGI_SWAP_CHAIN_DESC1 structure to specify that the swap chain uses the flip presentation model.

The values in the PresentCount and PresentRefreshCount members indicate information about when a frame was presented on the display screen. You can use these values to determine whether a glitch occurred. The values in the SyncRefreshCount and SyncQPCTime members indicate timing information that you can use for audio and video synchronization or very precise animation. If the swap chain draws in full-screen mode, these values are based on when the computer booted. + If the swap chain draws in windowed mode, these values are based on when the swap chain is created.

+
+ + bb173060 + DXGI_FRAME_STATISTICS + DXGI_FRAME_STATISTICS +
+ + +

A value that represents the running total count of times that an image was presented to the monitor since the computer booted.

Note??The number of times that an image was presented to the monitor is not necessarily the same as the number of times that you called or IDXGISwapChain1::Present1.

+
+ + bb173060 + unsigned int PresentCount + unsigned int PresentCount +
+ + +

A value that represents the running total count of v-blanks at which the last image was presented to the monitor and that have happened since the computer booted (for windowed mode, since the swap chain was created).

+
+ + bb173060 + unsigned int PresentRefreshCount + unsigned int PresentRefreshCount +
+ + +

A value that represents the running total count of v-blanks when the scheduler last sampled the machine time by calling QueryPerformanceCounter and that have happened since the computer booted (for windowed mode, since the swap chain was created).

+
+ + bb173060 + unsigned int SyncRefreshCount + unsigned int SyncRefreshCount +
+ + +

A value that represents the high-resolution performance counter timer. This value is the same as the value returned by the QueryPerformanceCounter function.

+
+ + bb173060 + LARGE_INTEGER SyncQPCTime + LARGE_INTEGER SyncQPCTime +
+ + +

Reserved. Always returns 0.

+
+ + bb173060 + LARGE_INTEGER SyncGPUTime + LARGE_INTEGER SyncGPUTime +
+ + +

Controls the settings of a gamma curve.

+
+ +

The structure is used by the method.

+
+ + bb173061 + DXGI_GAMMA_CONTROL + DXGI_GAMMA_CONTROL +
+ + +

A structure with scalar values that are applied to rgb values before being sent to the gamma look up table.

+
+ + bb173061 + DXGI_RGB Scale + DXGI_RGB Scale +
+ + +

A structure with offset values that are applied to the rgb values before being sent to the gamma look up table.

+
+ + bb173061 + DXGI_RGB Offset + DXGI_RGB Offset +
+ + +

An array of structures that control the points of a gamma curve.

+
+ + bb173061 + DXGI_RGB GammaCurve[1025] + DXGI_RGB GammaCurve +
+ + +

Controls the gamma capabilities of an adapter.

+
+ +

To get a list of the capabilities for controlling gamma correction, call .

+
+ + bb173062 + DXGI_GAMMA_CONTROL_CAPABILITIES + DXGI_GAMMA_CONTROL_CAPABILITIES +
+ + +

True if scaling and offset operations are supported during gamma correction; otherwise, false.

+
+ + bb173062 + BOOL ScaleAndOffsetSupported + BOOL ScaleAndOffsetSupported +
+ + +

A value describing the maximum range of the control-point positions.

+
+ + bb173062 + float MaxConvertedValue + float MaxConvertedValue +
+ + +

A value describing the minimum range of the control-point positions.

+
+ + bb173062 + float MinConvertedValue + float MinConvertedValue +
+ + +

A value describing the number of control points in the array.

+
+ + bb173062 + unsigned int NumGammaControlPoints + unsigned int NumGammaControlPoints +
+ + +

An array of values describing control points; the maximum length of control points is 1025.

+
+ + bb173062 + float ControlPointPositions[1025] + float ControlPointPositions +
+ + +

Describes a mapped rectangle that is used to access a surface.

+
+ +

The structure is initialized by the method.

+
+ + bb173063 + DXGI_MAPPED_RECT + DXGI_MAPPED_RECT +
+ + +

A value that describes the width, in bytes, of the surface.

+
+ + bb173063 + int Pitch + int Pitch +
+ + +

A reference to the image buffer of the surface.

+
+ + bb173063 + unsigned char* pBits + unsigned char pBits +
+ + +

Describes a display mode.

+
+ +

The following format values are valid for display modes and when you create a bit-block transfer (bitblt) model swap chain. The valid values depend on the feature level that you are working with.

  • Feature level >= 9.1

    • (except 10.x on Windows?Vista)
    • (except 10.x on Windows?Vista)
  • Feature level >= 10.0

  • Feature level >= 11.0

You can pass one of these format values to to determine if it is a valid format for displaying on screen. If returns in the bit field to which the pFormatSupport parameter points, the format is valid for displaying on screen.

Starting with Windows Developer Preview for a flip model swap chain (that is, a swap chain that has the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value set in the SwapEffect member of ), you must set the Format member of to , , or .

Because of the relaxed render target creation rules that Direct3D 11 has for back buffers, applications can create a render target view from a swap chain so they can use automatic color space conversion when they render the swap chain.

+
+ + bb173064 + DXGI_MODE_DESC + DXGI_MODE_DESC +
+ + +

A value that describes the resolution width. If you specify the width as zero when you call the method to create a swap chain, the runtime obtains the width from the output window and assigns this width value to the swap-chain description. You can subsequently call the method to retrieve the assigned width value.

+
+ + bb173064 + unsigned int Width + unsigned int Width +
+ + +

A value describing the resolution height. If you specify the height as zero when you call the method to create a swap chain, the runtime obtains the height from the output window and assigns this height value to the swap-chain description. You can subsequently call the method to retrieve the assigned height value.

+
+ + bb173064 + unsigned int Height + unsigned int Height +
+ + +

A structure describing the refresh rate in hertz

+
+ + bb173064 + DXGI_RATIONAL RefreshRate + DXGI_RATIONAL RefreshRate +
+ + +

A structure describing the display format.

+
+ + bb173064 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

A member of the enumerated type describing the scanline drawing mode.

+
+ + bb173064 + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering +
+ + +

A member of the enumerated type describing the scaling mode.

+
+ + bb173064 + DXGI_MODE_SCALING Scaling + DXGI_MODE_SCALING Scaling +
+ + + Initializes a new instance of the structure. + + The width. + The height. + The refresh rate. + The format. + + + +

Describes an output or physical connection between the adapter (video card) and a device.

+
+ +

The structure is initialized by the method.

+
+ + bb173068 + DXGI_OUTPUT_DESC + DXGI_OUTPUT_DESC +
+ + +

A string that contains the name of the output device.

+
+ + bb173068 + wchar_t DeviceName[32] + wchar_t DeviceName +
+ + +

A structure containing the bounds of the output in desktop coordinates.

+
+ + bb173068 + RECT DesktopCoordinates + RECT DesktopCoordinates +
+ + +

True if the output is attached to the desktop; otherwise, false.

+
+ + bb173068 + BOOL AttachedToDesktop + BOOL AttachedToDesktop +
+ + +

A member of the enumerated type describing on how an image is rotated by the output.

+
+ + bb173068 + DXGI_MODE_ROTATION Rotation + DXGI_MODE_ROTATION Rotation +
+ + +

An handle that represents the display monitor. For more information, see and the Device Context.

+
+ + bb173068 + HMONITOR Monitor + HMONITOR Monitor +
+ + +

Represents a rational number.

+
+ +

The structure operates under the following rules:

  • 0/0 is legal and will be interpreted as 0/1.
  • 0/anything is interpreted as zero.
  • If you are representing a whole number, the denominator should be 1.
+
+ + bb173069 + DXGI_RATIONAL + DXGI_RATIONAL +
+ + +

An unsigned integer value representing the top of the rational number.

+
+ + bb173069 + unsigned int Numerator + unsigned int Numerator +
+ + +

An unsigned integer value representing the bottom of the rational number.

+
+ + bb173069 + unsigned int Denominator + unsigned int Denominator +
+ + + An empty rational that can be used for comparisons. + + + + + Initializes a new instance of the structure. + + The numerator of the rational pair. + The denominator of the rational pair. + + + +

Describes multi-sampling parameters for a resource.

+
+ +

The default sampler mode, with no anti-aliasing, has a count of 1 and a quality level of 0.

If multi-sample antialiasing is being used, all bound render targets and depth buffers must have the same sample counts and quality levels.

Differences between Direct3D 10.0 and Direct3D 10.1 and between Direct3D 10.0 and Direct3D 11:

Direct3D 10.1 has defined two standard quality levels: and in the enumeration in D3D10_1.h.

Direct3D 11 has defined two standard quality levels: and in the enumeration in D3D11.h.

?

+
+ + bb173072 + DXGI_SAMPLE_DESC + DXGI_SAMPLE_DESC +
+ + +

The number of multisamples per pixel.

+
+ + bb173072 + unsigned int Count + unsigned int Count +
+ + +

The image quality level. The higher the quality, the lower the performance. The valid range is between zero and one less than the level returned by for Direct3D 10 or for Direct3D 11.

For Direct3D 10.1 and Direct3D 11, you can use two special quality level values. For more information about these quality level values, see Remarks.

+
+ + bb173072 + unsigned int Quality + unsigned int Quality +
+ + + Initializes a new instance of the structure. + + The sample count. + The sample quality. + + + +

Represents a handle to a shared resource.

+
+ +

To create a shared surface, pass a shared-resource handle into the method.

+
+ + bb173073 + DXGI_SHARED_RESOURCE + DXGI_SHARED_RESOURCE +
+ + +

A handle to a shared resource.

+
+ + bb173073 + void* Handle + void Handle +
+ + +

Describes a surface.

+
+ + bb173074 + DXGI_SURFACE_DESC + DXGI_SURFACE_DESC +
+ + +

A value describing the surface width.

+
+ + bb173074 + unsigned int Width + unsigned int Width +
+ + +

A value describing the surface height.

+
+ + bb173074 + unsigned int Height + unsigned int Height +
+ + +

A member of the enumerated type that describes the surface format.

+
+ + bb173074 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

A member of the structure that describes multi-sampling parameters for the surface.

+
+ + bb173074 + DXGI_SAMPLE_DESC SampleDesc + DXGI_SAMPLE_DESC SampleDesc +
+ + +

Describes a swap chain.

+
+ +

In full-screen mode, there is a dedicated front buffer; in windowed mode, the desktop is the front buffer.

If you create a swap chain with one buffer, specifying does not cause the contents of the single buffer to be swapped with the front buffer.

For performance information about flipping swap-chain buffers in full-screen application, see Full-Screen Application Performance Hints.

+
+ + bb173075 + DXGI_SWAP_CHAIN_DESC + DXGI_SWAP_CHAIN_DESC +
+ + +

A structure that describes the backbuffer display mode.

+
+ + bb173075 + DXGI_MODE_DESC BufferDesc + DXGI_MODE_DESC BufferDesc +
+ + +

A structure that describes multi-sampling parameters.

+
+ + bb173075 + DXGI_SAMPLE_DESC SampleDesc + DXGI_SAMPLE_DESC SampleDesc +
+ + +

A member of the DXGI_USAGE enumerated type that describes the surface usage and CPU access options for the back buffer. The back buffer can be used for shader input or render-target output.

+
+ + bb173075 + DXGI_USAGE_ENUM BufferUsage + DXGI_USAGE_ENUM BufferUsage +
+ + +

A value that describes the number of buffers in the swap chain. When you call to create a full-screen swap chain, you typically include the front buffer in this value. For more information about swap-chain buffers, see Remarks.

+
+ + bb173075 + unsigned int BufferCount + unsigned int BufferCount +
+ + +

An handle to the output window. This member must not be null.

+
+ + bb173075 + HWND OutputWindow + HWND OutputWindow +
+ + +

A Boolean value that specifies whether the output is in windowed mode. TRUE if the output is in windowed mode; otherwise, .

We recommend that you create a windowed swap chain and allow the end user to change the swap chain to full screen through ; that is, do not set this member to to force the swap chain to be full screen. However, if you create the swap chain as full screen, also provide the end user with a list of supported display modes through the BufferDesc member because a swap chain that is created with an unsupported display mode might cause the display to go black and prevent the end user from seeing anything.

For more information about choosing windowed verses full screen, see .

+
+ + bb173075 + BOOL Windowed + BOOL Windowed +
+ + +

A member of the enumerated type that describes options for handling the contents of the presentation buffer after presenting a surface.

+
+ + bb173075 + DXGI_SWAP_EFFECT SwapEffect + DXGI_SWAP_EFFECT SwapEffect +
+ + +

A member of the enumerated type that describes options for swap-chain behavior.

+
+ + bb173075 + DXGI_SWAP_CHAIN_FLAG Flags + DXGI_SWAP_CHAIN_FLAG Flags +
+ + + Internal class used to initialize this assembly. + + + + + Initializes this assembly. + + + This method is called when the assembly is loaded. + + +
+
diff --git a/distribution/SharpDX.Direct3D11.Effects.dll b/distribution/SharpDX.Direct3D11.Effects.dll new file mode 100644 index 00000000..ce913ef0 Binary files /dev/null and b/distribution/SharpDX.Direct3D11.Effects.dll differ diff --git a/distribution/SharpDX.Direct3D11.Effects.xml b/distribution/SharpDX.Direct3D11.Effects.xml new file mode 100644 index 00000000..d13bdc58 --- /dev/null +++ b/distribution/SharpDX.Direct3D11.Effects.xml @@ -0,0 +1,5083 @@ + + + + SharpDX.Direct3D11.Effects + + + + + The assembly provides Effects11 managed API for Direct3D11. + + ff476080 + Direct3D11 + Direct3D11 + + + +

An interface manages a set of state objects, resources, and shaders for implementing a rendering effect.

+
+ +

An effect is created by calling .

The effect system groups the information required for rendering into an effect which contains: state objects for assigning state changes in groups, resources for supplying input data and storing output data, and programs that control how the rendering is done called shaders.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

Note??

If you call QueryInterface on an object to retrieve the interface, QueryInterface returns E_NOINTERFACE. To work around this issue, use the following code:

 * pIUnknown = (*)pEffect; pIUnknown->AddRef();	
+            
+
+ + ff476652 + ID3DX11Effect + ID3DX11Effect +
+ + + Initializes a new instance of the class. + + The device. + The effect byte code. + Effect compile options + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Test an effect to see if it contains valid syntax.

+
+

TRUE if the code syntax is valid; otherwise .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476844 + BOOL ID3DX11Effect::IsValid() + ID3DX11Effect::IsValid +
+ + +

Get the device that created the effect.

+
+

A reference to an .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

An effect is created for a specific device, by calling a function such as .

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476835 + HRESULT ID3DX11Effect::GetDevice([Out] ID3D11Device** ppDevice) + ID3DX11Effect::GetDevice +
+ + +

Get an effect description.

+
+

A reference to an effect description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

An effect description contains basic information about an effect such as the techniques it contains and the constant buffer resources it requires.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476834 + HRESULT ID3DX11Effect::GetDesc([Out] D3DX11_EFFECT_DESC* pDesc) + ID3DX11Effect::GetDesc +
+ + +

Get a constant buffer by index.

+
+

A zero-based index.

+

A reference to a .

+ +

An effect that contains a variable that will be read/written by an application requires at least one constant buffer. For best performance, an effect should organize variables into one or more constant buffers based on their frequency of update.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476832 + ID3DX11EffectConstantBuffer* ID3DX11Effect::GetConstantBufferByIndex([In] unsigned int Index) + ID3DX11Effect::GetConstantBufferByIndex +
+ + +

Get a constant buffer by name.

+
+

The constant-buffer name.

+

A reference to the constant buffer indicated by the Name. See .

+ +

An effect that contains a variable that will be read/written by an application requires at least one constant buffer. For best performance, an effect should organize variables into one or more constant buffers based on their frequency of update.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476833 + ID3DX11EffectConstantBuffer* ID3DX11Effect::GetConstantBufferByName([In] const char* Name) + ID3DX11Effect::GetConstantBufferByName +
+ + +

Get a variable by index.

+
+

A zero-based index.

+

A reference to a .

+ +

An effect may contain one or more variables. Variables outside of a technique are considered global to all effects, those located inside of a technique are local to that technique. You can access any local non-static effect variable using its name or with an index.

The method returns a reference to an effect-variable interface if a variable is not found; you can call to verify whether or not the index exists.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476840 + ID3DX11EffectVariable* ID3DX11Effect::GetVariableByIndex([In] unsigned int Index) + ID3DX11Effect::GetVariableByIndex +
+ + +

Get a variable by name.

+
+

The variable name.

+

A reference to an . Returns an invalid variable if the specified name cannot be found.

+ +

An effect may contain one or more variables. Variables outside of a technique are considered global to all effects, those located inside of a technique are local to that technique. You can access an effect variable using its name or with an index.

The method returns a reference to an effect-variable interface whether or not a variable is found. should be called to verify whether or not the name exists.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476841 + ID3DX11EffectVariable* ID3DX11Effect::GetVariableByName([In] const char* Name) + ID3DX11Effect::GetVariableByName +
+ + +

Get a variable by semantic.

+
+

The semantic name.

+

A reference to the effect variable indicated by the Semantic. See .

+ +

Each effect variable can have a semantic attached, which is a user defined metadata string. Some system-value semantics are reserved words that trigger built in functionality by pipeline stages.

The method returns a reference to an effect-variable interface if a variable is not found; you can call to verify whether or not the semantic exists.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476842 + ID3DX11EffectVariable* ID3DX11Effect::GetVariableBySemantic([In] const char* Semantic) + ID3DX11Effect::GetVariableBySemantic +
+ + +

Gets an effect group by index.

+
+

Index of the effect group.

+

A reference to an interface.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476836 + ID3DX11EffectGroup* ID3DX11Effect::GetGroupByIndex([In] unsigned int Index) + ID3DX11Effect::GetGroupByIndex +
+ + +

Gets an effect group by name.

+
+

Name of the effect group.

+

A reference to an interface.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476837 + ID3DX11EffectGroup* ID3DX11Effect::GetGroupByName([In] const char* Name) + ID3DX11Effect::GetGroupByName +
+ + +

Get a technique by index.

+
+

A zero-based index.

+

A reference to an .

+ +

An effect contains one or more techniques; each technique contains one or more passes. You can access a technique using its name or with an index.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476838 + ID3DX11EffectTechnique* ID3DX11Effect::GetTechniqueByIndex([In] unsigned int Index) + ID3DX11Effect::GetTechniqueByIndex +
+ + +

Get a technique by name.

+
+

The name of the technique.

+

A reference to an . If a technique with the appropriate name is not found an invalid technique is returned. should be called on the returned technique to determine whether it is valid.

+ +

An effect contains one or more techniques; each technique contains one or more passes. You can access a technique using its name or with an index.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476839 + ID3DX11EffectTechnique* ID3DX11Effect::GetTechniqueByName([In] const char* Name) + ID3DX11Effect::GetTechniqueByName +
+ + +

Gets a class linkage interface.

+
+

Returns a reference to an interface.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476831 + ID3D11ClassLinkage* ID3DX11Effect::GetClassLinkage() + ID3DX11Effect::GetClassLinkage +
+ + +

Creates a copy of an effect interface.

+
+

Flags affecting the creation of the cloned effect. Can be 0 or one of the following values.

FlagDescription
D3DX11_EFFECT_CLONE_FORCE_NONSINGLEIgnore all "single" qualifiers on cbuffers. All cbuffers will have their own s created in the cloned effect.

?

+

Pointer to an reference that will be set to the copy of the effect.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476830 + HRESULT ID3DX11Effect::CloneEffect([In] unsigned int Flags,[In] ID3DX11Effect** ppClonedEffect) + ID3DX11Effect::CloneEffect +
+ + +

Minimize the amount of memory required for an effect.

+
+

Returns one of the following Direct3D 11 Return Codes.

+ +

An effect uses memory space two different ways: to store the information required by the runtime to execute an effect, and to store the metadata required to reflect information back to an application using the API. You can minimize the amount of memory required by an effect by calling which removes the reflection metadata from memory. API methods to read variables will no longer work once reflection data has been removed.

The following methods will fail after Optimize has been called on an effect.

Note??References retrieved with these methods before calling are still valid after is called. This allows the application to get all the variables, techniques, and passes it will use, call Optimize, and then use the effect.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476845 + HRESULT ID3DX11Effect::Optimize() + ID3DX11Effect::Optimize +
+ + +

Test an effect to see if the reflection metadata has been removed from memory.

+
+

TRUE if the effect is optimized; otherwise .

+ +

An effect uses memory space two different ways: to store the information required by the runtime to execute an effect, and to store the metadata required to reflect information back to an application using the API. You can minimize the amount of memory required by an effect by calling which removes the reflection metadata from memory. Of course, API methods to read variables will no longer work once reflection data has been removed.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476843 + BOOL ID3DX11Effect::IsOptimized() + ID3DX11Effect::IsOptimized +
+ + +

Test an effect to see if it contains valid syntax.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476844 + IsValid + IsValid + BOOL ID3DX11Effect::IsValid() +
+ + +

Get the device that created the effect.

+
+ +

An effect is created for a specific device, by calling a function such as .

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476835 + GetDevice + GetDevice + HRESULT ID3DX11Effect::GetDevice([Out] ID3D11Device** ppDevice) +
+ + +

Get an effect description.

+
+ +

An effect description contains basic information about an effect such as the techniques it contains and the constant buffer resources it requires.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476834 + GetDesc + GetDesc + HRESULT ID3DX11Effect::GetDesc([Out] D3DX11_EFFECT_DESC* pDesc) +
+ + +

Gets a class linkage interface.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476831 + GetClassLinkage + GetClassLinkage + ID3D11ClassLinkage* ID3DX11Effect::GetClassLinkage() +
+ + +

Test an effect to see if the reflection metadata has been removed from memory.

+
+ +

An effect uses memory space two different ways: to store the information required by the runtime to execute an effect, and to store the metadata required to reflect information back to an application using the API. You can minimize the amount of memory required by an effect by calling which removes the reflection metadata from memory. Of course, API methods to read variables will no longer work once reflection data has been removed.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476843 + IsOptimized + IsOptimized + BOOL ID3DX11Effect::IsOptimized() +
+ + +

The blend-variable interface accesses blend state.

+
+ +

An interface is created when an effect is read into memory.

Effect variables are saved in memory in the backing store; when a technique is applied, the values in the backing store are copied to the device. You can use either of these methods to return state.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476653 + ID3DX11EffectBlendVariable + ID3DX11EffectBlendVariable +
+ + +

The interface is the base class for all effect variables.

The lifetime of an object is equal to the lifetime of its parent object.

  • Methods
Methods

The interface has the following methods.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476788 + ID3DX11EffectVariable + ID3DX11EffectVariable +
+ + + Set data. + + A reference to the variable. + size in bytes of data to write. + + Returns one of the following {{Direct3D 10 Return Codes}}. + + + This method does no conversion or type checking; it is therefore a very quick way to access array items. + + HRESULT ID3D11EffectVariable::SetRawValue([None] void* pData,[None] int Offset,[None] int Count) + + + + Get data. + + + This method does no conversion or type checking; it is therefore a very quick way to access array items. + + The number of bytes to get. + Returns a filled with the value. + HRESULT ID3D11EffectVariable::GetRawValue([None] void* pData,[None] int Offset,[None] int Count) + + + + Get a scalar variable. + + + AsScalar returns a version of the effect variable that has been specialized to a scalar variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain scalar data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a scalar variable. See . + ID3D11EffectScalarVariable* ID3D11EffectVariable::AsScalar() + + + + Get a vector variable. + + + AsVector returns a version of the effect variable that has been specialized to a vector variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain vector data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a vector variable. See . + ID3D11EffectVectorVariable* ID3D11EffectVariable::AsVector() + + + + Get a matrix variable. + + + AsMatrix returns a version of the effect variable that has been specialized to a matrix variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain matrix data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a matrix variable. See . + ID3D11EffectMatrixVariable* ID3D11EffectVariable::AsMatrix() + + + + Get a string variable. + + + AsString returns a version of the effect variable that has been specialized to a string variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain string data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a string variable. See . + ID3D11EffectStringVariable* ID3D11EffectVariable::AsString() + + + + Get a shader-resource variable. + + + AsShaderResource returns a version of the effect variable that has been specialized to a shader-resource variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain shader-resource data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a shader-resource variable. See . + ID3D11EffectShaderResourceVariable* ID3D11EffectVariable::AsShaderResource() + + + + Get a render-target-view variable. + + + This method returns a version of the effect variable that has been specialized to a render-target-view variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain render-target-view data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a render-target-view variable. See . + ID3D11EffectRenderTargetViewVariable* ID3D11EffectVariable::AsRenderTargetView() + + + + Get a depth-stencil-view variable. + + + This method returns a version of the effect variable that has been specialized to a depth-stencil-view variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain depth-stencil-view data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a depth-stencil-view variable. See . + ID3D11EffectDepthStencilViewVariable* ID3D11EffectVariable::AsDepthStencilView() + + + + Get a class instance variable. + + A reference to a . + ID3D11EffectClassInstanceVariable* ID3D11EffectVariable::AsClassInstance() + + + + Get an interface variable. + + A reference to a . + ID3D11EffectClassInstanceVariable* ID3D11EffectVariable::AsInterface() + + + + Get an unordered access view variable. + + A reference to a . + ID3D11EffectUnorderedAccessViewVariable* ID3D11EffectVariable::AsDepthStencilView() + + + + Get a constant buffer. + + + AsConstantBuffer returns a version of the effect variable that has been specialized to a constant buffer. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain constant buffer data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a constant buffer. See . + ID3D11EffectConstantBuffer* ID3D11EffectVariable::AsConstantBuffer() + + + + Get a shader variable. + + + AsShader returns a version of the effect variable that has been specialized to a shader variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain shader data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a shader variable. See . + ID3D11EffectShaderVariable* ID3D11EffectVariable::AsShader() + + + + Get a effect-blend variable. + + + AsBlend returns a version of the effect variable that has been specialized to an effect-blend variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain effect-blend data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to an effect blend variable. See . + ID3D11EffectBlendVariable* ID3D11EffectVariable::AsBlend() + + + + Get a depth-stencil variable. + + + AsDepthStencil returns a version of the effect variable that has been specialized to a depth-stencil variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain depth-stencil data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a depth-stencil variable. See . + ID3D11EffectDepthStencilVariable* ID3D11EffectVariable::AsDepthStencil() + + + + Get a rasterizer variable. + + + AsRasterizer returns a version of the effect variable that has been specialized to a rasterizer variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain rasterizer data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a rasterizer variable. See . + ID3D11EffectRasterizerVariable* ID3D11EffectVariable::AsRasterizer() + + + + Get a sampler variable. + + + AsSampler returns a version of the effect variable that has been specialized to a sampler variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain sampler data. Applications can test the returned object for validity by calling {{IsValid}}. + + A reference to a sampler variable. See . + ID3D11EffectSamplerVariable* ID3D11EffectVariable::AsSampler() + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Compare the data type with the data stored.

+
+

TRUE if the syntax is valid; otherwise .

+ +

This method checks that the data type matches the data stored after casting one interface to another (using any of the As methods).

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476815 + BOOL ID3DX11EffectVariable::IsValid() + ID3DX11EffectVariable::IsValid +
+ + +

Get type information.

+
+

A reference to an .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476814 + ID3DX11EffectType* ID3DX11EffectVariable::GetType() + ID3DX11EffectVariable::GetType +
+ + +

Get a description.

+
+

A reference to an effect-variable description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476807 + HRESULT ID3DX11EffectVariable::GetDesc([Out] D3DX11_EFFECT_VARIABLE_DESC* pDesc) + ID3DX11EffectVariable::GetDesc +
+ + +

Get an annotation by index.

+
+

A zero-based index.

+

A reference to an .

+ +

Annonations can be attached to a technique, a pass, or a global variable.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476805 + ID3DX11EffectVariable* ID3DX11EffectVariable::GetAnnotationByIndex([In] unsigned int Index) + ID3DX11EffectVariable::GetAnnotationByIndex +
+ + +

Get an annotation by name.

+
+

The annotation name.

+

A reference to an . Note that if the annotation is not found the returned will be empty. The method should be called to determine whether the annotation was found.

+ +

Annonations can be attached to a technique, a pass, or a global variable.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476806 + ID3DX11EffectVariable* ID3DX11EffectVariable::GetAnnotationByName([In] const char* Name) + ID3DX11EffectVariable::GetAnnotationByName +
+ + +

Get a structure member by index.

+
+

A zero-based index.

+

A reference to an .

+ +

If the effect variable is an structure, use this method to look up a member by index.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476809 + ID3DX11EffectVariable* ID3DX11EffectVariable::GetMemberByIndex([In] unsigned int Index) + ID3DX11EffectVariable::GetMemberByIndex +
+ + +

Get a structure member by name.

+
+

Member name.

+

A reference to an .

+ +

If the effect variable is an structure, use this method to look up a member by name.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476810 + ID3DX11EffectVariable* ID3DX11EffectVariable::GetMemberByName([In] const char* Name) + ID3DX11EffectVariable::GetMemberByName +
+ + +

Get a structure member by semantic.

+
+

The semantic.

+

A reference to an .

+ +

If the effect variable is an structure, use this method to look up a member by attached semantic.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476811 + ID3DX11EffectVariable* ID3DX11EffectVariable::GetMemberBySemantic([In] const char* Semantic) + ID3DX11EffectVariable::GetMemberBySemantic +
+ + +

Get an array element.

+
+

A zero-based index; otherwise 0.

+

A reference to an .

+ +

If the effect variable is an array, use this method to return one of the elements.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476808 + ID3DX11EffectVariable* ID3DX11EffectVariable::GetElement([In] unsigned int Index) + ID3DX11EffectVariable::GetElement +
+ + +

Get a constant buffer.

+
+

A reference to a .

+ +

Effect variables are read-from or written-to a constant buffer.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476812 + ID3DX11EffectConstantBuffer* ID3DX11EffectVariable::GetParentConstantBuffer() + ID3DX11EffectVariable::GetParentConstantBuffer +
+ + +

Get a scalar variable.

+
+

A reference to a scalar variable. See .

+ +

AsScalar returns a version of the effect variable that has been specialized to a scalar variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain scalar data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476799 + ID3DX11EffectScalarVariable* ID3DX11EffectVariable::AsScalar() + ID3DX11EffectVariable::AsScalar +
+ + +

Get a vector variable.

+
+

A reference to a vector variable. See .

+ +

AsVector returns a version of the effect variable that has been specialized to a vector variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain vector data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476804 + ID3DX11EffectVectorVariable* ID3DX11EffectVariable::AsVector() + ID3DX11EffectVariable::AsVector +
+ + +

Get a matrix variable.

+
+

A reference to a matrix variable. See .

+ +

AsMatrix returns a version of the effect variable that has been specialized to a matrix variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain matrix data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476795 + ID3DX11EffectMatrixVariable* ID3DX11EffectVariable::AsMatrix() + ID3DX11EffectVariable::AsMatrix +
+ + +

Get a string variable.

+
+

A reference to a string variable. See .

+ +

AsString returns a version of the effect variable that has been specialized to a string variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain string data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476802 + ID3DX11EffectStringVariable* ID3DX11EffectVariable::AsString() + ID3DX11EffectVariable::AsString +
+ + +

Get a class-instance variable.

+
+

A reference to class-instance variable. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476790 + ID3DX11EffectClassInstanceVariable* ID3DX11EffectVariable::AsClassInstance() + ID3DX11EffectVariable::AsClassInstance +
+ + +

Get an interface variable.

+
+

A reference to an interface variable. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476794 + ID3DX11EffectInterfaceVariable* ID3DX11EffectVariable::AsInterface() + ID3DX11EffectVariable::AsInterface +
+ + +

Get a shader-resource variable.

+
+

A reference to a shader-resource variable. See .

+ +

AsShaderResource returns a version of the effect variable that has been specialized to a shader-resource variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain shader-resource data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476801 + ID3DX11EffectShaderResourceVariable* ID3DX11EffectVariable::AsShaderResource() + ID3DX11EffectVariable::AsShaderResource +
+ + +

Get an unordered-access-view variable.

+
+

A reference to an unordered-access-view variable. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476803 + ID3DX11EffectUnorderedAccessViewVariable* ID3DX11EffectVariable::AsUnorderedAccessView() + ID3DX11EffectVariable::AsUnorderedAccessView +
+ + +

Get a render-target-view variable.

+
+

A reference to a render-target-view variable. See .

+ +

This method returns a version of the effect variable that has been specialized to a render-target-view variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain render-target-view data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476797 + ID3DX11EffectRenderTargetViewVariable* ID3DX11EffectVariable::AsRenderTargetView() + ID3DX11EffectVariable::AsRenderTargetView +
+ + +

Get a depth-stencil-view variable.

+
+

A reference to a depth-stencil-view variable. See .

+ +

This method returns a version of the effect variable that has been specialized to a depth-stencil-view variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain depth-stencil-view data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476793 + ID3DX11EffectDepthStencilViewVariable* ID3DX11EffectVariable::AsDepthStencilView() + ID3DX11EffectVariable::AsDepthStencilView +
+ + +

Get a constant buffer.

+
+

A reference to a constant buffer. See .

+ +

AsConstantBuffer returns a version of the effect variable that has been specialized to a constant buffer. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain constant buffer data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476791 + ID3DX11EffectConstantBuffer* ID3DX11EffectVariable::AsConstantBuffer() + ID3DX11EffectVariable::AsConstantBuffer +
+ + +

Get a shader variable.

+
+

A reference to a shader variable. See .

+ +

AsShader returns a version of the effect variable that has been specialized to a shader variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain shader data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476800 + ID3DX11EffectShaderVariable* ID3DX11EffectVariable::AsShader() + ID3DX11EffectVariable::AsShader +
+ + +

Get a effect-blend variable.

+
+

A reference to an effect blend variable. See .

+ +

AsBlend returns a version of the effect variable that has been specialized to an effect-blend variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain effect-blend data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476789 + ID3DX11EffectBlendVariable* ID3DX11EffectVariable::AsBlend() + ID3DX11EffectVariable::AsBlend +
+ + +

Get a depth-stencil variable.

+
+

A reference to a depth-stencil variable. See .

+ +

AsDepthStencil returns a version of the effect variable that has been specialized to a depth-stencil variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain depth-stencil data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476792 + ID3DX11EffectDepthStencilVariable* ID3DX11EffectVariable::AsDepthStencil() + ID3DX11EffectVariable::AsDepthStencil +
+ + +

Get a rasterizer variable.

+
+

A reference to a rasterizer variable. See .

+ +

AsRasterizer returns a version of the effect variable that has been specialized to a rasterizer variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain rasterizer data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476796 + ID3DX11EffectRasterizerVariable* ID3DX11EffectVariable::AsRasterizer() + ID3DX11EffectVariable::AsRasterizer +
+ + +

Get a sampler variable.

+
+

A reference to a sampler variable. See .

+ +

AsSampler returns a version of the effect variable that has been specialized to a sampler variable. Similar to a cast, this specialization will return an invalid object if the effect variable does not contain sampler data.

Applications can test the returned object for validity by calling IsValid.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476798 + ID3DX11EffectSamplerVariable* ID3DX11EffectVariable::AsSampler() + ID3DX11EffectVariable::AsSampler +
+ + +

Set data.

+
+

A reference to the variable.

+

The offset (in bytes) from the beginning of the reference to the data.

+

The number of bytes to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method does no conversion or type checking; it is therefore a very quick way to access array items.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476816 + HRESULT ID3DX11EffectVariable::SetRawValue([In] const void* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVariable::SetRawValue +
+ + +

Get data.

+
+

A reference to the variable.

+

The offset (in bytes) from the beginning of the reference to the data.

+

The number of bytes to get.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

This method does no conversion or type checking; it is therefore a very quick way to access array items.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476813 + HRESULT ID3DX11EffectVariable::GetRawValue([In] void* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVariable::GetRawValue +
+ + +

Compare the data type with the data stored.

+
+ +

This method checks that the data type matches the data stored after casting one interface to another (using any of the As methods).

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476815 + IsValid + IsValid + BOOL ID3DX11EffectVariable::IsValid() +
+ + +

Get type information.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476814 + GetType + GetType + ID3DX11EffectType* ID3DX11EffectVariable::GetType() +
+ + +

Get a description.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476807 + GetDesc + GetDesc + HRESULT ID3DX11EffectVariable::GetDesc([Out] D3DX11_EFFECT_VARIABLE_DESC* pDesc) +
+ + +

Get a constant buffer.

+
+ +

Effect variables are read-from or written-to a constant buffer.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476812 + GetParentConstantBuffer + GetParentConstantBuffer + ID3DX11EffectConstantBuffer* ID3DX11EffectVariable::GetParentConstantBuffer() +
+ + + Get a pointer to a blend-state interface. + + Returns . + HRESULT ID3D10EffectBlendVariable::GetBlendState([None] int Index,[Out] ID3D10BlendState** ppBlendState) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a reference to a blend-state interface.

+
+

Index into an array of blend-state interfaces. If there is only one blend-state interface, use 0.

+

The address of a reference to a blend-state interface (see ).

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476655 + HRESULT ID3DX11EffectBlendVariable::GetBlendState([In] unsigned int Index,[Out] ID3D11BlendState** ppBlendState) + ID3DX11EffectBlendVariable::GetBlendState +
+ + +

Sets an effect's blend-state.

+
+

Index into an array of blend-state interfaces. If there is only one blend-state interface, use 0.

+

A reference to an interface containing the blend-state to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476656 + HRESULT ID3DX11EffectBlendVariable::SetBlendState([In] unsigned int Index,[In] ID3D11BlendState* pBlendState) + ID3DX11EffectBlendVariable::SetBlendState +
+ + +

Reverts a previously set blend-state.

+
+

Index into an array of blend-state interfaces. If there is only one blend-state interface, use 0.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476657 + HRESULT ID3DX11EffectBlendVariable::UndoSetBlendState([In] unsigned int Index) + ID3DX11EffectBlendVariable::UndoSetBlendState +
+ + +

Get a reference to a blend-state variable.

+
+

Index into an array of blend-state descriptions. If there is only one blend-state variable in the effect, use 0.

+

A reference to a blend-state description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Effect variables are saved in memory in the backing store; when a technique is applied, the values in the backing store are copied to the device. Backing store data can used to recreate the variable when necessary.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476654 + HRESULT ID3DX11EffectBlendVariable::GetBackingStore([In] unsigned int Index,[Out] D3D11_BLEND_DESC* pBlendDesc) + ID3DX11EffectBlendVariable::GetBackingStore +
+ + +

A depth-stencil-variable interface accesses depth-stencil state.

+
+ +

An interface is created when an effect is read into memory.

Effect variables are saved in memory in the backing store; when a technique is applied, the values in the backing store are copied to the device. You can use either of these methods to return state.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476677 + ID3DX11EffectDepthStencilVariable + ID3DX11EffectDepthStencilVariable +
+ + + Get a pointer to a depth-stencil interface. + + Returns a pointer to a blend-state interface (see ). + HRESULT ID3D10EffectDepthStencilVariable::GetDepthStencilState([None] int Index,[Out] ID3D10DepthStencilState** ppDepthStencilState) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a reference to a depth-stencil interface.

+
+

Index into an array of depth-stencil interfaces. If there is only one depth-stencil interface, use 0.

+

The address of a reference to a blend-state interface (see ).

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476679 + HRESULT ID3DX11EffectDepthStencilVariable::GetDepthStencilState([In] unsigned int Index,[Out] ID3D11DepthStencilState** ppDepthStencilState) + ID3DX11EffectDepthStencilVariable::GetDepthStencilState +
+ + +

Sets the depth stencil state.

+
+

Index into an array of depth-stencil interfaces. If there is only one depth-stencil interface, use 0.

+

Pointer to an interface containing the new depth stencil state.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476680 + HRESULT ID3DX11EffectDepthStencilVariable::SetDepthStencilState([In] unsigned int Index,[In] ID3D11DepthStencilState* pDepthStencilState) + ID3DX11EffectDepthStencilVariable::SetDepthStencilState +
+ + +

Reverts a previously set depth stencil state.

+
+

Index into an array of depth-stencil interfaces. If there is only one depth-stencil interface, use 0.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476681 + HRESULT ID3DX11EffectDepthStencilVariable::UndoSetDepthStencilState([In] unsigned int Index) + ID3DX11EffectDepthStencilVariable::UndoSetDepthStencilState +
+ + +

Get a reference to a variable that contains depth-stencil state.

+
+

Index into an array of depth-stencil-state descriptions. If there is only one depth-stencil variable in the effect, use 0.

+

A reference to a depth-stencil-state description (see ).

+ +

Effect variables are saved in memory in the backing store; when a technique is applied, the values in the backing store are copied to the device. Backing store data can used to recreate the variable when necessary.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476678 + HRESULT ID3DX11EffectDepthStencilVariable::GetBackingStore([In] unsigned int Index,[Out] D3D11_DEPTH_STENCIL_DESC* pDepthStencilDesc) + ID3DX11EffectDepthStencilVariable::GetBackingStore +
+ + +

A depth-stencil-view-variable interface accesses a depth-stencil view.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476682 + ID3DX11EffectDepthStencilViewVariable + ID3DX11EffectDepthStencilViewVariable +
+ + + Set an array of depth-stencil-view resources. + + A pointer to an array of depth-stencil-view interfaces. See . + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectDepthStencilViewVariable::SetDepthStencilArray([In, Buffer] ID3D10DepthStencilView** ppResources,[None] int Offset,[None] int Count) + + + + Set an array of depth-stencil-view resources. + + A pointer to an array of depth-stencil-view interfaces. See . + The zero-based array index to set the first interface. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectDepthStencilViewVariable::SetDepthStencilArray([In, Buffer] ID3D10DepthStencilView** ppResources,[None] int Offset,[None] int Count) + + + + Get an array of depth-stencil-view resources. + + The number of elements in the array. + Returns an array of depth-stencil-view interfaces. See . + HRESULT ID3D10EffectDepthStencilViewVariable::GetDepthStencilArray([Out, Buffer] ID3D10DepthStencilView** ppResources,[None] int Offset,[None] int Count) + + + + Get an array of depth-stencil-view resources. + + The zero-based array index to get the first interface. + The number of elements in the array. + Returns an array of depth-stencil-view interfaces. See . + HRESULT ID3D10EffectDepthStencilViewVariable::GetDepthStencilArray([Out, Buffer] ID3D10DepthStencilView** ppResources,[None] int Offset,[None] int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a depth-stencil-view resource.

+
+

A reference to a depth-stencil-view interface. See .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476685 + HRESULT ID3DX11EffectDepthStencilViewVariable::SetDepthStencil([In] ID3D11DepthStencilView* pResource) + ID3DX11EffectDepthStencilViewVariable::SetDepthStencil +
+ + +

Get a depth-stencil-view resource.

+
+

The address of a reference to a depth-stencil-view interface. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476683 + HRESULT ID3DX11EffectDepthStencilViewVariable::GetDepthStencil([In] ID3D11DepthStencilView** ppResource) + ID3DX11EffectDepthStencilViewVariable::GetDepthStencil +
+ + +

Set an array of depth-stencil-view resources.

+
+

A reference to an array of depth-stencil-view interfaces. See .

+

The zero-based array index to set the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476686 + HRESULT ID3DX11EffectDepthStencilViewVariable::SetDepthStencilArray([In, Buffer] ID3D11DepthStencilView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectDepthStencilViewVariable::SetDepthStencilArray +
+ + +

Set an array of depth-stencil-view resources.

+
+

A reference to an array of depth-stencil-view interfaces. See .

+

The zero-based array index to set the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476686 + HRESULT ID3DX11EffectDepthStencilViewVariable::SetDepthStencilArray([In, Buffer] ID3D11DepthStencilView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectDepthStencilViewVariable::SetDepthStencilArray +
+ + +

Get an array of depth-stencil-view resources.

+
+

A reference to an array of depth-stencil-view interfaces. See .

+

The zero-based array index to get the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476684 + HRESULT ID3DX11EffectDepthStencilViewVariable::GetDepthStencilArray([Out, Buffer] ID3D11DepthStencilView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectDepthStencilViewVariable::GetDepthStencilArray +
+ + +

A matrix-variable interface accesses a matrix.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476697 + ID3DX11EffectMatrixVariable + ID3DX11EffectMatrixVariable +
+ + + Set a floating-point matrix. + + A pointer to the first element in the matrix. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrix([In] float* pData) + + + + Get a matrix. + + A reference to the first element in a matrix. + + Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11. + + HRESULT ID3DX11EffectMatrixVariable::GetMatrix([Out] SHARPDX_MATRIX* pData) + + + + Get a matrix. + + A reference to the first element in a matrix. + + Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11. + + HRESULT ID3DX11EffectMatrixVariable::GetMatrix([Out] SHARPDX_MATRIX* pData) + + + + Set a floating-point matrix. + + A pointer to the first element in the matrix. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrix([In] float* pData) + + + + Set an array of floating-point matrices. + + A pointer to the first matrix. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrixArray([In, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Set an array of floating-point matrices. + + A pointer to the first matrix. + The number of matrix elements to skip from the start of the array. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrixArray([In, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Get an array of matrices. + + The number of matrices in the returned array. + Returns an array of matrix. + HRESULT ID3D11EffectMatrixVariable::GetMatrixArray([Out, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Get an array of matrices. + + The offset (in number of matrices) between the start of the array and the first matrix returned. + The number of matrices in the returned array. + Returns an array of matrix. + HRESULT ID3D11EffectMatrixVariable::GetMatrixArray([Out, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Transpose and set a floating-point matrix. + + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa). + + A pointer to the first element of a matrix. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrixTranspose([In] float* pData) + + + + Transpose and set a floating-point matrix. + + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa). + + A pointer to the first element of a matrix. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrixTranspose([In] float* pData) + + + + Transpose and set an array of floating-point matrices. + + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa). + + A pointer to an array of matrices. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrixTransposeArray([In] float* pData,[None] int Offset,[None] int Count) + + + + Transpose and set an array of floating-point matrices. + + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa). + + A pointer to an array of matrices. + The offset (in number of matrices) between the start of the array and the first matrix to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectMatrixVariable::SetMatrixTransposeArray([In] float* pData,[None] int Offset,[None] int Count) + + + + Transpose and get a floating-point matrix. + + The transposed matrix. + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa).Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11. + + HRESULT ID3DX11EffectMatrixVariable::GetMatrixTranspose([Out] SHARPDX_MATRIX* pData) + + + + Transpose and get a floating-point matrix. + + The transposed matrix. + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa).Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11. + + HRESULT ID3DX11EffectMatrixVariable::GetMatrixTranspose([Out] SHARPDX_MATRIX* pData) + + + + Transpose and get an array of floating-point matrices. + + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa). + + The number of matrices in the array to get. + Returns an array of transposed . + HRESULT ID3D11EffectMatrixVariable::GetMatrixTransposeArray([Out, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Transpose and get an array of floating-point matrices. + + + Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa). + + The offset (in number of matrices) between the start of the array and the first matrix to get. + The number of matrices in the array to get. + Returns an array of transposed . + HRESULT ID3D11EffectMatrixVariable::GetMatrixTransposeArray([Out, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a floating-point matrix.

+
+

A reference to the first element in the matrix.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476702 + HRESULT ID3DX11EffectMatrixVariable::SetMatrix([In] const SHARPDX_MATRIX* pData) + ID3DX11EffectMatrixVariable::SetMatrix +
+ + +

Get a matrix.

+
+

A reference to the first element in a matrix.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476698 + HRESULT ID3DX11EffectMatrixVariable::GetMatrix([Out] SHARPDX_MATRIX* pData) + ID3DX11EffectMatrixVariable::GetMatrix +
+ + +

Set an array of floating-point matrices.

+
+

A reference to the first matrix.

+

The number of matrix elements to skip from the start of the array.

+

The number of elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476703 + HRESULT ID3DX11EffectMatrixVariable::SetMatrixArray([In, Buffer] const SHARPDX_MATRIX* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectMatrixVariable::SetMatrixArray +
+ + +

Get an array of matrices.

+
+

A reference to the first element of the first matrix in an array of matrices.

+

The offset (in number of matrices) between the start of the array and the first matrix returned.

+

The number of matrices in the returned array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476699 + HRESULT ID3DX11EffectMatrixVariable::GetMatrixArray([Out, Buffer] SHARPDX_MATRIX* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectMatrixVariable::GetMatrixArray +
+ + +

Transpose and set a floating-point matrix.

+
+

A reference to the first element of a matrix.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa).

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476704 + HRESULT ID3DX11EffectMatrixVariable::SetMatrixTranspose([In] const SHARPDX_MATRIX* pData) + ID3DX11EffectMatrixVariable::SetMatrixTranspose +
+ + +

Transpose and get a floating-point matrix.

+
+

A reference to the first element of a transposed matrix.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa).

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476700 + HRESULT ID3DX11EffectMatrixVariable::GetMatrixTranspose([Out] SHARPDX_MATRIX* pData) + ID3DX11EffectMatrixVariable::GetMatrixTranspose +
+ + +

Transpose and set an array of floating-point matrices.

+
+

A reference to an array of matrices.

+

The offset (in number of matrices) between the start of the array and the first matrix to set.

+

The number of matrices in the array to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa).

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476705 + HRESULT ID3DX11EffectMatrixVariable::SetMatrixTransposeArray([In, Buffer] const SHARPDX_MATRIX* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectMatrixVariable::SetMatrixTransposeArray +
+ + +

Transpose and get an array of floating-point matrices.

+
+

A reference to the first element of an array of tranposed matrices.

+

The offset (in number of matrices) between the start of the array and the first matrix to get.

+

The number of matrices in the array to get.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Transposing a matrix will rearrange the data order from row-column order to column-row order (or vice versa).

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476701 + HRESULT ID3DX11EffectMatrixVariable::GetMatrixTransposeArray([Out, Buffer] SHARPDX_MATRIX* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectMatrixVariable::GetMatrixTransposeArray +
+ + +

An interface encapsulates state assignments within a technique.

The lifetime of an object is equal to the lifetime of its parent object.

  • Methods
Methods

The interface has the following methods.

+
+ +

A pass is a block of code that sets render-state objects and shaders. A pass is declared within a technique.

To get an effect-pass interface, call a method like .

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476706 + ID3DX11EffectPass + ID3DX11EffectPass +
+ + + Set the state contained in a pass to the device. + + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT Apply([None] UINT Flags) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Test a pass to see if it contains valid syntax.

+
+

TRUE if the code syntax is valid; otherwise .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476718 + BOOL ID3DX11EffectPass::IsValid() + ID3DX11EffectPass::IsValid +
+ + +

Get a pass description.

+
+

A reference to a pass description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

A pass is a block of code that sets render state and shaders (which in turn sets constant buffers, samplers and textures). An effect technique contains one or more passes.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476712 + HRESULT ID3DX11EffectPass::GetDesc([Out] D3DX11_PASS_DESC* pDesc) + ID3DX11EffectPass::GetDesc +
+ + +

Get a vertex-shader description.

+
+

A reference to a vertex-shader description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

An effect pass can contain render state assignments and shader object assignments.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476717 + HRESULT ID3DX11EffectPass::GetVertexShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) + ID3DX11EffectPass::GetVertexShaderDesc +
+ + +

Get a geometry-shader description.

+
+

A reference to a geometry-shader description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

An effect pass can contain render state assignments and shader object assignments.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476714 + HRESULT ID3DX11EffectPass::GetGeometryShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) + ID3DX11EffectPass::GetGeometryShaderDesc +
+ + +

Get a pixel-shader description.

+
+

A reference to a pixel-shader description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

An effect pass can contain render state assignments and shader object assignments.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476716 + HRESULT ID3DX11EffectPass::GetPixelShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) + ID3DX11EffectPass::GetPixelShaderDesc +
+ + +

Get hull-shader description.

+
+

A reference to a hull-shader description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476715 + HRESULT ID3DX11EffectPass::GetHullShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) + ID3DX11EffectPass::GetHullShaderDesc +
+ + +

Get a domain-shader description.

+
+

A reference to a domain-shader description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476713 + HRESULT ID3DX11EffectPass::GetDomainShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) + ID3DX11EffectPass::GetDomainShaderDesc +
+ + +

Get a compute-shader description.

+
+

A reference to a compute-shader description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476711 + HRESULT ID3DX11EffectPass::GetComputeShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) + ID3DX11EffectPass::GetComputeShaderDesc +
+ + +

Get an annotation by index.

+
+

A zero-based index.

+

A reference to an .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476709 + ID3DX11EffectVariable* ID3DX11EffectPass::GetAnnotationByIndex([In] unsigned int Index) + ID3DX11EffectPass::GetAnnotationByIndex +
+ + +

Get an annotation by name.

+
+

The name of the annotation.

+

A reference to an .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476710 + ID3DX11EffectVariable* ID3DX11EffectPass::GetAnnotationByName([In] const char* Name) + ID3DX11EffectPass::GetAnnotationByName +
+ + +

Set the state contained in a pass to the device.

+
+

Unused.

+

The to apply the pass to.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476707 + HRESULT ID3DX11EffectPass::Apply([In] unsigned int Flags,[In] ID3D11DeviceContext* pContext) + ID3DX11EffectPass::Apply +
+ + +

Generate a mask for allowing/preventing state changes.

+
+

A reference to a state-block mask (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476708 + HRESULT ID3DX11EffectPass::ComputeStateBlockMask([In] D3DX11_STATE_BLOCK_MASK* pStateBlockMask) + ID3DX11EffectPass::ComputeStateBlockMask +
+ + +

Test a pass to see if it contains valid syntax.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476718 + IsValid + IsValid + BOOL ID3DX11EffectPass::IsValid() +
+ + +

Get a pass description.

+
+ +

A pass is a block of code that sets render state and shaders (which in turn sets constant buffers, samplers and textures). An effect technique contains one or more passes.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476712 + GetDesc + GetDesc + HRESULT ID3DX11EffectPass::GetDesc([Out] D3DX11_PASS_DESC* pDesc) +
+ + +

Get a vertex-shader description.

+
+ +

An effect pass can contain render state assignments and shader object assignments.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476717 + GetVertexShaderDesc + GetVertexShaderDesc + HRESULT ID3DX11EffectPass::GetVertexShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) +
+ + +

Get a geometry-shader description.

+
+ +

An effect pass can contain render state assignments and shader object assignments.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476714 + GetGeometryShaderDesc + GetGeometryShaderDesc + HRESULT ID3DX11EffectPass::GetGeometryShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) +
+ + +

Get a pixel-shader description.

+
+ +

An effect pass can contain render state assignments and shader object assignments.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476716 + GetPixelShaderDesc + GetPixelShaderDesc + HRESULT ID3DX11EffectPass::GetPixelShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) +
+ + +

Get hull-shader description.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476715 + GetHullShaderDesc + GetHullShaderDesc + HRESULT ID3DX11EffectPass::GetHullShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) +
+ + +

Get a domain-shader description.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476713 + GetDomainShaderDesc + GetDomainShaderDesc + HRESULT ID3DX11EffectPass::GetDomainShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) +
+ + +

Get a compute-shader description.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476711 + GetComputeShaderDesc + GetComputeShaderDesc + HRESULT ID3DX11EffectPass::GetComputeShaderDesc([Out] D3DX11_PASS_SHADER_DESC* pDesc) +
+ + +

Describes an effect pass, which contains pipeline state.

+
+ +

is used with .

+
+ + ff476319 + D3DX11_PASS_DESC + D3DX11_PASS_DESC +
+ + +

Name of this pass (null if not anonymous).

+
+ + ff476319 + const char* Name + char Name +
+ + +

Number of annotations on this pass.

+
+ + ff476319 + unsigned int Annotations + unsigned int Annotations +
+ + +

Signature from the vertex shader or geometry shader (if there is no vertex shader) or null if neither exists.

+
+ + ff476319 + unsigned char* pIAInputSignature + unsigned char pIAInputSignature +
+ + +

Singature size in bytes.

+
+ + ff476319 + SIZE_T IAInputSignatureSize + SIZE_T IAInputSignatureSize +
+ + +

The stencil-reference value used in the depth-stencil state.

+
+ + ff476319 + unsigned int StencilRef + unsigned int StencilRef +
+ + +

The sample mask for the blend state.

+
+ + ff476319 + unsigned int SampleMask + unsigned int SampleMask +
+ + +

The per-component blend factors (RGBA) for the blend state.

+
+ + ff476319 + SHARPDX_COLOR4 BlendFactor + SHARPDX_COLOR4 BlendFactor +
+ + + Returns the signature of this Effect pass. + + + + +

Describes an effect pass.

+
+ +

is used with Get*ShaderDesc methods.

If this is an inline shader assignment, the returned interface will be an anonymous shader variable, which is not retrievable any other way. It's name in the variable description will be "$Anonymous". If there is no assignment of this type in the pass block, pShaderVariable != null, but pShaderVariable->IsValid() == .

+
+ + ff476320 + D3DX11_PASS_SHADER_DESC + D3DX11_PASS_SHADER_DESC +
+ + +

The variable that this shader came from.

+
+ + ff476320 + ID3DX11EffectShaderVariable* pShaderVariable + ID3DX11EffectShaderVariable pShaderVariable +
+ + +

The element of pShaderVariable (if an array) or 0 if not applicable.

+
+ + ff476320 + unsigned int ShaderIndex + unsigned int ShaderIndex +
+ + + A reference to the variable that the shader came from. If it is an inline shader assignment, the returned interface will be an anonymous shader variable, which is not retrievable any other way. Its name in the variable description will be "$Anonymous". If there is no assignment of this type in the pass block, this will point to a shader variable that returns false when IsValid is called. + + ID3D10EffectShaderVariable* pShaderVariable + + + +

A rasterizer-variable interface accesses rasterizer state.

+
+ +

An interface is created when an effect is read into memory.

Effect variables are saved in memory in the backing store; when a technique is applied, the values in the backing store are copied to the device. You can use either of these methods to return state.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476719 + ID3DX11EffectRasterizerVariable + ID3DX11EffectRasterizerVariable +
+ + + Get a pointer to a rasterizer interface. + + Returns a pointer to a rasterizer interface (see ). + HRESULT ID3D10EffectRasterizerVariable::GetRasterizerState([None] int Index,[Out] ID3D10RasterizerState** ppRasterizerState) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a reference to a rasterizer interface.

+
+

Index into an array of rasterizer interfaces. If there is only one rasterizer interface, use 0.

+

The address of a reference to a rasterizer interface (see ).

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476721 + HRESULT ID3DX11EffectRasterizerVariable::GetRasterizerState([In] unsigned int Index,[Out] ID3D11RasterizerState** ppRasterizerState) + ID3DX11EffectRasterizerVariable::GetRasterizerState +
+ + +

Sets the rasterizer state.

+
+

Index into an array of rasterizer interfaces. If there is only one rasterizer interface, use 0.

+

Pointer to an interface.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476722 + HRESULT ID3DX11EffectRasterizerVariable::SetRasterizerState([In] unsigned int Index,[In] ID3D11RasterizerState* pRasterizerState) + ID3DX11EffectRasterizerVariable::SetRasterizerState +
+ + +

Reverts a previously set rasterizer state.

+
+

Index into an array of rasterizer interfaces. If there is only one rasterizer interface, use 0.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476723 + HRESULT ID3DX11EffectRasterizerVariable::UndoSetRasterizerState([In] unsigned int Index) + ID3DX11EffectRasterizerVariable::UndoSetRasterizerState +
+ + +

Get a reference to a variable that contains rasteriser state.

+
+

Index into an array of rasteriser-state descriptions. If there is only one rasteriser variable in the effect, use 0.

+

A reference to a rasteriser-state description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Effect variables are saved in memory in the backing store; when a technique is applied, the values in the backing store are copied to the device. Backing store data can used to recreate the variable when necessary.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476720 + HRESULT ID3DX11EffectRasterizerVariable::GetBackingStore([In] unsigned int Index,[Out] D3D11_RASTERIZER_DESC* pRasterizerDesc) + ID3DX11EffectRasterizerVariable::GetBackingStore +
+ + +

A render-target-view interface accesses a render target.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476724 + ID3DX11EffectRenderTargetViewVariable + ID3DX11EffectRenderTargetViewVariable +
+ + + Set an array of render-targets. + + Set an array of render-target-view interfaces. See . + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectRenderTargetViewVariable::SetRenderTargetArray([In, Buffer] ID3D10RenderTargetView** ppResources,[None] int Offset,[None] int Count) + + + + Set an array of render-targets. + + Set an array of render-target-view interfaces. See . + The zero-based array index to store the first interface. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectRenderTargetViewVariable::SetRenderTargetArray([In, Buffer] ID3D10RenderTargetView** ppResources,[None] int Offset,[None] int Count) + + + + Get an array of render-targets. + + The number of elements in the array. + Returns an array of . + HRESULT ID3D10EffectRenderTargetViewVariable::GetRenderTargetArray([Out, Buffer] ID3D10RenderTargetView** ppResources,[None] int Offset,[None] int Count) + + + + Get an array of render-targets. + + The zero-based array index to get the first interface. + The number of elements in the array. + Returns an array of . + HRESULT ID3D10EffectRenderTargetViewVariable::GetRenderTargetArray([Out, Buffer] ID3D10RenderTargetView** ppResources,[None] int Offset,[None] int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a render-target.

+
+

A reference to a render-target-view interface. See .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476727 + HRESULT ID3DX11EffectRenderTargetViewVariable::SetRenderTarget([In] ID3D11RenderTargetView* pResource) + ID3DX11EffectRenderTargetViewVariable::SetRenderTarget +
+ + +

Get a render-target.

+
+

The address of a reference to a render-target-view interface. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476725 + HRESULT ID3DX11EffectRenderTargetViewVariable::GetRenderTarget([Out] ID3D11RenderTargetView** ppResource) + ID3DX11EffectRenderTargetViewVariable::GetRenderTarget +
+ + +

Set an array of render-targets.

+
+

Set an array of render-target-view interfaces. See .

+

The zero-based array index to store the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476728 + HRESULT ID3DX11EffectRenderTargetViewVariable::SetRenderTargetArray([In, Buffer] ID3D11RenderTargetView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectRenderTargetViewVariable::SetRenderTargetArray +
+ + +

Set an array of render-targets.

+
+

Set an array of render-target-view interfaces. See .

+

The zero-based array index to store the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476728 + HRESULT ID3DX11EffectRenderTargetViewVariable::SetRenderTargetArray([In, Buffer] ID3D11RenderTargetView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectRenderTargetViewVariable::SetRenderTargetArray +
+ + +

Get an array of render-targets.

+
+

A reference to an array of render-target-view interfaces. See .

+

The zero-based array index to get the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476726 + HRESULT ID3DX11EffectRenderTargetViewVariable::GetRenderTargetArray([Out, Buffer] ID3D11RenderTargetView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectRenderTargetViewVariable::GetRenderTargetArray +
+ + +

A sampler interface accesses sampler state.

+
+ +

An interface is created when an effect is read into memory.

Effect variables are saved in memory in the backing store; when a technique is applied, the values in the backing store are copied to the device. You can use either of these methods to return state.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476729 + ID3DX11EffectSamplerVariable + ID3DX11EffectSamplerVariable +
+ + + Get a reference to a sampler interface. + + Returns a reference to a sampler interface (see ). + HRESULT ID3D10EffectSamplerVariable::GetSampler([None] int Index,[Out] ID3D10SamplerState** ppSampler) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a reference to a sampler interface.

+
+

Index into an array of sampler interfaces. If there is only one sampler interface, use 0.

+

The address of a reference to a sampler interface (see ).

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476731 + HRESULT ID3DX11EffectSamplerVariable::GetSampler([In] unsigned int Index,[Out] ID3D11SamplerState** ppSampler) + ID3DX11EffectSamplerVariable::GetSampler +
+ + +

Set sampler state.

+
+

Index into an array of sampler interfaces. If there is only one sampler interface, use 0.

+

Pointer to an interface containing the sampler state.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476732 + HRESULT ID3DX11EffectSamplerVariable::SetSampler([In] unsigned int Index,[In] ID3D11SamplerState* pSampler) + ID3DX11EffectSamplerVariable::SetSampler +
+ + +

Revert a previously set sampler state.

+
+

Index into an array of sampler interfaces. If there is only one sampler interface, use 0.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476733 + HRESULT ID3DX11EffectSamplerVariable::UndoSetSampler([In] unsigned int Index) + ID3DX11EffectSamplerVariable::UndoSetSampler +
+ + +

Get a reference to a variable that contains sampler state.

+
+

Index into an array of sampler descriptions. If there is only one sampler variable in the effect, use 0.

+

A reference to a sampler description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476730 + HRESULT ID3DX11EffectSamplerVariable::GetBackingStore([In] unsigned int Index,[Out] D3D11_SAMPLER_DESC* pSamplerDesc) + ID3DX11EffectSamplerVariable::GetBackingStore +
+ + +

An effect-scalar-variable interface accesses scalar values.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476734 + ID3DX11EffectScalarVariable + ID3DX11EffectScalarVariable +
+ + + Set a floating-point variable. + + A reference to the variable. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetFloat([None] float Value) + + + + Set an array of floating-point variables. + + A reference to the start of the data to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetFloatArray([In, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Set an array of floating-point variables. + + A reference to the start of the data to set. + Must be set to 0; this is reserved for future use. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetFloatArray([In, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Get an array of floating-point variables. + + The number of array elements to set. + Returns an array of floats. + HRESULT ID3D10EffectScalarVariable::GetFloatArray([Out, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Get an array of floating-point variables. + + Must be set to 0; this is reserved for future use. + The number of array elements to set. + Returns an array of floats. + HRESULT ID3D10EffectScalarVariable::GetFloatArray([Out, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Set an integer variable. + + A reference to the variable. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetInt([None] int Value) + + + + Set an array of integer variables. + + A reference to the start of the data to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetIntArray([In, Buffer] int* pData,[None] int Offset,[None] int Count) + + + + Set an array of integer variables. + + A reference to the start of the data to set. + Must be set to 0; this is reserved for future use. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetIntArray([In, Buffer] int* pData,[None] int Offset,[None] int Count) + + + + Get an array of integer variables. + + The number of array elements to set. + Returns an array of integer variables. + HRESULT ID3D10EffectScalarVariable::GetIntArray([Out, Buffer] int* pData,[None] int Offset,[None] int Count) + + + + Get an array of integer variables. + + Must be set to 0; this is reserved for future use. + The number of array elements to set. + Returns an array of integer variables. + HRESULT ID3D10EffectScalarVariable::GetIntArray([Out, Buffer] int* pData,[None] int Offset,[None] int Count) + + + + Set a boolean variable. + + A reference to the variable. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetBool([None] BOOL Value) + + + + Get a boolean variable. + + Returns a boolean. + HRESULT ID3D10EffectScalarVariable::GetBool([Out] BOOL* pValue) + + + + Set an array of boolean variables. + + A reference to the start of the data to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetBoolArray([In, Buffer] BOOL* pData,[None] int Offset,[None] int Count) + + + + Set an array of boolean variables. + + A reference to the start of the data to set. + Must be set to 0; this is reserved for future use. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::SetBoolArray([In, Buffer] BOOL* pData,[None] int Offset,[None] int Count) + + + + Get an array of boolean variables. + + Must be set to 0; this is reserved for future use. + The number of array elements to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectScalarVariable::GetBoolArray([Out, Buffer] BOOL* pData,[None] int Offset,[None] int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a floating-point variable.

+
+

A reference to the variable.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476743 + HRESULT ID3DX11EffectScalarVariable::SetFloat([In] const float Value) + ID3DX11EffectScalarVariable::SetFloat +
+ + +

Get a floating-point variable.

+
+

A reference to the variable.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476737 + HRESULT ID3DX11EffectScalarVariable::GetFloat([Out] float* pValue) + ID3DX11EffectScalarVariable::GetFloat +
+ + +

Set an array of floating-point variables.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476744 + HRESULT ID3DX11EffectScalarVariable::SetFloatArray([In, Buffer] const float* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectScalarVariable::SetFloatArray +
+ + +

Get an array of floating-point variables.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476738 + HRESULT ID3DX11EffectScalarVariable::GetFloatArray([Out, Buffer] float* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectScalarVariable::GetFloatArray +
+ + +

Set an integer variable.

+
+

A reference to the variable.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476745 + HRESULT ID3DX11EffectScalarVariable::SetInt([In] const int Value) + ID3DX11EffectScalarVariable::SetInt +
+ + +

Get an integer variable.

+
+

A reference to the variable.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476739 + HRESULT ID3DX11EffectScalarVariable::GetInt([Out] int* pValue) + ID3DX11EffectScalarVariable::GetInt +
+ + +

Set an array of integer variables.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476746 + HRESULT ID3DX11EffectScalarVariable::SetIntArray([In, Buffer] const int* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectScalarVariable::SetIntArray +
+ + +

Get an array of integer variables.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476740 + HRESULT ID3DX11EffectScalarVariable::GetIntArray([Out, Buffer] int* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectScalarVariable::GetIntArray +
+ + +

Set a boolean variable.

+
+

A reference to the variable.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476741 + HRESULT ID3DX11EffectScalarVariable::SetBool([In] const BOOL Value) + ID3DX11EffectScalarVariable::SetBool +
+ + +

Get a boolean variable.

+
+

A reference to the variable.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476735 + HRESULT ID3DX11EffectScalarVariable::GetBool([Out] BOOL* pValue) + ID3DX11EffectScalarVariable::GetBool +
+ + +

Set an array of boolean variables.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476742 + HRESULT ID3DX11EffectScalarVariable::SetBoolArray([In, Buffer] const BOOL* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectScalarVariable::SetBoolArray +
+ + +

Get an array of boolean variables.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476736 + HRESULT ID3DX11EffectScalarVariable::GetBoolArray([Out, Buffer] BOOL* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectScalarVariable::GetBoolArray +
+ + +

Describes an effect shader.

+
+ +

is used with .

+
+ + ff476304 + D3DX11_EFFECT_SHADER_DESC + D3DX11_EFFECT_SHADER_DESC +
+ + +

Passed into CreateInputLayout. Only valid on a vertex shader or geometry shader. See .

+
+ + ff476304 + const unsigned char* pInputSignature + unsigned char pInputSignature +
+ + +

TRUE is the shader is defined inline; otherwise .

+
+ + ff476304 + BOOL IsInline + BOOL IsInline +
+ + +

Shader bytecode.

+
+ + ff476304 + const unsigned char* pBytecode + unsigned char pBytecode +
+ + +

The length of pBytecode.

+
+ + ff476304 + unsigned int BytecodeLength + unsigned int BytecodeLength +
+ + +

Indicates which stream is rasterized. D3D11 geometry shaders can output up to four streams of data, one of which can be rasterized.

+
+ + ff476304 + unsigned int RasterizedStream + unsigned int RasterizedStream +
+ + +

Number of entries in the input signature.

+
+ + ff476304 + unsigned int NumInputSignatureEntries + unsigned int NumInputSignatureEntries +
+ + +

Number of entries in the output signature.

+
+ + ff476304 + unsigned int NumOutputSignatureEntries + unsigned int NumOutputSignatureEntries +
+ + +

Number of entries in the patch constant signature.

+
+ + ff476304 + unsigned int NumPatchConstantSignatureEntries + unsigned int NumPatchConstantSignatureEntries +
+ + + Gets the signature passed into InputLayout. Only valid on a vertex shader or geometry shader. + + The signature. + + + + Gets the bytecode from the compiled shader. + + The bytecode. + + + +

Stream out declaration string (for geometry shader with SO).

+
+ + ff476304 + const void* SODecls[4] + void SODecls +
+ + +

A shader-resource interface accesses a shader resource.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476747 + ID3DX11EffectShaderResourceVariable + ID3DX11EffectShaderResourceVariable +
+ + + Set an array of shader resources. + + The address of an array of shader-resource-view interfaces. See . + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectShaderResourceVariable::SetResourceArray([None] ID3D10ShaderResourceView** ppResources,[None] int Offset,[None] int Count) + + + + Set an array of shader resources. + + The address of an array of shader-resource-view interfaces. See . + The zero-based array index to get the first interface. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D10EffectShaderResourceVariable::SetResourceArray([None] ID3D10ShaderResourceView** ppResources,[None] int Offset,[None] int Count) + + + + Get an array of shader resources. + + The number of elements in the array. + Returns an array of shader-resource-view interfaces. See . + HRESULT ID3D10EffectShaderResourceVariable::GetResourceArray([Out] ID3D10ShaderResourceView** ppResources,[None] int Offset,[None] int Count) + + + + Get an array of shader resources. + + The zero-based array index to get the first interface. + The number of elements in the array. + Returns an array of shader-resource-view interfaces. See . + HRESULT ID3D10EffectShaderResourceVariable::GetResourceArray([Out] ID3D10ShaderResourceView** ppResources,[None] int Offset,[None] int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a shader resource.

+
+

The address of a reference to a shader-resource-view interface. See .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476750 + HRESULT ID3DX11EffectShaderResourceVariable::SetResource([In] ID3D11ShaderResourceView* pResource) + ID3DX11EffectShaderResourceVariable::SetResource +
+ + +

Get a shader resource.

+
+

The address of a reference to a shader-resource-view interface. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476748 + HRESULT ID3DX11EffectShaderResourceVariable::GetResource([Out] ID3D11ShaderResourceView** ppResource) + ID3DX11EffectShaderResourceVariable::GetResource +
+ + +

Set an array of shader resources.

+
+

The address of an array of shader-resource-view interfaces. See .

+

The zero-based array index to get the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476751 + HRESULT ID3DX11EffectShaderResourceVariable::SetResourceArray([In, Buffer] ID3D11ShaderResourceView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectShaderResourceVariable::SetResourceArray +
+ + +

Set an array of shader resources.

+
+

The address of an array of shader-resource-view interfaces. See .

+

The zero-based array index to get the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476751 + HRESULT ID3DX11EffectShaderResourceVariable::SetResourceArray([In, Buffer] ID3D11ShaderResourceView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectShaderResourceVariable::SetResourceArray +
+ + +

Get an array of shader resources.

+
+

The address of an array of shader-resource-view interfaces. See .

+

The zero-based array index to get the first interface.

+

The number of elements in the array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476749 + HRESULT ID3DX11EffectShaderResourceVariable::GetResourceArray([Out, Buffer] ID3D11ShaderResourceView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectShaderResourceVariable::GetResourceArray +
+ + +

A string-variable interface accesses a string variable.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476763 + ID3DX11EffectStringVariable + ID3DX11EffectStringVariable +
+ + + Get the string. + + Returns a reference to the string. + HRESULT ID3D10EffectStringVariable::GetString([Out] const char** ppString) + + + + Get an array of strings. + + The number of strings in the returned array. + Returns a reference to the first string in the array. + HRESULT ID3D10EffectStringVariable::GetStringArray([Out, Buffer] const char** ppStrings,[None] int Offset,[None] int Count) + + + + Get an array of strings. + + The offset (in number of strings) between the start of the array and the first string to get. + The number of strings in the returned array. + Returns a reference to the first string in the array. + HRESULT ID3D10EffectStringVariable::GetStringArray([Out, Buffer] const char** ppStrings,[None] int Offset,[None] int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the string.

+
+

A reference to the string.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476764 + HRESULT ID3DX11EffectStringVariable::GetString([Out] const void** ppString) + ID3DX11EffectStringVariable::GetString +
+ + +

Get an array of strings.

+
+

A reference to the first string in the array.

+

The offset (in number of strings) between the start of the array and the first string to get.

+

The number of strings in the returned array.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476765 + HRESULT ID3DX11EffectStringVariable::GetStringArray([Out, Buffer] const void** ppStrings,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectStringVariable::GetStringArray +
+ + +

Accesses an unordered access view.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476783 + ID3DX11EffectUnorderedAccessViewVariable + ID3DX11EffectUnorderedAccessViewVariable +
+ + + Sets the specified view. + + The view. + A object describing the result of the operation. + HRESULT ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray([In, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + + + + Sets the specified data ref. + + The data ref. + The offset. + A object describing the result of the operation. + HRESULT ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray([In, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + + + + Sets the specified data ref. + + The data ref. + A object describing the result of the operation. + HRESULT ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray([In, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + + + + Sets the specified data ref. + + The data ref. + The offset. + A object describing the result of the operation. + HRESULT ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray([In, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + + + + Gets the unordered access view array. + + The count. + A object describing the result of the operation. + HRESULT ID3DX11EffectUnorderedAccessViewVariable::GetUnorderedAccessViewArray([Out, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + + + + Gets the unordered access view array. + + The offset. + The count. + A object describing the result of the operation. + HRESULT ID3DX11EffectUnorderedAccessViewVariable::GetUnorderedAccessViewArray([Out, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set an unordered-access-view.

+
+

Pointer to an .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476786 + HRESULT ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessView([In] ID3D11UnorderedAccessView* pResource) + ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessView +
+ + +

Get an unordered-access-view.

+
+

Pointer to an reference that will be set on return.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476784 + HRESULT ID3DX11EffectUnorderedAccessViewVariable::GetUnorderedAccessView([In] ID3D11UnorderedAccessView** ppResource) + ID3DX11EffectUnorderedAccessViewVariable::GetUnorderedAccessView +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray([In, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray([In, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectUnorderedAccessViewVariable::SetUnorderedAccessViewArray + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DX11EffectUnorderedAccessViewVariable::GetUnorderedAccessViewArray([Out, Buffer] ID3D11UnorderedAccessView** ppResources,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectUnorderedAccessViewVariable::GetUnorderedAccessViewArray + + + +

A vector-variable interface accesses a four-component vector.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476817 + ID3DX11EffectVectorVariable + ID3DX11EffectVectorVariable +
+ + + Get a four-component vector that contains integer data. + + Returns a four-component vector that contains integer data + HRESULT ID3D11EffectVectorVariable::GetIntVector([Out] int* pData) + + + + Get a four-component vector that contains floating-point data. + + Returns a four-component vector that contains floating-point data. + HRESULT ID3D11EffectVectorVariable::GetFloatVector([Out] float* pData) + + + + Get a four-component vector that contains boolean data. + + a four-component vector that contains boolean data. + HRESULT ID3D11EffectVectorVariable::GetBoolVector([Out, Buffer] BOOL* pData) + + + + Get a four-component vector. + + Type of the four-component vector + a four-component vector. + HRESULT ID3D11EffectVectorVariable::GetFloatVector([Out, Buffer] BOOL* pData) + + + + Set an array of four-component vectors that contain integer data. + + A reference to the start of the data to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetIntVectorArray([In, Buffer] int* pData,[None] int Offset,[None] int Count) + + + + Set an array of four-component vectors that contain floating-point data. + + A reference to the start of the data to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetFloatVectorArray([In, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Set an array of four-component vectors that contain floating-point data. + + Type of the four-component vector + A reference to the start of the data to set. + + Returns one of the following {{Direct3D 10 Return Codes}}. + + HRESULT ID3D11EffectVectorVariable::SetFloatVectorArray([In, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Set a x-component vector. + + A reference to the first component. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetFloatVector([In] float* pData) + + + + Set a x-component vector. + + A reference to the first component. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetFloatVector([In] float* pData) + + + + Set a two-component vector that contains floating-point data. + + A reference to the first component. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetFloatVector([In] float* pData) + + + + Set a three-component vector that contains floating-point data. + + A reference to the first component. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetFloatVector([In] float* pData) + + + + Set a four-component color that contains floating-point data. + + A reference to the first component. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetFloatVector([In] float* pData) + + + + Set an array of four-component color that contain floating-point data. + + A reference to the start of the data to set. + Returns one of the following {{Direct3D 10 Return Codes}}. + HRESULT ID3D11EffectVectorVariable::SetFloatVectorArray([In, Buffer] float* pData,[None] int Offset,[None] int Count) + + + + Get an array of four-component vectors that contain integer data. + + The number of array elements to set. + Returns an array of four-component vectors that contain integer data. + HRESULT ID3D11EffectVectorVariable::GetIntVectorArray([Out, Buffer] int* pData,[None] int Offset,[None] int Count) + + + + Get an array of four-component vectors that contain floating-point data. + + The number of array elements to set. + Returns an array of four-component vectors that contain floating-point data. + HRESULT ID3D11EffectVectorVariable::GetFloatVectorArray([None] float* pData,[None] int Offset,[None] int Count) + + + + Get an array of four-component vectors that contain boolean data. + + The number of array elements to set. + an array of four-component vectors that contain boolean data. + HRESULT ID3D11EffectVectorVariable::GetBoolVectorArray([Out, Buffer] BOOL* pData,[None] int Offset,[None] int Count) + + + + Get an array of four-component vectors that contain boolean data. + + The number of array elements to set. + an array of four-component vectors that contain boolean data. + HRESULT ID3D11EffectVectorVariable::GetBoolVectorArray([Out, Buffer] BOOL* pData,[None] int Offset,[None] int Count) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a four-component vector that contains boolean data.

+
+

A reference to the first component.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476824 + HRESULT ID3DX11EffectVectorVariable::SetBoolVector([In] const SHARPDX_BOOL4* pData) + ID3DX11EffectVectorVariable::SetBoolVector +
+ + +

Set a four-component vector that contains integer data.

+
+

A reference to the first component.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476828 + HRESULT ID3DX11EffectVectorVariable::SetIntVector([In] const SHARPDX_INT4* pData) + ID3DX11EffectVectorVariable::SetIntVector +
+ + +

Set a four-component vector that contains floating-point data.

+
+

A reference to the first component.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476826 + HRESULT ID3DX11EffectVectorVariable::SetFloatVector([In] const float* pData) + ID3DX11EffectVectorVariable::SetFloatVector +
+ + +

Get a four-component vector that contains boolean data.

+
+

A reference to the first component.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476818 + HRESULT ID3DX11EffectVectorVariable::GetBoolVector([Out] SHARPDX_BOOL4* pData) + ID3DX11EffectVectorVariable::GetBoolVector +
+ + +

Get a four-component vector that contains integer data.

+
+

A reference to the first component.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476822 + HRESULT ID3DX11EffectVectorVariable::GetIntVector([Out] SHARPDX_INT4* pData) + ID3DX11EffectVectorVariable::GetIntVector +
+ + +

Get a four-component vector that contains floating-point data.

+
+

A reference to the first component.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476820 + HRESULT ID3DX11EffectVectorVariable::GetFloatVector([Out] SHARPDX_VECTOR4* pData) + ID3DX11EffectVectorVariable::GetFloatVector +
+ + +

Set an array of four-component vectors that contain boolean data.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476825 + HRESULT ID3DX11EffectVectorVariable::SetBoolVectorArray([In, Buffer] const SHARPDX_BOOL4* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVectorVariable::SetBoolVectorArray +
+ + +

Set an array of four-component vectors that contain integer data.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476829 + HRESULT ID3DX11EffectVectorVariable::SetIntVectorArray([In, Buffer] const SHARPDX_INT4* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVectorVariable::SetIntVectorArray +
+ + +

Set an array of four-component vectors that contain floating-point data.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476827 + HRESULT ID3DX11EffectVectorVariable::SetFloatVectorArray([In, Buffer] const SHARPDX_VECTOR4* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVectorVariable::SetFloatVectorArray +
+ + +

Get an array of four-component vectors that contain boolean data.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476819 + HRESULT ID3DX11EffectVectorVariable::GetBoolVectorArray([Out, Buffer] SHARPDX_BOOL4* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVectorVariable::GetBoolVectorArray +
+ + +

Get an array of four-component vectors that contain integer data.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476823 + HRESULT ID3DX11EffectVectorVariable::GetIntVectorArray([Out, Buffer] SHARPDX_INT4* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVectorVariable::GetIntVectorArray +
+ + +

Get an array of four-component vectors that contain floating-point data.

+
+

A reference to the start of the data to set.

+

Must be set to 0; this is reserved for future use.

+

The number of array elements to set.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476821 + HRESULT ID3DX11EffectVectorVariable::GetFloatVectorArray([Out, Buffer] SHARPDX_VECTOR4* pData,[In] unsigned int Offset,[In] unsigned int Count) + ID3DX11EffectVectorVariable::GetFloatVectorArray +
+ + + No documentation. + + + D3DX11_EFFECT_VARIABLE_FLAGS + D3DX11_EFFECT_VARIABLE_FLAGS + + + + No documentation. + + + D3DX11_EFFECT_VARIABLE_ANNOTATION + D3DX11_EFFECT_VARIABLE_ANNOTATION + + + + No documentation. + + + D3DX11_EFFECT_VARIABLE_EXPLICIT_BIND_POINT + D3DX11_EFFECT_VARIABLE_EXPLICIT_BIND_POINT + + + + None. + + + None + None + + + + Functions + + + + + + DLLs loaders + + + + +

Creates an effect from a binary effect or file.

+
+

Blob of compiled effect data.

+

Length of the data blob.

+

Compilation flags pertaining to Effect compilation, honored by the Effect compiler.

+

Pointer to the on which to create Effect resources.

+

Address of the newly created interface.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476273 + HRESULT D3DX11CreateEffectFromMemory([In] const void* pData,[In] SIZE_T DataLength,[In] unsigned int FXFlags,[In] ID3D11Device* pDevice,[Out, Fast] ID3DX11Effect** ppEffect) + D3DX11CreateEffectFromMemory +
+ + +

Accesses a class instance.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476658 + ID3DX11EffectClassInstanceVariable + ID3DX11EffectClassInstanceVariable +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets a class instance.

+
+

Pointer to an reference that will be set to class instance.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476659 + HRESULT ID3DX11EffectClassInstanceVariable::GetClassInstance([In] ID3D11ClassInstance** ppClassInstance) + ID3DX11EffectClassInstanceVariable::GetClassInstance +
+ + +

Gets a class instance.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476659 + GetClassInstance + GetClassInstance + HRESULT ID3DX11EffectClassInstanceVariable::GetClassInstance([In] ID3D11ClassInstance** ppClassInstance) +
+ + +

A constant-buffer interface accesses constant buffers or texture buffers.

+
+ +

Use constant buffers to store many effect constants; grouping constants into buffers based on their frequency of update. This allows you to minimize the number of state changes as well as make the fewest API calls to change state. Both of these factors lead to better performance.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476670 + ID3DX11EffectConstantBuffer + ID3DX11EffectConstantBuffer +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a constant-buffer.

+
+

A reference to a constant-buffer interface. See .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476673 + HRESULT ID3DX11EffectConstantBuffer::SetConstantBuffer([In] ID3D11Buffer* pConstantBuffer) + ID3DX11EffectConstantBuffer::SetConstantBuffer +
+ + +

Reverts a previously set constant buffer.

+
+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476675 + HRESULT ID3DX11EffectConstantBuffer::UndoSetConstantBuffer() + ID3DX11EffectConstantBuffer::UndoSetConstantBuffer +
+ + +

Get a constant-buffer.

+
+

The address of a reference to a constant-buffer interface. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476671 + HRESULT ID3DX11EffectConstantBuffer::GetConstantBuffer([Out] ID3D11Buffer** ppConstantBuffer) + ID3DX11EffectConstantBuffer::GetConstantBuffer +
+ + +

Set a texture-buffer.

+
+

A reference to a shader-resource-view interface for accessing a texture buffer.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476674 + HRESULT ID3DX11EffectConstantBuffer::SetTextureBuffer([In] ID3D11ShaderResourceView* pTextureBuffer) + ID3DX11EffectConstantBuffer::SetTextureBuffer +
+ + +

Reverts a previously set texture buffer.

+
+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476676 + HRESULT ID3DX11EffectConstantBuffer::UndoSetTextureBuffer() + ID3DX11EffectConstantBuffer::UndoSetTextureBuffer +
+ + +

Get a texture-buffer.

+
+

The address of a reference to a shader-resource-view interface for accessing a texture buffer. See .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476672 + HRESULT ID3DX11EffectConstantBuffer::GetTextureBuffer([Out] ID3D11ShaderResourceView** ppTextureBuffer) + ID3DX11EffectConstantBuffer::GetTextureBuffer +
+ + +

The interface accesses an Effect group.

The lifetime of an object is equal to the lifetime of its parent object.

  • Methods
Methods

The interface has the following methods.

+
+ +

To get an interface, call a method like .

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476687 + ID3DX11EffectGroup + ID3DX11EffectGroup +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Test an effect to see if it contains valid syntax.

+
+

TRUE if the code syntax is valid; otherwise .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476693 + BOOL ID3DX11EffectGroup::IsValid() + ID3DX11EffectGroup::IsValid +
+ + +

Gets a group description.

+
+

A reference to a structure.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476690 + HRESULT ID3DX11EffectGroup::GetDesc([Out] D3DX11_GROUP_DESC* pDesc) + ID3DX11EffectGroup::GetDesc +
+ + +

Get an annotation by index.

+
+

Index of the annotation.

+

Pointer to an interface.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476688 + ID3DX11EffectVariable* ID3DX11EffectGroup::GetAnnotationByIndex([In] unsigned int Index) + ID3DX11EffectGroup::GetAnnotationByIndex +
+ + +

Get an annotation by name.

+
+

The name of the annotation.

+

A reference to an . Note that if the annotation is not found the returned will be empty. The method should be called to determine whether the annotation was found.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476689 + ID3DX11EffectVariable* ID3DX11EffectGroup::GetAnnotationByName([In] const char* Name) + ID3DX11EffectGroup::GetAnnotationByName +
+ + +

Get a technique by index.

+
+

A zero-based index.

+

A reference to an .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476691 + ID3DX11EffectTechnique* ID3DX11EffectGroup::GetTechniqueByIndex([In] unsigned int Index) + ID3DX11EffectGroup::GetTechniqueByIndex +
+ + +

Get a technique by name.

+
+

The name of the technique.

+

A reference to an , or null if the technique is not found.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476692 + ID3DX11EffectTechnique* ID3DX11EffectGroup::GetTechniqueByName([In] const char* Name) + ID3DX11EffectGroup::GetTechniqueByName +
+ + +

Test an effect to see if it contains valid syntax.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476693 + IsValid + IsValid + BOOL ID3DX11EffectGroup::IsValid() +
+ + +

Gets a group description.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476690 + GetDesc + GetDesc + HRESULT ID3DX11EffectGroup::GetDesc([Out] D3DX11_GROUP_DESC* pDesc) +
+ + +

Accesses an interface variable.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476694 + ID3DX11EffectInterfaceVariable + ID3DX11EffectInterfaceVariable +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets a class instance.

+
+

Pointer to an interface.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476696 + HRESULT ID3DX11EffectInterfaceVariable::SetClassInstance([In] ID3DX11EffectClassInstanceVariable* pEffectClassInstance) + ID3DX11EffectInterfaceVariable::SetClassInstance +
+ + +

Get a class instance.

+
+

Pointer to an reference that will be set to the class instance.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476695 + HRESULT ID3DX11EffectInterfaceVariable::GetClassInstance([In] ID3DX11EffectClassInstanceVariable** ppEffectClassInstance) + ID3DX11EffectInterfaceVariable::GetClassInstance +
+ + +

Get or sets a class instance.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476695 + GetClassInstance / SetClassInstance + GetClassInstance + HRESULT ID3DX11EffectInterfaceVariable::GetClassInstance([In] ID3DX11EffectClassInstanceVariable** ppEffectClassInstance) +
+ + +

A shader-variable interface accesses a shader variable.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476752 + ID3DX11EffectShaderVariable + ID3DX11EffectShaderVariable +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a shader description.

+
+

A zero-based index.

+

A reference to a shader description (see ).

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476761 + HRESULT ID3DX11EffectShaderVariable::GetShaderDesc([In] unsigned int ShaderIndex,[Out] D3DX11_EFFECT_SHADER_DESC* pDesc) + ID3DX11EffectShaderVariable::GetShaderDesc +
+ + +

Get a vertex shader.

+
+

A zero-based index.

+

A reference to an reference that will be set to the vertex shader on return.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476762 + HRESULT ID3DX11EffectShaderVariable::GetVertexShader([In] unsigned int ShaderIndex,[Out] ID3D11VertexShader** ppVS) + ID3DX11EffectShaderVariable::GetVertexShader +
+ + +

Get a geometry shader.

+
+

A zero-based index.

+

A reference to an reference that will be set to the geometry shader on return.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476755 + HRESULT ID3DX11EffectShaderVariable::GetGeometryShader([In] unsigned int ShaderIndex,[Out] ID3D11GeometryShader** ppGS) + ID3DX11EffectShaderVariable::GetGeometryShader +
+ + +

Get a pixel shader.

+
+

A zero-based index.

+

A reference to an reference that will be set to the pixel shader on return.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476760 + HRESULT ID3DX11EffectShaderVariable::GetPixelShader([In] unsigned int ShaderIndex,[Out] ID3D11PixelShader** ppPS) + ID3DX11EffectShaderVariable::GetPixelShader +
+ + +

Get a hull shader.

+
+

Index of the shader.

+

A reference to an reference that will be set to the hull shader on return.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476756 + HRESULT ID3DX11EffectShaderVariable::GetHullShader([In] unsigned int ShaderIndex,[In] ID3D11HullShader** ppPS) + ID3DX11EffectShaderVariable::GetHullShader +
+ + +

Get a domain shader.

+
+

Index of the domain shader.

+

Pointer to an reference that will be set to the domain shader on return.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476754 + HRESULT ID3DX11EffectShaderVariable::GetDomainShader([In] unsigned int ShaderIndex,[In] ID3D11DomainShader** ppPS) + ID3DX11EffectShaderVariable::GetDomainShader +
+ + +

Get a compute shader.

+
+

Index of the compute shader.

+

Pointer to an reference that will be set to the compute shader on return.

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476753 + HRESULT ID3DX11EffectShaderVariable::GetComputeShader([In] unsigned int ShaderIndex,[In] ID3D11ComputeShader** ppPS) + ID3DX11EffectShaderVariable::GetComputeShader +
+ + +

Get an input-signature description.

+
+

A zero-based shader index.

+

A zero-based shader-element index.

+

A reference to a parameter description (see ).

+ +

An effect contains one or more shaders; each shader has an input and output signature; each signature contains one or more elements (or parameters). The shader index identifies the shader and the element index identifies the element (or parameter) in the shader signature.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476757 + HRESULT ID3DX11EffectShaderVariable::GetInputSignatureElementDesc([In] unsigned int ShaderIndex,[In] unsigned int Element,[Out] D3D11_SIGNATURE_PARAMETER_DESC* pDesc) + ID3DX11EffectShaderVariable::GetInputSignatureElementDesc +
+ + +

Get an output-signature description.

+
+

A zero-based shader index.

+

A zero-based element index.

+

A reference to a parameter description (see ).

+ +

An effect contains one or more shaders; each shader has an input and output signature; each signature contains one or more elements (or parameters). The shader index identifies the shader and the element index identifies the element (or parameter) in the shader signature.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476758 + HRESULT ID3DX11EffectShaderVariable::GetOutputSignatureElementDesc([In] unsigned int ShaderIndex,[In] unsigned int Element,[Out] D3D11_SIGNATURE_PARAMETER_DESC* pDesc) + ID3DX11EffectShaderVariable::GetOutputSignatureElementDesc +
+ + +

Get a patch constant signature description.

+
+

A zero-based shader index.

+

A zero-based element index.

+

A reference to a parameter description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476759 + HRESULT ID3DX11EffectShaderVariable::GetPatchConstantSignatureElementDesc([In] unsigned int ShaderIndex,[In] unsigned int Element,[In] D3D11_SIGNATURE_PARAMETER_DESC* pDesc) + ID3DX11EffectShaderVariable::GetPatchConstantSignatureElementDesc +
+ + +

Compute a state-block mask to allow/prevent state changes.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476767 + ID3DX11EffectTechnique + ID3DX11EffectTechnique +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Test a technique to see if it contains valid syntax.

+
+

TRUE if the code syntax is valid; otherwise .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476773 + BOOL ID3DX11EffectTechnique::IsValid() + ID3DX11EffectTechnique::IsValid +
+ + +

Get a technique description.

+
+

A reference to a technique description (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476770 + HRESULT ID3DX11EffectTechnique::GetDesc([Out] D3DX11_TECHNIQUE_DESC* pDesc) + ID3DX11EffectTechnique::GetDesc +
+ + +

Get an annotation by index.

+
+

The zero-based index of the interface reference.

+

A reference to an .

+ +

Use an annotation to attach a piece of metadata to a technique.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476768 + ID3DX11EffectVariable* ID3DX11EffectTechnique::GetAnnotationByIndex([In] unsigned int Index) + ID3DX11EffectTechnique::GetAnnotationByIndex +
+ + +

Get an annotation by name.

+
+

Name of the annotation.

+

A reference to an .

+ +

Use an annotation to attach a piece of metadata to a technique.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476769 + ID3DX11EffectVariable* ID3DX11EffectTechnique::GetAnnotationByName([In] const char* Name) + ID3DX11EffectTechnique::GetAnnotationByName +
+ + +

Get a pass by index.

+
+

A zero-based index.

+

A reference to a .

+ +

A technique contains one or more passes; get a pass using a name or an index.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476771 + ID3DX11EffectPass* ID3DX11EffectTechnique::GetPassByIndex([In] unsigned int Index) + ID3DX11EffectTechnique::GetPassByIndex +
+ + +

Get a pass by name.

+
+

The name of the pass.

+

A reference to an .

+ +

A technique contains one or more passes; get a pass using a name or an index.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476772 + ID3DX11EffectPass* ID3DX11EffectTechnique::GetPassByName([In] const char* Name) + ID3DX11EffectTechnique::GetPassByName +
+ + +

Compute a state-block mask to allow/prevent state changes.

+
+

A reference to a state-block mask (see ).

+

Returns one of the following Direct3D 11 Return Codes.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476767 + HRESULT ID3DX11EffectTechnique::ComputeStateBlockMask([In] D3DX11_STATE_BLOCK_MASK* pStateBlockMask) + ID3DX11EffectTechnique::ComputeStateBlockMask +
+ + +

Test a technique to see if it contains valid syntax.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476773 + IsValid + IsValid + BOOL ID3DX11EffectTechnique::IsValid() +
+ + +

Get a technique description.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476770 + GetDesc + GetDesc + HRESULT ID3DX11EffectTechnique::GetDesc([Out] D3DX11_TECHNIQUE_DESC* pDesc) +
+ + +

The interface accesses effect variables by type.

The lifetime of an object is equal to the lifetime of its parent object.

  • Methods
Methods

The interface has the following methods.

+
+ +

To get information about an effect type from an effect variable, call .

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476774 + ID3DX11EffectType + ID3DX11EffectType +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Tests that the effect type is valid.

+
+

TRUE if it is valid; otherwise .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476782 + BOOL ID3DX11EffectType::IsValid() + ID3DX11EffectType::IsValid +
+ + +

Get an effect-type description.

+
+

A reference to an effect-type description. See .

+

Returns one of the following Direct3D 11 Return Codes.

+ +

The effect-variable description contains data about the name, annotations, semantic, flags and buffer offset of the effect type.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476775 + HRESULT ID3DX11EffectType::GetDesc([Out] D3DX11_EFFECT_TYPE_DESC* pDesc) + ID3DX11EffectType::GetDesc +
+ + +

Get a member type by index.

+
+

A zero-based index.

+

A reference to an .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476779 + ID3DX11EffectType* ID3DX11EffectType::GetMemberTypeByIndex([In] unsigned int Index) + ID3DX11EffectType::GetMemberTypeByIndex +
+ + +

Get an member type by name.

+
+

A member's name.

+

A reference to an .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476780 + ID3DX11EffectType* ID3DX11EffectType::GetMemberTypeByName([In] const char* Name) + ID3DX11EffectType::GetMemberTypeByName +
+ + +

Get a member type by semantic.

+
+

A semantic.

+

A reference to an .

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476781 + ID3DX11EffectType* ID3DX11EffectType::GetMemberTypeBySemantic([In] const char* Semantic) + ID3DX11EffectType::GetMemberTypeBySemantic +
+ + +

Get the name of a member.

+
+

A zero-based index.

+

The name of the member.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476776 + const char* ID3DX11EffectType::GetMemberName([In] unsigned int Index) + ID3DX11EffectType::GetMemberName +
+ + +

Get the semantic attached to a member.

+
+

A zero-based index.

+

A string that contains the semantic.

+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476778 + const char* ID3DX11EffectType::GetMemberSemantic([In] unsigned int Index) + ID3DX11EffectType::GetMemberSemantic +
+ + +

Tests that the effect type is valid.

+
+ +

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476782 + IsValid + IsValid + BOOL ID3DX11EffectType::IsValid() +
+ + +

Get an effect-type description.

+
+ +

The effect-variable description contains data about the name, annotations, semantic, flags and buffer offset of the effect type.

Note??The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

+
+ + ff476775 + GetDesc + GetDesc + HRESULT ID3DX11EffectType::GetDesc([Out] D3DX11_EFFECT_TYPE_DESC* pDesc) +
+ + +

Describes an effect.

+
+ +

is used with .

+
+ + ff476303 + D3DX11_EFFECT_DESC + D3DX11_EFFECT_DESC +
+ + +

Number of constant buffers in this effect.

+
+ + ff476303 + unsigned int ConstantBuffers + unsigned int ConstantBuffers +
+ + +

Number of global variables in this effect.

+
+ + ff476303 + unsigned int GlobalVariables + unsigned int GlobalVariables +
+ + +

Number of global interfaces in this effect.

+
+ + ff476303 + unsigned int InterfaceVariables + unsigned int InterfaceVariables +
+ + +

Number of techniques in this effect.

+
+ + ff476303 + unsigned int Techniques + unsigned int Techniques +
+ + +

Number of groups in this effect.

+
+ + ff476303 + unsigned int Groups + unsigned int Groups +
+ + +

Describes an effect group.

+
+ +

is used with .

+
+ + ff476314 + D3DX11_GROUP_DESC + D3DX11_GROUP_DESC +
+ + +

Name of this group (only null if global).

+
+ + ff476314 + const char* Name + char Name +
+ + +

Number of techniques contained in group.

+
+ + ff476314 + unsigned int Techniques + unsigned int Techniques +
+ + +

Number of annotations on this group.

+
+ + ff476314 + unsigned int Annotations + unsigned int Annotations +
+ + +

Describes an effect technique.

+
+ +

is used with .

+
+ + ff476326 + D3DX11_TECHNIQUE_DESC + D3DX11_TECHNIQUE_DESC +
+ + +

Name of this technique (null if not anonymous).

+
+ + ff476326 + const char* Name + char Name +
+ + +

Number of passes contained in the technique.

+
+ + ff476326 + unsigned int Passes + unsigned int Passes +
+ + +

Number of annotations on this technique.

+
+ + ff476326 + unsigned int Annotations + unsigned int Annotations +
+ + +

Describes an effect-variable type.

+
+ +

is used with

+
+ + ff476305 + D3DX11_EFFECT_TYPE_DESC + D3DX11_EFFECT_TYPE_DESC +
+ + +

Name of the type, for example "float4" or "MyStruct".

+
+ + ff476305 + const char* TypeName + char TypeName +
+ + +

The variable class (see D3D10_SHADER_VARIABLE_CLASS).

+
+ + ff476305 + D3D_SHADER_VARIABLE_CLASS Class + D3D_SHADER_VARIABLE_CLASS Class +
+ + +

The variable type (see D3D10_SHADER_VARIABLE_TYPE).

+
+ + ff476305 + D3D_SHADER_VARIABLE_TYPE Type + D3D_SHADER_VARIABLE_TYPE Type +
+ + +

Number of elements in this type (0 if not an array).

+
+ + ff476305 + unsigned int Elements + unsigned int Elements +
+ + +

Number of members (0 if not a structure).

+
+ + ff476305 + unsigned int Members + unsigned int Members +
+ + +

Number of rows in this type (0 if not a numeric primitive).

+
+ + ff476305 + unsigned int Rows + unsigned int Rows +
+ + +

Number of columns in this type (0 if not a numeric primitive).

+
+ + ff476305 + unsigned int Columns + unsigned int Columns +
+ + +

Number of bytes required to represent this data type, when tightly packed.

+
+ + ff476305 + unsigned int PackedSize + unsigned int PackedSize +
+ + +

Number of bytes occupied by this data type, when laid out in a constant buffer.

+
+ + ff476305 + unsigned int UnpackedSize + unsigned int UnpackedSize +
+ + +

Number of bytes to seek between elements, when laid out in a constant buffer.

+
+ + ff476305 + unsigned int Stride + unsigned int Stride +
+ + +

Describes an effect variable.

+
+ +

is used with .

+
+ + ff476306 + D3DX11_EFFECT_VARIABLE_DESC + D3DX11_EFFECT_VARIABLE_DESC +
+ + +

Name of this variable, annotation, or structure member.

+
+ + ff476306 + const char* Name + char Name +
+ + +

Semantic string of this variable or structure member (null for annotations or if not present).

+
+ + ff476306 + const char* Semantic + char Semantic +
+ + +

Optional flags for effect variables.

+
+ + ff476306 + D3DX11_EFFECT_VARIABLE_FLAGS Flags + D3DX11_EFFECT_VARIABLE_FLAGS Flags +
+ + +

Number of annotations on this variable (always 0 for annotations).

+
+ + ff476306 + unsigned int Annotations + unsigned int Annotations +
+ + +

Offset into containing cbuffer or tbuffer (always 0 for annotations or variables not in constant buffers).

+
+ + ff476306 + unsigned int BufferOffset + unsigned int BufferOffset +
+ + +

Used if the variable has been explicitly bound using the register keyword. Check Flags for .

+
+ + ff476306 + unsigned int ExplicitBindPoint + unsigned int ExplicitBindPoint +
+ + +

Indicates the device state.

+
+ +

A state-block mask indicates the device states that a pass or a technique changes.

+
+ + ff476325 + D3DX11_STATE_BLOCK_MASK + D3DX11_STATE_BLOCK_MASK +
+ + +

Boolean value indicating whether to save the vertex shader state.

+
+ + ff476325 + unsigned char VS + unsigned char VS +
+ + +

Boolean value indicating whether to save the hull shader state.

+
+ + ff476325 + unsigned char HS + unsigned char HS +
+ + +

Boolean value indicating whether to save the domain shader state.

+
+ + ff476325 + unsigned char DS + unsigned char DS +
+ + +

Boolean value indicating whether to save the geometry shader state.

+
+ + ff476325 + unsigned char GS + unsigned char GS +
+ + +

Boolean value indicating whether to save the pixel shader state.

+
+ + ff476325 + unsigned char PS + unsigned char PS +
+ + +

Boolean value indicating whether to save the pixel shader unordered access views.

+
+ + ff476325 + unsigned char PSUnorderedAccessViews + unsigned char PSUnorderedAccessViews +
+ + +

Boolean value indicating whether to save the compute shader state.

+
+ + ff476325 + unsigned char CS + unsigned char CS +
+ + +

Boolean value indicating whether to save the compute shader unordered access views.

+
+ + ff476325 + unsigned char CSUnorderedAccessViews + unsigned char CSUnorderedAccessViews +
+ + +

Boolean value indicating whether to save the index buffer state.

+
+ + ff476325 + unsigned char IAIndexBuffer + unsigned char IAIndexBuffer +
+ + +

Boolean value indicating whether to save the input layout state.

+
+ + ff476325 + unsigned char IAInputLayout + unsigned char IAInputLayout +
+ + +

Boolean value indicating whether to save the primitive topology state.

+
+ + ff476325 + unsigned char IAPrimitiveTopology + unsigned char IAPrimitiveTopology +
+ + +

Boolean value indicating whether to save the render targets states.

+
+ + ff476325 + unsigned char OMRenderTargets + unsigned char OMRenderTargets +
+ + +

Boolean value indicating whether to save the depth-stencil state.

+
+ + ff476325 + unsigned char OMDepthStencilState + unsigned char OMDepthStencilState +
+ + +

Boolean value indicating whether to save the blend state.

+
+ + ff476325 + unsigned char OMBlendState + unsigned char OMBlendState +
+ + +

Boolean value indicating whether to save the viewports states.

+
+ + ff476325 + unsigned char RSViewports + unsigned char RSViewports +
+ + +

Boolean value indicating whether to save the scissor rectangles states.

+
+ + ff476325 + unsigned char RSScissorRects + unsigned char RSScissorRects +
+ + +

Boolean value indicating whether to save the rasterizer state.

+
+ + ff476325 + unsigned char RSRasterizerState + unsigned char RSRasterizerState +
+ + +

Boolean value indicating whether to save the stream-out buffers states.

+
+ + ff476325 + unsigned char SOBuffers + unsigned char SOBuffers +
+ + +

Boolean value indicating whether to save the predication state.

+
+ + ff476325 + unsigned char Predication + unsigned char Predication +
+ + +

Array of vertex-shader samplers. The array is a multi-byte bitmask where each bit represents one sampler slot.

+
+ + ff476325 + unsigned char VSSamplers[2] + unsigned char VSSamplers +
+ + +

Array of vertex-shader resources. The array is a multi-byte bitmask where each bit represents one resource slot.

+
+ + ff476325 + unsigned char VSShaderResources[16] + unsigned char VSShaderResources +
+ + +

Array of vertex-shader constant buffers. The array is a multi-byte bitmask where each bit represents one constant buffer slot.

+
+ + ff476325 + unsigned char VSConstantBuffers[2] + unsigned char VSConstantBuffers +
+ + +

Array of vertex-shader interfaces. The array is a multi-byte bitmask where each bit represents one interface slot.

+
+ + ff476325 + unsigned char VSInterfaces[32] + unsigned char VSInterfaces +
+ + +

Array of hull-shader samplers. The array is a multi-byte bitmask where each bit represents one sampler slot.

+
+ + ff476325 + unsigned char HSSamplers[2] + unsigned char HSSamplers +
+ + +

Array of hull-shader resources. The array is a multi-byte bitmask where each bit represents one resource slot.

+
+ + ff476325 + unsigned char HSShaderResources[16] + unsigned char HSShaderResources +
+ + +

Array of hull-shader constant buffers. The array is a multi-byte bitmask where each bit represents one constant buffer slot.

+
+ + ff476325 + unsigned char HSConstantBuffers[2] + unsigned char HSConstantBuffers +
+ + +

Array of hull-shader interfaces. The array is a multi-byte bitmask where each bit represents one interface slot.

+
+ + ff476325 + unsigned char HSInterfaces[32] + unsigned char HSInterfaces +
+ + +

Array of domain-shader samplers. The array is a multi-byte bitmask where each bit represents one sampler slot.

+
+ + ff476325 + unsigned char DSSamplers[2] + unsigned char DSSamplers +
+ + +

Array of domain-shader resources. The array is a multi-byte bitmask where each bit represents one resource slot.

+
+ + ff476325 + unsigned char DSShaderResources[16] + unsigned char DSShaderResources +
+ + +

Array of domain-shader constant buffers. The array is a multi-byte bitmask where each bit represents one buffer slot.

+
+ + ff476325 + unsigned char DSConstantBuffers[2] + unsigned char DSConstantBuffers +
+ + +

Array of domain-shader interfaces. The array is a multi-byte bitmask where each bit represents one interface slot.

+
+ + ff476325 + unsigned char DSInterfaces[32] + unsigned char DSInterfaces +
+ + +

Array of geometry-shader samplers. The array is a multi-byte bitmask where each bit represents one sampler slot.

+
+ + ff476325 + unsigned char GSSamplers[2] + unsigned char GSSamplers +
+ + +

Array of geometry-shader resources. The array is a multi-byte bitmask where each bit represents one resource slot.

+
+ + ff476325 + unsigned char GSShaderResources[16] + unsigned char GSShaderResources +
+ + +

Array of geometry-shader constant buffers. The array is a multi-byte bitmask where each bit represents one buffer slot.

+
+ + ff476325 + unsigned char GSConstantBuffers[2] + unsigned char GSConstantBuffers +
+ + +

Array of geometry-shader interfaces. The array is a multi-byte bitmask where each bit represents one interface slot.

+
+ + ff476325 + unsigned char GSInterfaces[32] + unsigned char GSInterfaces +
+ + +

Array of pixel-shader samplers. The array is a multi-byte bitmask where each bit represents one sampler slot.

+
+ + ff476325 + unsigned char PSSamplers[2] + unsigned char PSSamplers +
+ + +

Array of pixel-shader resources. The array is a multi-byte bitmask where each bit represents one resource slot.

+
+ + ff476325 + unsigned char PSShaderResources[16] + unsigned char PSShaderResources +
+ + +

Array of pixel-shader constant buffers. The array is a multi-byte bitmask where each bit represents one constant buffer slot.

+
+ + ff476325 + unsigned char PSConstantBuffers[2] + unsigned char PSConstantBuffers +
+ + +

Array of pixel-shader interfaces. The array is a multi-byte bitmask where each bit represents one interface slot.

+
+ + ff476325 + unsigned char PSInterfaces[32] + unsigned char PSInterfaces +
+ + +

Array of compute-shader samplers. The array is a multi-byte bitmask where each bit represents one sampler slot.

+
+ + ff476325 + unsigned char CSSamplers[2] + unsigned char CSSamplers +
+ + +

Array of compute-shader resources. The array is a multi-byte bitmask where each bit represents one resource slot.

+
+ + ff476325 + unsigned char CSShaderResources[16] + unsigned char CSShaderResources +
+ + +

Array of compute-shader constant buffers. The array is a multi-byte bitmask where each bit represents one constant buffer slot.

+
+ + ff476325 + unsigned char CSConstantBuffers[2] + unsigned char CSConstantBuffers +
+ + +

Array of compute-shader interfaces. The array is a multi-byte bitmask where each bit represents one interface slot.

+
+ + ff476325 + unsigned char CSInterfaces[32] + unsigned char CSInterfaces +
+ + +

Array of vertex buffers. The array is a multi-byte bitmask where each bit represents one resource slot.

+
+ + ff476325 + unsigned char IAVertexBuffers[4] + unsigned char IAVertexBuffers +
+
+
diff --git a/distribution/SharpDX.Direct3D11.dll b/distribution/SharpDX.Direct3D11.dll new file mode 100644 index 00000000..84bcb300 Binary files /dev/null and b/distribution/SharpDX.Direct3D11.dll differ diff --git a/distribution/SharpDX.Direct3D11.xml b/distribution/SharpDX.Direct3D11.xml new file mode 100644 index 00000000..c7c7c59c --- /dev/null +++ b/distribution/SharpDX.Direct3D11.xml @@ -0,0 +1,21687 @@ + + + + SharpDX.Direct3D11 + + + + + The assembly provides managed Direct3D11 API. + + ff476080 + Direct3D11 + Direct3D11 + + + +

The blend-state interface holds a description for blending state that you can bind to the output-merger stage.

+
+ +

Blending applies a simple function to combine output values from a pixel shader with data in a render target. You have control over how the pixels are blended by using a predefined set of blending operations and preblending operations.

To create a blend-state object, call . To bind the blend-state object to the output-merger stage, call .

+
+ + ff476349 + ID3D11BlendState + ID3D11BlendState +
+ + +

A device-child interface accesses data used by a device.

+
+ +

There are several types of device child interfaces, all of which inherit this interface. They include shaders, state objects, and input layouts.

+
+ + ff476380 + ID3D11DeviceChild + ID3D11DeviceChild +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a reference to the device that created this interface.

+
+

Address of a reference to a device (see ).

+ +

Any returned interfaces will have their reference count incremented by one, so be sure to call ::release() on the returned reference(s) before they are freed or else you will have a memory leak.

+
+ + ff476381 + void ID3D11DeviceChild::GetDevice([Out] ID3D11Device** ppDevice) + ID3D11DeviceChild::GetDevice +
+ + +

Get application-defined data from a device child.

+
+

Guid associated with the data.

+

A reference to a variable that on input contains the size, in bytes, of the buffer that pData points to, and on output contains the size, in bytes, of the amount of data that GetPrivateData retrieved.

+

A reference to a buffer that GetPrivateData fills with data from the device child if pDataSize points to a value that specifies a buffer large enough to hold the data.

+

This method returns one of the codes described in the topic Direct3D 11 Return Codes.

+ +

The data stored in the device child is set by calling .

+
+ + ff476382 + HRESULT ID3D11DeviceChild::GetPrivateData([In] const GUID& guid,[InOut] unsigned int* pDataSize,[Out, Buffer, Optional] void* pData) + ID3D11DeviceChild::GetPrivateData +
+ + +

Set application-defined data to a device child and associate that data with an application-defined guid.

+
+

Guid associated with the data.

+

Size of the data.

+

Pointer to the data to be stored with this device child. If pData is null, DataSize must also be 0, and any data previously associated with the specified guid will be destroyed.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

The data stored in the device child with this method can be retrieved with .

The debug layer reports memory leaks by outputting a list of object interface references along with their friendly names. The default friendly name is "<unnamed>". You can set the friendly name so that you can determine if the corresponding object interface reference caused the leak. To set the friendly name, use the SetPrivateData method and the that is in D3Dcommon.h. For example, to give pContext a friendly name of My name, use the following code:

 static const char c_szName[] = "My name";	
+            hr = pContext->SetPrivateData( , sizeof( c_szName ) - 1, c_szName );	
+            
+
+ + ff476383 + HRESULT ID3D11DeviceChild::SetPrivateData([In] const GUID& guid,[In] unsigned int DataSize,[In, Buffer, Optional] const void* pData) + ID3D11DeviceChild::SetPrivateData +
+ + +

Associate an -derived interface with this device child and associate that interface with an application-defined guid.

+
+

Guid associated with the interface.

+

Pointer to an -derived interface to be associated with the device child.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

When this method is called ::addref() will be called on the -derived interface, and when the device child is detroyed ::release() will be called on the -derived interface.

+
+ + ff476384 + HRESULT ID3D11DeviceChild::SetPrivateDataInterface([In] const GUID& guid,[In, Optional] const IUnknown* pData) + ID3D11DeviceChild::SetPrivateDataInterface +
+ + + Gets or sets the debug-name for this object. + + + The debug name. + + + + +

Get a reference to the device that created this interface.

+
+ +

Any returned interfaces will have their reference count incremented by one, so be sure to call ::release() on the returned reference(s) before they are freed or else you will have a memory leak.

+
+ + ff476381 + GetDevice + GetDevice + void ID3D11DeviceChild::GetDevice([Out] ID3D11Device** ppDevice) +
+ + + Constructs a new based on the specified description. + + The device with which to associate the state object. + The state description. + The newly created object. + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the description for blending state that you used to create the blend-state object.

+
+

A reference to a structure that receives a description of the blend state.

+ +

You use the description for blending state in a call to the method to create the blend-state object.

+
+ + ff476350 + void ID3D11BlendState::GetDesc([Out] D3D11_BLEND_DESC* pDesc) + ID3D11BlendState::GetDesc +
+ + +

Gets the description for blending state that you used to create the blend-state object.

+
+ +

You use the description for blending state in a call to the method to create the blend-state object.

+
+ + ff476350 + GetDesc + GetDesc + void ID3D11BlendState::GetDesc([Out] D3D11_BLEND_DESC* pDesc) +
+ + +

Describes the blend state that you use in a call to to create a blend-state object.

+
+ +

Here are the default values for blend state.

StateDefault Value
AlphaToCoverageEnable
IndependentBlendEnable
RenderTarget[0].BlendEnable
RenderTarget[0].SrcBlend
RenderTarget[0].DestBlend
RenderTarget[0].BlendOp
RenderTarget[0].SrcBlendAlpha
RenderTarget[0].DestBlendAlpha
RenderTarget[0].BlendOpAlpha
RenderTarget[0].RenderTargetWriteMask

?

Note?? is identical to .

If the driver type is set to , the feature level is set to less than or equal to , and the pixel format of the render target is set to , , or , the display device performs the blend in standard RGB (sRGB) space and not in linear space. However, if the feature level is set to greater than , the display device performs the blend in linear space, which is ideal.

+
+ + ff476087 + D3D11_BLEND_DESC + D3D11_BLEND_DESC +
+ + + Returns default values for . + + + See MSDN documentation for default values. + + + + + Clones this instance. + + A copy of this instance. + + Because this structure contains an array, it is not possible to modify it without making an explicit clone method. + + + + + No documentation. + + + BOOL AlphaToCoverageEnable + BOOL AlphaToCoverageEnable + + + + No documentation. + + + BOOL IndependentBlendEnable + BOOL IndependentBlendEnable + + + + No documentation. + + + D3D11_RENDER_TARGET_BLEND_DESC RenderTarget[8] + D3D11_RENDER_TARGET_BLEND_DESC RenderTarget + + + +

A buffer interface accesses a buffer resource, which is unstructured memory. Buffers typically store vertex or index data.

+
+ +

There are three types of buffers: vertex, index, or a shader-constant buffer. Create a buffer resource by calling .

A buffer must be bound to the pipeline before it can be accessed. Buffers can be bound to the input-assembler stage by calls to and , to the stream-output stage by a call to , and to a shader stage by calling the appropriate shader method (such as for example).

Buffers can be bound to multiple pipeline stages simultaneously for reading. A buffer can also be bound to a single pipeline stage for writing; however, the same buffer cannot be bound for reading and writing simultaneously.

+
+ + ff476351 + ID3D11Buffer + ID3D11Buffer +
+ + +

A resource interface provides common actions on all resources.

+
+ +

A resource interface cannot be created directly; instead, buffers and textures are created that inherit from a resource interface (see Creating Buffer Resources or Creating Texture Resources).

+
+ + ff476584 + ID3D11Resource + ID3D11Resource +
+ + Constant MaximumMipLevels. + D3D11_REQ_MIP_LEVELS + + + Constant ResourceSizeInMegabytes. + D3D11_REQ_RESOURCE_SIZE_IN_MEGABYTES_EXPRESSION_A_TERM + + + Constant MaximumTexture1DArraySize. + D3D11_REQ_TEXTURE1D_ARRAY_AXIS_DIMENSION + + + Constant MaximumTexture2DArraySize. + D3D11_REQ_TEXTURE2D_ARRAY_AXIS_DIMENSION + + + Constant MaximumTexture1DSize. + D3D11_REQ_TEXTURE1D_U_DIMENSION + + + Constant MaximumTexture2DSize. + D3D11_REQ_TEXTURE2D_U_OR_V_DIMENSION + + + Constant MaximumTexture3DSize. + D3D11_REQ_TEXTURE3D_U_V_OR_W_DIMENSION + + + Constant MaximumTextureCubeSize. + D3D11_REQ_TEXTURECUBE_DIMENSION + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the type of the resource.

+
+

Pointer to the resource type (see ).

+ + ff476586 + void ID3D11Resource::GetType([Out] D3D11_RESOURCE_DIMENSION* pResourceDimension) + ID3D11Resource::GetType +
+ + +

Set the eviction priority of a resource.

+
+

Eviction priority for the resource, which is one of the following values:

+ +

Resource priorities determine which resource to evict from video memory when the system has run out of video memory. The resource will not be lost; it will be removed from video memory and placed into system memory, or possibly placed onto the hard drive. The resource will be loaded back into video memory when it is required.

A resource that is set to the maximum priority, , is only evicted if there is no other way of resolving the incoming memory request. The Windows Display Driver Model (WDDM) tries to split an incoming memory request to its minimum size and evict lower-priority resources before evicting a resource with maximum priority.

Changing the priorities of resources should be done carefully. The wrong eviction priorities could be a detriment to performance rather than an improvement.

+
+ + ff476587 + void ID3D11Resource::SetEvictionPriority([In] unsigned int EvictionPriority) + ID3D11Resource::SetEvictionPriority +
+ + +

Get the eviction priority of a resource.

+
+

One of the following values, which specifies the eviction priority for the resource:

+ + ff476585 + unsigned int ID3D11Resource::GetEvictionPriority() + ID3D11Resource::GetEvictionPriority +
+ + + Gets a swap chain back buffer. + + The type of the buffer. + The swap chain to get the buffer from. + The index of the desired buffer. + The buffer interface, or null on failure. + + + + Loads a texture from an image file. + + The device used to load the texture. + Path to the file on disk. + The loaded texture object. + + + + Loads a texture from an image file. + + The device used to load the texture. + Path to the file on disk. + Specifies information used to load the texture. + The loaded texture object. + + + + Loads a texture from an image file. + + The device used to load the texture. + Path to the file on disk. + Specifies information used to load the texture. + The loaded texture object. + + + + Loads a texture from an image file. + + The device used to load the texture. + Path to the file on disk. + The loaded texture object. + + + + Load a texture from a texture. + + A reference to a valid + Pointer to the source texture. See . + Pointer to the destination texture. See . + Pointer to texture loading parameters. See . + The return value is one of the values listed in {{Direct3D 10 Return Codes}}. + HRESULT D3DX10LoadTextureFromTexture([None] ID3D10Resource* pSrcTexture,[None] D3DX10_TEXTURE_LOAD_INFO* pLoadInfo,[None] ID3D10Resource* pDstTexture) + + + + Generates mipmap chain using a particular texture filter for this texture instance. + + A reference to an object. + The mipmap level whose data is used to generate the rest of the mipmap chain. + Flags controlling how each miplevel is filtered (or D3DX11_DEFAULT for ). See . + The return value is one of the values listed in Direct3D 11 Return Codes. + HRESULT D3DX11FilterTexture([In] ID3D11DeviceContext* pContext,[In] ID3D11Resource* pTexture,[In] unsigned int SrcLevel,[In] unsigned int MipFilter) + + + + Saves a texture to file. + + The device used to save the texture. + The texture to save. + The format the texture will be saved as. + Name of the destination output file where the texture will be saved. + A object describing the result of the operation. + + + + Loads a texture from an image in memory. + + The device used to load the texture. + Array of memory containing the image data to load. + The loaded texture object. + + + + Loads a texture from an image in memory. + + The device used to load the texture. + Array of memory containing the image data to load. + Specifies information used to load the texture. + The loaded texture object. + + + + Loads a texture from an image in memory. + + The device used to load the texture. + Array of memory containing the image data to load. + The loaded texture object. + + + + Loads a texture from an image in memory. + + The device used to load the texture. + Array of memory containing the image data to load. + Specifies information used to load the texture. + The loaded texture object. + + + + Loads a texture from a stream of data. + + The device used to load the texture. + A stream containing the image data to load. + Size of the image to load. + The loaded texture object. + + + + Loads a texture from a stream of data. + + The device used to load the texture. + A stream containing the image data to load. + Size of the image to load. + Specifies information used to load the texture. + The loaded texture object. + + + + Loads a texture from a stream of data. + + The device used to load the texture. + A stream containing the image data to load. + Size of the image to load. + The loaded texture object. + + + + Loads a texture from a stream of data. + + The device used to load the texture. + A stream containing the image data to load. + Size of the image to load. + Specifies information used to load the texture. + The loaded texture object. + + + + Saves a texture to a stream. + + The device used to save the texture. + The texture to save. + The format the texture will be saved as. + Destination memory stream where the image will be saved. + A object describing the result of the operation. + + + + Calculates the sub resource index from a miplevel. + + A zero-based index for the mipmap level to address; 0 indicates the first, most detailed mipmap level. + The zero-based index for the array level to address; always use 0 for volume (3D) textures. + Number of mipmap levels in the resource. + + The index which equals MipSlice + (ArraySlice * MipLevels). + + D3D11CalcSubresource + + + + Calculates the resulting size at a single level for an original size. + + The mip level to get the size. + Size of the base. + + Size of the mipLevel + + + + + Calculates the sub resource index for a particular mipSlice and arraySlice. + + The mip slice. + The array slice. + The size of slice. This values is resource dependent. Texture1D -> mipSize of the Width. Texture2D -> mipSize of the Height. Texture3D -> mipsize of the Depth + The resulting miplevel calulated for this instance with this mipSlice and arraySlice. + + + +

Get the type of the resource.

+
+ + ff476586 + GetType + GetType + void ID3D11Resource::GetType([Out] D3D11_RESOURCE_DIMENSION* pResourceDimension) +
+ + +

Get or sets the eviction priority of a resource.

+
+ + ff476585 + GetEvictionPriority / SetEvictionPriority + GetEvictionPriority + unsigned int ID3D11Resource::GetEvictionPriority() +
+ + + Initializes a new instance of the class. + + The device with which to associate the buffer. + The description of the buffer. + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Initializes a new instance of the class. + + The device with which to associate the buffer. + Initial data used to initialize the buffer. + The description of the buffer. + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Initializes a new instance of the class. + + The device with which to associate the buffer. + The data pointer. + The description of the buffer. + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Initializes a new instance of the class. + + The device with which to associate the buffer. + The size, in bytes, of the buffer. + The usage pattern for the buffer. + Flags specifying how the buffer will be bound to the pipeline. + Flags specifying how the buffer will be accessible from the CPU. + Miscellaneous resource options. + The size (in bytes) of the structure element for structured buffers. + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Initializes a new instance of the class. + + The device with which to associate the buffer. + Initial data used to initialize the buffer. + The size, in bytes, of the buffer. + The usage pattern for the buffer. + Flags specifying how the buffer will be bound to the pipeline. + Flags specifying how the buffer will be accessible from the CPU. + Miscellaneous resource options. + The size (in bytes) of the structure element for structured buffers. + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Creates a new instance of the class. + + Type of the data to upload + The device with which to associate the buffer. + Flags specifying how the buffer will be bound to the pipeline. + Initial data used to initialize the buffer. + The size, in bytes, of the buffer. If 0 is specified, sizeof(T) is used. + The usage pattern for the buffer. + Flags specifying how the buffer will be accessible from the CPU. + Miscellaneous resource options. + The size (in bytes) of the structure element for structured buffers. + An initialized buffer + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Creates a new instance of the class. + + Type of the data to upload + The device with which to associate the buffer. + Flags specifying how the buffer will be bound to the pipeline. + Initial data used to initialize the buffer. + The size, in bytes, of the buffer. If 0 is specified, sizeof(T) * data.Length is used. + The usage pattern for the buffer. + Flags specifying how the buffer will be accessible from the CPU. + Miscellaneous resource options. + The size (in bytes) of the structure element for structured buffers. + An initialized buffer + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Creates a new instance of the class. + + Type of the data to upload + The device with which to associate the buffer. + Initial data used to initialize the buffer. + The description. + + An initialized buffer + + + If the is at 0, sizeof(T) is used. + + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Creates a new instance of the class. + + Type of the data to upload + The device with which to associate the buffer. + Initial data used to initialize the buffer. + The description. + + An initialized buffer + + + If the is at 0, sizeof(T) * data.Length is used. + + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the properties of a buffer resource.

+
+

Pointer to a resource description (see ) filled in by the method.

+ + ff476352 + void ID3D11Buffer::GetDesc([Out] D3D11_BUFFER_DESC* pDesc) + ID3D11Buffer::GetDesc +
+ + +

Get the properties of a buffer resource.

+
+ + ff476352 + GetDesc + GetDesc + void ID3D11Buffer::GetDesc([Out] D3D11_BUFFER_DESC* pDesc) +
+ + +

Describes a buffer resource.

+
+ +

This structure is used by to create buffer resources.

In addition to this structure, there is also a derived structure in D3D11.h (CD3D11_BUFFER_DESC) which behaves like an inherited class to help create a buffer description.

If the bind flag is then the ByteWidth value must be in multiples of 16, and less than or equal to D3D11_REQ_CONSTANT_BUFFER_ELEMENT_COUNT.

+
+ + ff476092 + D3D11_BUFFER_DESC + D3D11_BUFFER_DESC +
+ + + Initializes a new instance of the struct. + + The size in bytes. + The usage. + The bind flags. + The cpu access flags. + The option flags. + The structure byte stride. + + + +

Size of the buffer in bytes.

+
+ + ff476092 + unsigned int ByteWidth + unsigned int ByteWidth +
+ + +

Identify how the buffer is expected to be read from and written to. Frequency of update is a key factor. The most common value is typically ; see for all possible values.

+
+ + ff476092 + D3D11_USAGE Usage + D3D11_USAGE Usage +
+ + +

Identify how the buffer will be bound to the pipeline. Flags (see ) can be combined with a logical OR.

+
+ + ff476092 + D3D11_BIND_FLAG BindFlags + D3D11_BIND_FLAG BindFlags +
+ + +

CPU access flags (see ) or 0 if no CPU access is necessary. Flags can be combined with a logical OR.

+
+ + ff476092 + D3D11_CPU_ACCESS_FLAG CPUAccessFlags + D3D11_CPU_ACCESS_FLAG CPUAccessFlags +
+ + +

Miscellaneous flags (see ) or 0 if unused. Flags can be combined with a logical OR.

+
+ + ff476092 + D3D11_RESOURCE_MISC_FLAG MiscFlags + D3D11_RESOURCE_MISC_FLAG MiscFlags +
+ + +

The size of the structure (in bytes) when it represents a structured buffer.

+
+ + ff476092 + unsigned int StructureByteStride + unsigned int StructureByteStride +
+ + +

This interface encapsulates an HLSL class.

+
+ +

This interface is created by calling . The interface is used when binding shader resources to the pipeline using APIs such as .

+
+ + ff476353 + ID3D11ClassInstance + ID3D11ClassInstance +
+ + + Initializes a class-instance object that represents an HLSL class instance. + + + Instances can be created (or gotten) before or after a shader is created. Use the same shader linkage object to acquire a class instance and create the shader the instance is going to be used in. For more information about using the interface, see {{Dynamic Linking}}. + + An instance of . + The type name of a class to initialize. + Identifies the constant buffer that contains the class data. + The four-component vector offset from the start of the constant buffer where the class data will begin. Consequently, this is not a byte offset. + The texture slot for the first texture; there may be multiple textures following the offset. + The sampler slot for the first sampler; there may be multiple samplers following the offset. + Returns S_OK if successful; otherwise, returns one of the following {{Direct3D 11 Return Codes}}. + HRESULT ID3D11ClassLinkage::CreateClassInstance([In] const char* pClassTypeName,[In] int ConstantBufferOffset,[In] int ConstantVectorOffset,[In] int TextureOffset,[In] int SamplerOffset,[Out] ID3D11ClassInstance** ppInstance) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the object associated with the current HLSL class.

+
+ No documentation. + +

For more information about using the interface, see Dynamic Linking.

+
+ + ff476354 + void ID3D11ClassInstance::GetClassLinkage([Out] ID3D11ClassLinkage** ppLinkage) + ID3D11ClassInstance::GetClassLinkage +
+ + +

Gets a description of the current HLSL class.

+
+

A reference to a structure that describes the current HLSL class.

+ +

For more information about using the interface, see Dynamic Linking.

An instance is not restricted to being used for a single type in a single shader. An instance is flexible and can be used for any shader that used the same type name or instance name when the instance was generated.

  • A created instance will work for any shader that contains a type of the same type name. For instance, a class instance created with the type name DefaultShader would work in any shader that contained a type DefaultShader even though several shaders could describe a different type.
  • A gotten instance maps directly to an instance name/index in a shader. A class instance aquired using GetClassInstance will work for any shader that contains a class instance of the name used to generate the runtime instance, the instance does not have to be the same type in all of the shaders it's used in.

An instance does not replace the importance of reflection for a particular shader since a gotten instance will not know its slot location and a created instance only specifies a type name.

+
+ + ff476355 + void ID3D11ClassInstance::GetDesc([Out] D3D11_CLASS_INSTANCE_DESC* pDesc) + ID3D11ClassInstance::GetDesc +
+ + +

Gets the instance name of the current HLSL class.

+
+

The instance name of the current HLSL class.

+

The length of the pInstanceName parameter.

+ +

GetInstanceName will return a valid name only for instances acquired using .

For more information about using the interface, see Dynamic Linking.

+
+ + ff476356 + void ID3D11ClassInstance::GetInstanceName([Out, Buffer, Optional] char* pInstanceName,[InOut] SIZE_T* pBufferLength) + ID3D11ClassInstance::GetInstanceName +
+ + +

Gets the type of the current HLSL class.

+
+

Type of the current HLSL class.

+

The length of the pTypeName parameter.

+ +

GetTypeName will return a valid name only for instances acquired using .

For more information about using the interface, see Dynamic Linking.

+
+ + ff476357 + void ID3D11ClassInstance::GetTypeName([Out, Buffer, Optional] char* pTypeName,[InOut] SIZE_T* pBufferLength) + ID3D11ClassInstance::GetTypeName +
+ + + Gets the instance name of the current HLSL class. + + + GetInstanceName will return a valid name only for instances acquired using .For more information about using the interface, see {{Dynamic Linking}}. + + The instance name of the current HLSL class. + void GetInstanceName([Out, Buffer, Optional] LPSTR pInstanceName,[InOut] SIZE_T* pBufferLength) + + + + Gets the type of the current HLSL class. + + + GetTypeName will return a valid name only for instances acquired using .For more information about using the interface, see {{Dynamic Linking}}. + + Type of the current HLSL class. + void GetTypeName([Out, Buffer, Optional] LPSTR pTypeName,[InOut] SIZE_T* pBufferLength) + + + +

Gets the object associated with the current HLSL class.

+
+ +

For more information about using the interface, see Dynamic Linking.

+
+ + ff476354 + GetClassLinkage + GetClassLinkage + void ID3D11ClassInstance::GetClassLinkage([Out] ID3D11ClassLinkage** ppLinkage) +
+ + +

Gets a description of the current HLSL class.

+
+ +

For more information about using the interface, see Dynamic Linking.

An instance is not restricted to being used for a single type in a single shader. An instance is flexible and can be used for any shader that used the same type name or instance name when the instance was generated.

  • A created instance will work for any shader that contains a type of the same type name. For instance, a class instance created with the type name DefaultShader would work in any shader that contained a type DefaultShader even though several shaders could describe a different type.
  • A gotten instance maps directly to an instance name/index in a shader. A class instance aquired using GetClassInstance will work for any shader that contains a class instance of the name used to generate the runtime instance, the instance does not have to be the same type in all of the shaders it's used in.

An instance does not replace the importance of reflection for a particular shader since a gotten instance will not know its slot location and a created instance only specifies a type name.

+
+ + ff476355 + GetDesc + GetDesc + void ID3D11ClassInstance::GetDesc([Out] D3D11_CLASS_INSTANCE_DESC* pDesc) +
+ + +

This interface encapsulates an HLSL dynamic linkage.

+
+ +

A class linkage object can hold up to 64K gotten instances. A gotten instance is a handle that references a variable name in any shader that is created with that linkage object. When you create a shader with a class linkage object, the runtime gathers these instances and stores them in the class linkage object. For more information about how a class linkage object is used, see Storing Variables and Types for Shaders to Share.

An object is created using the method.

+
+ + ff476358 + ID3D11ClassLinkage + ID3D11ClassLinkage +
+ + + Create a new instance of . + + + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the class-instance object that represents the specified HLSL class.

+
+

The name of a class for which to get the class instance.

+

The index of the class instance.

+

The address of a reference to an interface to initialize.

+ +

For more information about using the interface, see Dynamic Linking.

A class instance must have at least 1 data member in order to be available for the runtime to use with . Any instance with no members will be optimized out of a compiled shader blob as a zero-sized object. If you have a class with no data members, use instead.

+
+ + ff476360 + HRESULT ID3D11ClassLinkage::GetClassInstance([In] const char* pClassInstanceName,[In] unsigned int InstanceIndex,[Out] ID3D11ClassInstance** ppInstance) + ID3D11ClassLinkage::GetClassInstance +
+ + +

Initializes a class-instance object that represents an HLSL class instance.

+
+

The type name of a class to initialize.

+

Identifies the constant buffer that contains the class data.

+

The four-component vector offset from the start of the constant buffer where the class data will begin. Consequently, this is not a byte offset.

+

The texture slot for the first texture; there may be multiple textures following the offset.

+

The sampler slot for the first sampler; there may be multiple samplers following the offset.

+

The address of a reference to an interface to initialize.

+

Returns if successful; otherwise, returns one of the following Direct3D 11 Return Codes.

+ +

Instances can be created (or gotten) before or after a shader is created. Use the same shader linkage object to acquire a class instance and create the shader the instance is going to be used in.

For more information about using the interface, see Dynamic Linking.

+
+ + ff476359 + HRESULT ID3D11ClassLinkage::CreateClassInstance([In] const char* pClassTypeName,[In] unsigned int ConstantBufferOffset,[In] unsigned int ConstantVectorOffset,[In] unsigned int TextureOffset,[In] unsigned int SamplerOffset,[Out, Fast] ID3D11ClassInstance** ppInstance) + ID3D11ClassLinkage::CreateClassInstance +
+ + +

A compute-shader interface manages an executable program (a compute shader) that controls the compute-shader stage.

+
+ +

The compute-shader interface has no methods; use HLSL to implement your shader functionality. All shaders are implemented from a common set of features referred to as the common-shader core..

To create a compute-shader interface, call . Before using a compute shader you must bind it to the device by calling .

This interface is defined in D3D11.h.

+
+ + ff476363 + ID3D11ComputeShader + ID3D11ComputeShader +
+ + + Initializes a new instance of the class. + + The device used to create the shader. + The compiled shader bytecode. + A dynamic class linkage interface. + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Describes depth-stencil state.

+
+ +

Depth-stencil state controls how depth-stencil testing is performed by the output-merger stage.

The following table shows the default values of depth-stencil states.

StateDefault Value
DepthEnableTRUE
DepthWriteMask
DepthFunc
StencilEnable
StencilReadMaskD3D11_DEFAULT_STENCIL_READ_MASK
StencilWriteMaskD3D11_DEFAULT_STENCIL_WRITE_MASK

FrontFace.StencilFunc

and

BackFace.StencilFunc

FrontFace.StencilDepthFailOp

and

BackFace.StencilDepthFailOp

FrontFace.StencilPassOp

and

BackFace.StencilPassOp

FrontFace.StencilFailOp

and

BackFace.StencilFailOp

?

The formats that support stenciling are and .

+
+ + ff476110 + D3D11_DEPTH_STENCIL_DESC + D3D11_DEPTH_STENCIL_DESC +
+ + + Returns default values for . + + + See MSDN documentation for default values. + + + + +

Enable depth testing.

+
+ + ff476110 + BOOL DepthEnable + BOOL DepthEnable +
+ + +

Identify a portion of the depth-stencil buffer that can be modified by depth data (see ).

+
+ + ff476110 + D3D11_DEPTH_WRITE_MASK DepthWriteMask + D3D11_DEPTH_WRITE_MASK DepthWriteMask +
+ + +

A function that compares depth data against existing depth data. The function options are listed in .

+
+ + ff476110 + D3D11_COMPARISON_FUNC DepthFunc + D3D11_COMPARISON_FUNC DepthFunc +
+ + +

Enable stencil testing.

+
+ + ff476110 + BOOL StencilEnable + BOOL StencilEnable +
+ + +

Identify a portion of the depth-stencil buffer for reading stencil data.

+
+ + ff476110 + unsigned char StencilReadMask + unsigned char StencilReadMask +
+ + +

Identify a portion of the depth-stencil buffer for writing stencil data.

+
+ + ff476110 + unsigned char StencilWriteMask + unsigned char StencilWriteMask +
+ + +

Identify how to use the results of the depth test and the stencil test for pixels whose surface normal is facing towards the camera (see ).

+
+ + ff476110 + D3D11_DEPTH_STENCILOP_DESC FrontFace + D3D11_DEPTH_STENCILOP_DESC FrontFace +
+ + +

Identify how to use the results of the depth test and the stencil test for pixels whose surface normal is facing away from the camera (see ).

+
+ + ff476110 + D3D11_DEPTH_STENCILOP_DESC BackFace + D3D11_DEPTH_STENCILOP_DESC BackFace +
+ + + The namespace provides a managed Direct3D11 API. + + ff476080 + Direct3D11 + Direct3D11 + + + +

Describes rasterizer state.

+
+ +

Rasterizer state defines the behavior of the rasterizer stage; to set rasterizer state, call .

These are the default values for rasterizer state.

StateDefault Value
FillModeSolid
CullModeBack
FrontCounterClockwise
DepthBias0
SlopeScaledDepthBias0.0f
DepthBiasClamp0.0f
DepthClipEnableTRUE
ScissorEnable
MultisampleEnable
AntialiasedLineEnable

?

+
+ + ff476198 + D3D11_RASTERIZER_DESC + D3D11_RASTERIZER_DESC +
+ + + Returns default values for . + + + See MSDN documentation for default values. + + + + +

Determines the fill mode to use when rendering (see ).

+
+ + ff476198 + D3D11_FILL_MODE FillMode + D3D11_FILL_MODE FillMode +
+ + +

Indicates triangles facing the specified direction are not drawn (see ).

+
+ + ff476198 + D3D11_CULL_MODE CullMode + D3D11_CULL_MODE CullMode +
+ + +

Determines if a triangle is front- or back-facing. If this parameter is true, then a triangle will be considered front-facing if its vertices are counter-clockwise on the render target and considered back-facing if they are clockwise. If this parameter is false then the opposite is true.

+
+ + ff476198 + BOOL FrontCounterClockwise + BOOL FrontCounterClockwise +
+ + +

Depth value added to a given pixel.

+
+ + ff476198 + int DepthBias + int DepthBias +
+ + +

Maximum depth bias of a pixel.

+
+ + ff476198 + float DepthBiasClamp + float DepthBiasClamp +
+ + +

Scalar on a given pixel's slope.

+
+ + ff476198 + float SlopeScaledDepthBias + float SlopeScaledDepthBias +
+ + +

Enable clipping based on distance.

The hardware always performs x and y clipping of rasterized coordinates. When DepthClipEnable is set to the default?TRUE, the hardware also clips the z value (that is, the hardware performs the last step of the following algorithm). +

0 < w + -w <= x <= w (or arbitrarily wider range if implementation uses a guard band to reduce clipping burden) + -w <= y <= w (or arbitrarily wider range if implementation uses a guard band to reduce clipping burden) + 0 <= z <= w +

When you set DepthClipEnable to , the hardware skips the z clipping (that is, the last step in the preceding algorithm). However, the hardware still performs the "0 < w" clipping. When z clipping is disabled, improper depth ordering at the pixel level might result. However, when z clipping is disabled, stencil shadow implementations are simplified. In other words, you can avoid complex special-case handling for geometry that goes beyond the back clipping plane. +

+
+ + ff476198 + BOOL DepthClipEnable + BOOL DepthClipEnable +
+ + +

Enable scissor-rectangle culling. All pixels ouside an active scissor rectangle are culled.

+
+ + ff476198 + BOOL ScissorEnable + BOOL ScissorEnable +
+ + +

Enable multisample antialiasing.

+
+ + ff476198 + BOOL MultisampleEnable + BOOL MultisampleEnable +
+ + +

Enable line antialiasing; only applies if doing line drawing and MultisampleEnable is false.

+
+ + ff476198 + BOOL AntialiasedLineEnable + BOOL AntialiasedLineEnable +
+ + +

This interface encapsulates methods for measuring GPU performance.

+
+ +

A counter can be created with .

This is a derived class of .

Counter data is gathered by issuing an command, issuing some graphics commands, issuing an command, and then calling to get data about what happened in between the Begin and End calls. The data returned by GetData will be different depending on the type of counter. The call to End causes the data returned by GetData to be accurate up until the last call to End.

Counters are best suited for profiling.

For a list of the types of performance counters, see .

+
+ + ff476364 + ID3D11Counter + ID3D11Counter +
+ + +

This interface encapsulates methods for retrieving data from the GPU asynchronously.

+
+ +

There are three types of asynchronous interfaces, all of which inherit this interface:

  • - Queries information from the GPU.
  • - Determines whether a piece of geometry should be processed or not depending on the results of a previous draw call.
  • - Measures GPU performance.
+
+ + ff476347 + ID3D11Asynchronous + ID3D11Asynchronous +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the size of the data (in bytes) that is output when calling .

+
+

Size of the data (in bytes) that is output when calling GetData.

+ + ff476348 + unsigned int ID3D11Asynchronous::GetDataSize() + ID3D11Asynchronous::GetDataSize +
+ + +

Get the size of the data (in bytes) that is output when calling .

+
+ + ff476348 + GetDataSize + GetDataSize + unsigned int ID3D11Asynchronous::GetDataSize() +
+ + + Constructs a new based on the specified description. + + The device with which to associate the state object. + The counter description. + The newly created object. + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a counter description.

+
+

Pointer to a counter description (see ).

+ + ff476365 + void ID3D11Counter::GetDesc([Out] D3D11_COUNTER_DESC* pDesc) + ID3D11Counter::GetDesc +
+ + +

Get a counter description.

+
+ + ff476365 + GetDesc + GetDesc + void ID3D11Counter::GetDesc([Out] D3D11_COUNTER_DESC* pDesc) +
+ + + Counter metadata that contains the type, name, units of measure, and a description of an existing counter. + + + + + Gets the data type of a counter (see ). + + The type. + + + + Gets the number of hardware counters that are needed for this counter type to be created. All instances of the same counter type use the same hardware counters. + + The hardware counter count. + + + + Gets a brief name for the counter. + + The name. + + + + Gets the units a counter measures. + + The units. + + + + Gets a description of the counter. + + The description. + + + +

Get the swap chain that the runtime will use for automatically calling .

+
+ +

The swap chain retrieved by this method will only be used if is set in the feature mask.

+
+ + ff476369 + ID3D11Debug + ID3D11Debug +
+ + + Initializes a new instance of the class. + + The device. + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set a bit field of flags that will turn debug features on and off.

+
+

A combination of feature-mask flags that are combined by using a bitwise OR operation. If a flag is present, that feature will be set to on, otherwise the feature will be set to off. For descriptions of the feature-mask flags, see Remarks.

+

This method returns one of the Direct3D 11 Return Codes.

+ +

Setting one of the following feature-mask flags will cause a rendering-operation method (listed below) to do some extra task when called.

(0x2)Application will wait for the GPU to finish processing the rendering operation before continuing.
(0x1)Runtime will additionally call .
(0x4)Runtime will call . Presentation of render buffers will occur according to the settings established by prior calls to and .

?

These feature-mask flags apply to the following rendering-operation methods:

By setting one of the following feature-mask flags, you can control the behavior of the IDXGIDevice2::OfferResources and IDXGIDevice2::ReclaimResources methods to aid in testing and debugging.

Note??These flags are supported by the Direct3D 11.1 runtime, which is available starting with Windows Developer Preview.

D3D11_DEBUG_FEATURE_ALWAYS_DISCARD_OFFERED_RESOURCE (0x8)When you call IDXGIDevice2::OfferResources to offer resources while this flag is enabled, their content is always discarded. Use this flag to test code paths that regenerate resource content on reclaim. You cannot use this flag in combination with D3D11_DEBUG_FEATURE_NEVER_DISCARD_OFFERED_RESOURCE.
D3D11_DEBUG_FEATURE_NEVER_DISCARD_OFFERED_RESOURCE (0x10)When you call IDXGIDevice2::OfferResources to offer resources while this flag is enabled, their content is never discarded. Use this flag to test code paths that do not need to regenerate resource content on reclaim. You cannot use this flag in combination with D3D11_DEBUG_FEATURE_ALWAYS_DISCARD_OFFERED_RESOURCE.

?

The behavior of the IDXGIDevice2::OfferResources and IDXGIDevice2::ReclaimResources methods depends on system-wide memory pressure. Therefore, the scenario where content is lost and must be regenerated is uncommon for most applications. The preceding new options in the Direct3D debug layer let you simulate that scenario consistently and test code paths.

The following flag is supported by the Direct3D 11.1 runtime.

D3D11_DEBUG_FEATURE_AVOID_BEHAVIOR_CHANGING_DEBUG_AIDS (0x40)Disables the following default debugging behavior.

?

When the debug layer is enabled, it performs certain actions to reveal application problems. By setting the D3D11_DEBUG_FEATURE_AVOID_BEHAVIOR_CHANGING_DEBUG_AIDS feature-mask flag, you can enable the debug layer without getting the following default debugging behavior:

  • If an application calls ID3D11DeviceContext1::DiscardView, the runtime fills in the resource with a random color.
  • If an application calls IDXGISwapChain1::Present1 with partial presentation parameters, the runtime ignores the partial presentation information.
+
+ + ff476371 + HRESULT ID3D11Debug::SetFeatureMask([In] unsigned int Mask) + ID3D11Debug::SetFeatureMask +
+ + +

Get a bitfield of flags that indicates which debug features are on or off.

+
+

Mask of feature-mask flags bitwise ORed together. If a flag is present, then that feature will be set to on, otherwise the feature will be set to off. See for a list of possible feature-mask flags.

+ + ff476367 + unsigned int ID3D11Debug::GetFeatureMask() + ID3D11Debug::GetFeatureMask +
+ + +

Set the number of milliseconds to sleep after is called.

+
+ No documentation. +

This method returns one of the following Direct3D 11 Return Codes.

+ +

The application will only sleep if is a set in the feature mask. If that flag is not set the number of milliseconds is set but ignored and the application does not sleep. 10ms is used as a default value if this method is never called.

+
+ + ff476372 + HRESULT ID3D11Debug::SetPresentPerRenderOpDelay([In] unsigned int Milliseconds) + ID3D11Debug::SetPresentPerRenderOpDelay +
+ + +

Get the number of milliseconds to sleep after is called.

+
+

Number of milliseconds to sleep after Present is called.

+ +

Value is set with .

+
+ + ff476368 + unsigned int ID3D11Debug::GetPresentPerRenderOpDelay() + ID3D11Debug::GetPresentPerRenderOpDelay +
+ + +

Set a swap chain that the runtime will use for automatically calling .

+
+ No documentation. +

This method returns one of the following Direct3D 11 Return Codes.

+ +

The swap chain set by this method will only be used if is set in the feature mask.

+
+ + ff476373 + HRESULT ID3D11Debug::SetSwapChain([In, Optional] IDXGISwapChain* pSwapChain) + ID3D11Debug::SetSwapChain +
+ + +

Get the swap chain that the runtime will use for automatically calling .

+
+ No documentation. +

This method returns one of the following Direct3D 11 Return Codes.

+ +

The swap chain retrieved by this method will only be used if is set in the feature mask.

+
+ + ff476369 + HRESULT ID3D11Debug::GetSwapChain([Out] IDXGISwapChain** ppSwapChain) + ID3D11Debug::GetSwapChain +
+ + +

Check to see if the draw pipeline state is valid.

+
+

A reference to the , that represents a device context.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

Use validate prior to calling a draw method (for example, ); validation requires the debug layer.

+
+ + ff476374 + HRESULT ID3D11Debug::ValidateContext([In] ID3D11DeviceContext* pContext) + ID3D11Debug::ValidateContext +
+ + +

Report information about a device object's lifetime.

+
+

A value from the enumeration.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

ReportLiveDeviceObjects uses the value in Flags to determine the amount of information to report about a device object's lifetime.

+
+ + ff476370 + HRESULT ID3D11Debug::ReportLiveDeviceObjects([In] D3D11_RLDO_FLAGS Flags) + ID3D11Debug::ReportLiveDeviceObjects +
+ + +

Verifies whether the dispatch pipeline state is valid.

+
+

A reference to the that represents a device context.

+

This method returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

Use this method before you call a dispatch method (for example, ). Validation requires the debug layer.

+
+ + ff728740 + HRESULT ID3D11Debug::ValidateContextForDispatch([In] ID3D11DeviceContext* pContext) + ID3D11Debug::ValidateContextForDispatch +
+ + + Gets or sets the feature flags that indicates which debug features are on or off. + + The feature flags. + + + +

Get or sets the number of milliseconds to sleep after is called.

+
+ +

Value is set with .

+
+ + ff476368 + GetPresentPerRenderOpDelay / SetPresentPerRenderOpDelay + GetPresentPerRenderOpDelay + unsigned int ID3D11Debug::GetPresentPerRenderOpDelay() +
+ + +

Get or sets the swap chain that the runtime will use for automatically calling .

+
+ +

The swap chain retrieved by this method will only be used if is set in the feature mask.

+
+ + ff476369 + GetSwapChain / SetSwapChain + GetSwapChain + HRESULT ID3D11Debug::GetSwapChain([Out] IDXGISwapChain** ppSwapChain) +
+ + +

The depth-stencil-state interface holds a description for depth-stencil state that you can bind to the output-merger stage.

+
+ +

To create a depth-stencil-state object, call . To bind the depth-stencil-state object to the output-merger stage, call .

+
+ + ff476375 + ID3D11DepthStencilState + ID3D11DepthStencilState +
+ + + Constructs a new based on the specified description. + + The device with which to associate the state object. + The state description. + The newly created object. + ff476506 + HRESULT ID3D11Device::CreateDepthStencilState([In] const D3D11_DEPTH_STENCIL_DESC* pDepthStencilDesc,[Out, Fast] ID3D11DepthStencilState** ppDepthStencilState) + ID3D11Device::CreateDepthStencilState + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the description for depth-stencil state that you used to create the depth-stencil-state object.

+
+

A reference to a structure that receives a description of the depth-stencil state.

+ +

You use the description for depth-stencil state in a call to the method to create the depth-stencil-state object.

+
+ + ff476376 + void ID3D11DepthStencilState::GetDesc([Out] D3D11_DEPTH_STENCIL_DESC* pDesc) + ID3D11DepthStencilState::GetDesc +
+ + +

Gets the description for depth-stencil state that you used to create the depth-stencil-state object.

+
+ +

You use the description for depth-stencil state in a call to the method to create the depth-stencil-state object.

+
+ + ff476376 + GetDesc + GetDesc + void ID3D11DepthStencilState::GetDesc([Out] D3D11_DEPTH_STENCIL_DESC* pDesc) +
+ + +

A depth-stencil-view interface accesses a texture resource during depth-stencil testing.

+
+ +

To create a depth-stencil view, call .

To bind a depth-stencil view to the pipeline, call .

+
+ + ff476377 + ID3D11DepthStencilView + ID3D11DepthStencilView +
+ + +

A view interface specifies the parts of a resource the pipeline can access during rendering.

+
+ +

A view interface is the base interface for all views. There are four types of views; a depth-stencil view, a render-target view, a shader-resource view, and an unordered-access view.

  • To create a render-target view, call .
  • To create a depth-stencil view, call .
  • To create a shader-resource view, call .
  • To create an unordered-access view, call .

All resources must be bound to the pipeline before they can be accessed.

  • To bind a render-target view or a depth-stencil view, call .
  • To bind a shader resource, call .
+
+ + ff476642 + ID3D11View + ID3D11View +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the resource that is accessed through this view.

+
+

Address of a reference to the resource that is accessed through this view. (See .)

+ +

This function increments the reference count of the resource by one, so it is necessary to call Release on the returned reference when the application is done with it. Destroying (or losing) the returned reference before Release is called will result in a memory leak.

+
+ + ff476643 + void ID3D11View::GetResource([Out] void** ppResource) + ID3D11View::GetResource +
+ + +

Get the resource that is accessed through this view.

+
+ +

This function increments the reference count of the resource by one, so it is necessary to call Dispose on the returned reference when the application is done with it. Destroying (or losing) the returned reference before Release is called will result in a memory leak.

+
+ ff476643 + GetResource + GetResource + void ID3D11View::GetResource([Out] ID3D11Resource** ppResource) +
+ + +

Get the resource that is accessed through this view.

+
+ +

This function increments the reference count of the resource by one, so it is necessary to call Release on the returned reference when the application is done with it. Destroying (or losing) the returned reference before Release is called will result in a memory leak.

+
+ ff476643 + GetResource + GetResource + void ID3D11View::GetResource([Out] ID3D11Resource** ppResource) +
+ + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the DepthStencil flag. + ID3D11Device::CreateDepthStencilView + + + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the DepthStencil flag. + A structure describing the to be created. + ID3D11Device::CreateDepthStencilView + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the depth-stencil view.

+
+

Pointer to a depth-stencil-view description (see ).

+ + ff476378 + void ID3D11DepthStencilView::GetDesc([Out] D3D11_DEPTH_STENCIL_VIEW_DESC* pDesc) + ID3D11DepthStencilView::GetDesc +
+ + +

Get the depth-stencil view.

+
+ + ff476378 + GetDesc + GetDesc + void ID3D11DepthStencilView::GetDesc([Out] D3D11_DEPTH_STENCIL_VIEW_DESC* pDesc) +
+ + +

The device interface represents a virtual adapter; it is used to create resources.

+
+ +

A device is created using .

+
+ + ff476379 + ID3D11Device + ID3D11Device +
+ + Constant MultisampleCountMaximum. + D3D11_MAX_MULTISAMPLE_SAMPLE_COUNT + + + + Initializes a new instance of the class. + + + Type of the driver. + + ff476082 + HRESULT D3D11CreateDevice([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[Out, Fast] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDevice + + + + Initializes a new instance of the class. + + + The adapter. + + ff476082 + HRESULT D3D11CreateDevice([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[Out, Fast] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDevice + + + + Constructor for a D3D11 Device. See for more information. + + Type of the driver. + The flags. + ff476082 + HRESULT D3D11CreateDevice([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[Out, Fast] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDevice + + + + Constructor for a D3D11 Device. See for more information. + + + + ff476082 + HRESULT D3D11CreateDevice([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[Out, Fast] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDevice + + + + Constructor for a D3D11 Device. See for more information. + + + + + ff476082 + HRESULT D3D11CreateDevice([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[Out, Fast] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDevice + + + + Constructor for a D3D11 Device. See for more information. + + + + + ff476082 + HRESULT D3D11CreateDevice([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[Out, Fast] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDevice + + + + Initializes a new instance of the class along with a new used for rendering. + + The type of device to create. + A list of runtime layers to enable. + Details used to create the swap chain. + When the method completes, contains the created device instance. + When the method completes, contains the created swap chain instance. + A object describing the result of the operation. + + + + Initializes a new instance of the class along with a new used for rendering. + + The video adapter on which the device should be created. + A list of runtime layers to enable. + Details used to create the swap chain. + When the method completes, contains the created device instance. + When the method completes, contains the created swap chain instance. + A object describing the result of the operation. + + + + Initializes a new instance of the class along with a new used for rendering. + + The type of device to create. + A list of runtime layers to enable. + A list of feature levels which determine the order of feature levels to attempt to create. + Details used to create the swap chain. + When the method completes, contains the created device instance. + When the method completes, contains the created swap chain instance. + A object describing the result of the operation. + + + + Initializes a new instance of the class along with a new used for rendering. + + The video adapter on which the device should be created. + A list of runtime layers to enable. + A list of feature levels which determine the order of feature levels to attempt to create. + Details used to create the swap chain. + When the method completes, contains the created device instance. + When the method completes, contains the created swap chain instance. + A object describing the result of the operation. + + + + This overload has been deprecated. Use one of the alternatives that does not take both an adapter and a driver type. + + + + + Get the type, name, units of measure, and a description of an existing counter. + + The counter description. + Description of the counter + + + + Give a device access to a shared resource created on a different Direct3d device. + + The type of the resource we are gaining access to. + A resource handle. See remarks. + + This method returns a reference to the resource we are gaining access to. + + + To share a resource between two Direct3D 10 devices the resource must have been created with the flag, if it was created using the ID3D10Device interface. If it was created using the IDXGIDevice interface, then the resource is always shared. The REFIID, or GUID, of the interface to the resource can be obtained by using the __uuidof() macro. For example, __uuidof(ID3D10Buffer) will get the GUID of the interface to a buffer resource. When sharing a resource between two Direct3D 10 devices the unique handle of the resource can be obtained by querying the resource for the interface and then calling {{GetSharedHandle}}. + IDXGIResource* pOtherResource(NULL); + hr = pOtherDeviceResource->QueryInterface( __uuidof(IDXGIResource), (void**)&pOtherResource ); + HANDLE sharedHandle; + pOtherResource->GetSharedHandle(&sharedHandle); + The only resources that can be shared are 2D non-mipmapped textures. To share a resource between a Direct3D 9 device and a Direct3D 10 device the texture must have been created using the pSharedHandle argument of {{CreateTexture}}. The shared Direct3D 9 handle is then passed to OpenSharedResource in the hResource argument. The following code illustrates the method calls involved. + sharedHandle = NULL; // must be set to NULL to create, can use a valid handle here to open in D3D9 + pDevice9->CreateTexture(..., pTex2D_9, &sharedHandle); + ... + pDevice10->OpenSharedResource(sharedHandle, __uuidof(ID3D10Resource), (void**)(&tempResource10)); + tempResource10->QueryInterface(__uuidof(ID3D10Texture2D), (void**)(&pTex2D_10)); + tempResource10->Release(); + // now use pTex2D_10 with pDevice10 + Textures being shared from D3D9 to D3D10 have the following restrictions. Textures must be 2D Only 1 mip level is allowed Texture must have default usage Texture must be write only MSAA textures are not allowed Bind flags must have SHADER_RESOURCE and RENDER_TARGET set Only R10G10B10A2_UNORM, R16G16B16A16_FLOAT and R8G8B8A8_UNORM formats are allowed If a shared texture is updated on one device must be called on that device. + + HRESULT ID3D10Device::OpenSharedResource([In] void* hResource,[In] GUID* ReturnedInterface,[Out, Optional] void** ppResource) + + + + Check if this device is supporting compute shaders for the specified format. + + The format for which to check support. + Flags indicating usage contexts in which the specified format is supported. + + + + Check if this device is supporting a feature. + + The feature to check. + + Returns true if this device supports this feature, otherwise false. + + + + + Check if this device is supporting threading. + + Support concurrent resources. + Support command lists. + + A object describing the result of the operation. + + + + + Gets the highest supported hardware feature level of the primary adapter. + + The highest supported hardware feature level. + + + + Gets the highest supported hardware feature level of the primary adapter. + + The adapter. + + The highest supported hardware feature level. + + + + + Internal CreateDevice + + + + + + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Creates a buffer (vertex buffer, index buffer, or shader-constant buffer).

+
+

A reference to a structure that describes the buffer.

+

A reference to a structure that describes the initialization data; use null to allocate space only (with the exception that it cannot be null if the usage flag is ).

+

Address of a reference to the interface for the buffer object created. Set this parameter to null to validate the other input parameters (S_FALSE indicates a pass).

+

This method returns E_OUTOFMEMORY if there is insufficient memory to create the buffer. See Direct3D 11 Return Codes for other possible return values.

+ +

For example code, see How to: Create a Vertex Buffer, How to: Create an Index Buffer or How to: Create a Constant Buffer.

The Direct3D 11.1 runtime, which is available on Windows Developer Preview and later operating systems, provides the following new functionality for CreateBuffer.

You can create a constant buffer that is larger than the maximum constant buffer size that a shader can access (4096 32-bit*4-component constants ? 64KB). When you bind the constant buffer to the pipeline (for example, via PSSetConstantBuffers or PSSetConstantBuffers1), you can define a range of the buffer that the shader can access that fits within the 4096 constant limit.

The runtime will emulate this feature for feature level 9.1, 9.2, and 9.3; therefore, this feature is supported for feature level 9.1, 9.2, and 9.3. This feature is always available on new drivers for feature level 10 and higher. On existing drivers that are implemented to feature level 10 and higher, a call to CreateBuffer to request a constant buffer that is larger than 4096 fails.

+
+ + ff476501 + HRESULT ID3D11Device::CreateBuffer([In] const D3D11_BUFFER_DESC* pDesc,[In, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Buffer** ppBuffer) + ID3D11Device::CreateBuffer +
+ + +

Creates an array of 1D textures.

+
+ No documentation. + No documentation. + No documentation. +

If the method succeeds, the return code is . See Direct3D 11 Return Codes for failing error codes.

+ +

CreateTexture1D creates a 1D texture resource, which can contain a number of 1D subresources. The number of textures is specified in the texture description. All textures in a resource must have the same format, size, and number of mipmap levels.

All resources are made up of one or more subresources. To load data into the texture, applications can supply the data initially as an array of structures pointed to by pInitialData, or they can use one of the D3DX texture functions such as .

For a 32 width texture with a full mipmap chain, the pInitialData array has the following 6 elements: +

  • pInitialData[0] = 32x1
  • pInitialData[1] = 16x1
  • pInitialData[2] = 8x1
  • pInitialData[3] = 4x1 +
  • pInitialData[4] = 2x1 +
  • pInitialData[5] = 1x1 +
+
+ + ff476520 + HRESULT ID3D11Device::CreateTexture1D([In] const D3D11_TEXTURE1D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture1D** ppTexture1D) + ID3D11Device::CreateTexture1D +
+ + +

Create an array of 2D textures.

+
+ No documentation. + No documentation. + No documentation. +

If the method succeeds, the return code is . See Direct3D 11 Return Codes for failing error codes.

+ +

CreateTexture2D creates a 2D texture resource, which can contain a number of 2D subresources. The number of textures is specified in the texture description. All textures in a resource must have the same format, size, and number of mipmap levels.

All resources are made up of one or more subresources. To load data into the texture, applications can supply the data initially as an array of structures pointed to by pInitialData, or it may use one of the D3DX texture functions such as .

For a 32 x 32 texture with a full mipmap chain, the pInitialData array has the following 6 elements: +

  • pInitialData[0] = 32x32
  • pInitialData[1] = 16x16
  • pInitialData[2] = 8x8
  • pInitialData[3] = 4x4 +
  • pInitialData[4] = 2x2 +
  • pInitialData[5] = 1x1 +
+
+ + ff476521 + HRESULT ID3D11Device::CreateTexture2D([In] const D3D11_TEXTURE2D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture2D** ppTexture2D) + ID3D11Device::CreateTexture2D +
+ + +

Create a single 3D texture.

+
+ No documentation. + No documentation. + No documentation. +

If the method succeeds, the return code is . See Direct3D 11 Return Codes for failing error codes.

+ +

CreateTexture3D creates a 3D texture resource, which can contain a number of 3D subresources. The number of textures is specified in the texture description. All textures in a resource must have the same format, size, and number of mipmap levels.

All resources are made up of one or more subresources. To load data into the texture, applications can supply the data initially as an array of structures pointed to by pInitialData, or they can use one of the D3DX texture functions such as .

Each element of pInitialData provides all of the slices that are defined for a given miplevel. For example, for a 32 x 32 x 4 volume texture with a full mipmap chain, the array has the following 6 elements:

  • pInitialData[0] = 32x32 with 4 slices
  • pInitialData[1] = 16x16 with 2 slices
  • pInitialData[2] = 8x8 with 1 slice
  • pInitialData[3] = 4x4 + with 1 slice
  • pInitialData[4] = 2x2 + with 1 slice
  • pInitialData[5] = 1x1 + with 1 slice
+
+ + ff476522 + HRESULT ID3D11Device::CreateTexture3D([In] const D3D11_TEXTURE3D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture3D** ppTexture3D) + ID3D11Device::CreateTexture3D +
+ + +

Create a shader-resource view for accessing data in a resource.

+
+

Pointer to the resource that will serve as input to a shader. This resource must have been created with the flag.

+

Pointer to a shader-resource view description (see ). Set this parameter to null to create a view that accesses the entire resource (using the format the resource was created with).

+

Address of a reference to an . Set this parameter to null to validate the other input parameters (the method will return S_FALSE if the other input parameters pass validation).

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

A resource is made up of one or more subresources; a view identifies which subresources to allow the pipeline to access. In addition, each resource is bound to the pipeline using a view. A shader-resource view is designed to bind any buffer or texture resource to the shader stages using the following API methods: , and .

Because a view is fully typed, this means that typeless resources become fully typed when bound to the pipeline.

Note??To successfully create a shader-resource view from a typeless buffer (for example, ), you must set the flag when you create the buffer.

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, allows you to use CreateShaderResourceView for the following new purpose.

You can create shader-resource views of video resources so that Direct3D shaders can process those shader-resource views. These video resources are either Texture2D or Texture2DArray. The value in the ViewDimension member of the structure for a created shader-resource view must match the type of video resource, D3D11_SRV_DIMENSION_TEXTURE2D for Texture2D and D3D11_SRV_DIMENSION_TEXTURE2DARRAY for Texture2DArray. Additionally, the format of the underlying video resource restricts the formats that the view can use. The video resource format values on the reference page specify the format values that views are restricted to.

The runtime read+write conflict prevention logic (which stops a resource from being bound as an SRV and RTV or UAV at the same time) treats views of different parts of the same video surface as conflicting for simplicity. Therefore, the runtime does not allow an application to read from luma while the application simultaneously renders to chroma in the same surface even though the hardware might allow these simultaneous operations.

+
+ + ff476519 + HRESULT ID3D11Device::CreateShaderResourceView([In] ID3D11Resource* pResource,[In, Optional] const D3D11_SHADER_RESOURCE_VIEW_DESC* pDesc,[Out, Fast] ID3D11ShaderResourceView** ppSRView) + ID3D11Device::CreateShaderResourceView +
+ + +

Creates a view for accessing an unordered access resource.

+
+ No documentation. + No documentation. + No documentation. +

This method returns one of the Direct3D 11 Return Codes.

+ +

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, allows you to use CreateUnorderedAccessView for the following new purpose.

You can create unordered-access views of video resources so that Direct3D shaders can process those unordered-access views. These video resources are either Texture2D or Texture2DArray. The value in the ViewDimension member of the structure for a created unordered-access view must match the type of video resource, for Texture2D and for Texture2DArray. Additionally, the format of the underlying video resource restricts the formats that the view can use. The video resource format values on the reference page specify the format values that views are restricted to.

The runtime read+write conflict prevention logic (which stops a resource from being bound as an SRV and RTV or UAV at the same time) treats views of different parts of the same video surface as conflicting for simplicity. Therefore, the runtime does not allow an application to read from luma while the application simultaneously renders to chroma in the same surface even though the hardware might allow these simultaneous operations.

+
+ + ff476523 + HRESULT ID3D11Device::CreateUnorderedAccessView([In] ID3D11Resource* pResource,[In, Optional] const D3D11_UNORDERED_ACCESS_VIEW_DESC* pDesc,[Out, Fast] ID3D11UnorderedAccessView** ppUAView) + ID3D11Device::CreateUnorderedAccessView +
+ + +

Creates a render-target view for accessing resource data.

+
+

Pointer to a that represents a render target. This resource must have been created with the flag.

+

Pointer to a that represents a render-target view description. Set this parameter to null to create a view that accesses all of the subresources in mipmap level 0.

+

Address of a reference to an . Set this parameter to null to validate the other input parameters (the method will return S_FALSE if the other input parameters pass validation).

+

This method returns one of the Direct3D 11 Return Codes.

+ +

A render-target view can be bound to the output-merger stage by calling .

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, allows you to use CreateRenderTargetView for the following new purpose.

You can create render-target views of video resources so that Direct3D shaders can process those render-target views. These video resources are either Texture2D or Texture2DArray. The value in the ViewDimension member of the structure for a created render-target view must match the type of video resource, for Texture2D and for Texture2DArray. Additionally, the format of the underlying video resource restricts the formats that the view can use. The video resource format values on the reference page specify the format values that views are restricted to.

The runtime read+write conflict prevention logic (which stops a resource from being bound as an SRV and RTV or UAV at the same time) treats views of different parts of the same video surface as conflicting for simplicity. Therefore, the runtime does not allow an application to read from luma while the application simultaneously renders to chroma in the same surface even though the hardware might allow these simultaneous operations.

+
+ + ff476517 + HRESULT ID3D11Device::CreateRenderTargetView([In] ID3D11Resource* pResource,[In, Optional] const D3D11_RENDER_TARGET_VIEW_DESC* pDesc,[Out, Fast] ID3D11RenderTargetView** ppRTView) + ID3D11Device::CreateRenderTargetView +
+ + +

Create a depth-stencil view for accessing resource data.

+
+

Pointer to the resource that will serve as the depth-stencil surface. This resource must have been created with the flag.

+

Pointer to a depth-stencil-view description (see ). Set this parameter to null to create a view that accesses mipmap level 0 of the entire resource (using the format the resource was created with).

+

Address of a reference to an . Set this parameter to null to validate the other input parameters (the method will return S_FALSE if the other input parameters pass validation).

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

A depth-stencil view can be bound to the output-merger stage by calling .

+
+ + ff476507 + HRESULT ID3D11Device::CreateDepthStencilView([In] ID3D11Resource* pResource,[In, Optional] const D3D11_DEPTH_STENCIL_VIEW_DESC* pDesc,[Out, Fast] ID3D11DepthStencilView** ppDepthStencilView) + ID3D11Device::CreateDepthStencilView +
+ + +

Create an input-layout object to describe the input-buffer data for the input-assembler stage.

+
+

An array of the input-assembler stage input data types; each type is described by an element description (see ).

+

The number of input-data types in the array of input-elements.

+

A reference to the compiled shader. The compiled shader code contains a input signature which is validated against the array of elements. See remarks.

+

Size of the compiled shader.

+

A reference to the input-layout object created (see ). To validate the other input parameters, set this reference to be null and verify that the method returns S_FALSE.

+

If the method succeeds, the return code is . See Direct3D 11 Return Codes for failing error codes.

+ +

After creating an input layout object, it must be bound to the input-assembler stage before calling a draw API.

Once an input-layout object is created from a shader signature, the input-layout object can be reused with any other shader that has an identical input signature (semantics included). This can simplify the creation of input-layout objects when you are working with many shaders with identical inputs.

If a data type in the input-layout declaration does not match the data type in a shader-input signature, CreateInputLayout will generate a warning during compilation. The warning is simply to call attention to the fact that the data may be reinterpreted when read from a register. You may either disregard this warning (if reinterpretation is intentional) or make the data types match in both declarations to eliminate the warning.

+
+ + ff476512 + HRESULT ID3D11Device::CreateInputLayout([In, Buffer] const D3D11_INPUT_ELEMENT_DESC* pInputElementDescs,[In] unsigned int NumElements,[In] const void* pShaderBytecodeWithInputSignature,[In] SIZE_T BytecodeLength,[Out, Fast] ID3D11InputLayout** ppInputLayout) + ID3D11Device::CreateInputLayout +
+ + +

Create a vertex-shader object from a compiled shader.

+
+

A reference to the compiled shader.

+

Size of the compiled vertex shader.

+

A reference to a class linkage interface (see ); the value can be null.

+

Address of a reference to a interface. If this is null, all other parameters will be validated, and if all parameters pass validation this API will return S_FALSE instead of .

+

This method returns one of the Direct3D 11 Return Codes.

+ +

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, provides the following new functionality for CreateVertexShader.

The following shader model 5.0 instructions are available to just pixel shaders and compute shaders in the Direct3D 11.0 runtime. For the Direct3D 11.1 runtime, because unordered access views (UAV) are available at all shader stages, you can use these instructions in all shader stages.

Therefore, if you use the following shader model 5.0 instructions in a vertex shader, you can successfully pass the compiled vertex shader to pShaderBytecode. That is, the call to CreateVertexShader succeeds.

If you pass a compiled shader to pShaderBytecode that uses any of the following instructions on a device that doesn?t support UAVs at every shader stage (including existing drivers that are not implemented to support UAVs at every shader stage), CreateVertexShader fails. CreateVertexShader also fails if the shader tries to use a UAV slot beyond the set of UAV slots that the hardware supports.

  • dcl_uav_typed
  • dcl_uav_raw
  • dcl_uav_structured
  • ld_raw
  • ld_structured
  • ld_uav_typed
  • store_raw
  • store_structured
  • store_uav_typed
  • sync_uglobal
  • All atomics and immediate atomics (for example, atomic_and and imm_atomic_and)
+
+ + ff476524 + HRESULT ID3D11Device::CreateVertexShader([In] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In, Optional] ID3D11ClassLinkage* pClassLinkage,[Out, Fast] ID3D11VertexShader** ppVertexShader) + ID3D11Device::CreateVertexShader +
+ + +

Create a geometry shader.

+
+

A reference to the compiled shader.

+

Size of the compiled geometry shader.

+

A reference to a class linkage interface (see ); the value can be null.

+

Address of a reference to a interface. If this is null, all other parameters will be validated, and if all parameters pass validation this API will return S_FALSE instead of .

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

After it is created, the shader can be set to the device by calling .

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, provides the following new functionality for CreateGeometryShader.

The following shader model 5.0 instructions are available to just pixel shaders and compute shaders in the Direct3D 11.0 runtime. For the Direct3D 11.1 runtime, because unordered access views (UAV) are available at all shader stages, you can use these instructions in all shader stages.

Therefore, if you use the following shader model 5.0 instructions in a geometry shader, you can successfully pass the compiled geometry shader to pShaderBytecode. That is, the call to CreateGeometryShader succeeds.

If you pass a compiled shader to pShaderBytecode that uses any of the following instructions on a device that doesn?t support UAVs at every shader stage (including existing drivers that are not implemented to support UAVs at every shader stage), CreateGeometryShader fails. CreateGeometryShader also fails if the shader tries to use a UAV slot beyond the set of UAV slots that the hardware supports.

  • dcl_uav_typed
  • dcl_uav_raw
  • dcl_uav_structured
  • ld_raw
  • ld_structured
  • ld_uav_typed
  • store_raw
  • store_structured
  • store_uav_typed
  • sync_uglobal
  • All atomics and immediate atomics (for example, atomic_and and imm_atomic_and)
+
+ + ff476509 + HRESULT ID3D11Device::CreateGeometryShader([In] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In, Optional] ID3D11ClassLinkage* pClassLinkage,[Out, Fast] ID3D11GeometryShader** ppGeometryShader) + ID3D11Device::CreateGeometryShader +
+ + +

Creates a geometry shader that can write to streaming output buffers.

+
+

A reference to the compiled geometry shader for a standard geometry shader plus stream output. For info on how to get this reference, see Getting a Pointer to a Compiled Shader.

To create the stream output without using a geometry shader, pass a reference to the output signature for the prior stage. To obtain this output signature, call the compiler function. You can also pass a reference to the compiled shader for the prior stage (for example, the vertex-shader stage or domain-shader stage). This compiled shader provides the output signature for the data.

+

Size of the compiled geometry shader.

+

Pointer to a array. Cannot be null if NumEntries > 0.

+

The number of entries in the stream output declaration ( ranges from 0 to D3D11_SO_STREAM_COUNT * D3D11_SO_OUTPUT_COMPONENT_COUNT ).

+

An array of buffer strides; each stride is the size of an element for that buffer.

+

The number of strides (or buffers) in pBufferStrides (ranges from 0 to D3D11_SO_BUFFER_SLOT_COUNT).

+

The index number of the stream to be sent to the rasterizer stage (ranges from 0 to D3D11_SO_STREAM_COUNT - 1). Set to D3D11_SO_NO_RASTERIZED_STREAM if no stream is to be rasterized.

+

A reference to a class linkage interface (see ); the value can be null.

+

Address of a reference to an interface, representing the geometry shader that was created. Set this to null to validate the other parameters; if validation passes, the method will return S_FALSE instead of .

+

This method returns one of the Direct3D 11 Return Codes.

+ +

For more info about using CreateGeometryShaderWithStreamOutput, see Create a Geometry-Shader Object with Stream Output.

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, provides the following new functionality for CreateGeometryShaderWithStreamOutput.

The following shader model 5.0 instructions are available to just pixel shaders and compute shaders in the Direct3D 11.0 runtime. For the Direct3D 11.1 runtime, because unordered access views (UAV) are available at all shader stages, you can use these instructions in all shader stages.

Therefore, if you use the following shader model 5.0 instructions in a geometry shader, you can successfully pass the compiled geometry shader to pShaderBytecode. That is, the call to CreateGeometryShaderWithStreamOutput succeeds.

If you pass a compiled shader to pShaderBytecode that uses any of the following instructions on a device that doesn?t support UAVs at every shader stage (including existing drivers that are not implemented to support UAVs at every shader stage), CreateGeometryShaderWithStreamOutput fails. CreateGeometryShaderWithStreamOutput also fails if the shader tries to use a UAV slot beyond the set of UAV slots that the hardware supports.

  • dcl_uav_typed
  • dcl_uav_raw
  • dcl_uav_structured
  • ld_raw
  • ld_structured
  • ld_uav_typed
  • store_raw
  • store_structured
  • store_uav_typed
  • sync_uglobal
  • All atomics and immediate atomics (for example, atomic_and and imm_atomic_and)
+
+ + ff476510 + HRESULT ID3D11Device::CreateGeometryShaderWithStreamOutput([In] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In, Buffer, Optional] const D3D11_SO_DECLARATION_ENTRY* pSODeclaration,[In] unsigned int NumEntries,[In, Buffer, Optional] const unsigned int* pBufferStrides,[In] unsigned int NumStrides,[In] unsigned int RasterizedStream,[In, Optional] ID3D11ClassLinkage* pClassLinkage,[Out, Fast] ID3D11GeometryShader** ppGeometryShader) + ID3D11Device::CreateGeometryShaderWithStreamOutput +
+ + +

Create a pixel shader.

+
+

A reference to the compiled shader.

+

Size of the compiled pixel shader.

+

A reference to a class linkage interface (see ); the value can be null.

+

Address of a reference to a interface. If this is null, all other parameters will be validated, and if all parameters pass validation this API will return S_FALSE instead of .

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

After creating the pixel shader, you can set it to the device using .

+
+ + ff476513 + HRESULT ID3D11Device::CreatePixelShader([In] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In, Optional] ID3D11ClassLinkage* pClassLinkage,[Out, Fast] ID3D11PixelShader** ppPixelShader) + ID3D11Device::CreatePixelShader +
+ + +

Create a hull shader.

+
+ No documentation. + No documentation. + No documentation. + No documentation. +

This method returns one of the Direct3D 11 Return Codes.

+ +

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, provides the following new functionality for CreateHullShader.

The following shader model 5.0 instructions are available to just pixel shaders and compute shaders in the Direct3D 11.0 runtime. For the Direct3D 11.1 runtime, because unordered access views (UAV) are available at all shader stages, you can use these instructions in all shader stages.

Therefore, if you use the following shader model 5.0 instructions in a hull shader, you can successfully pass the compiled hull shader to pShaderBytecode. That is, the call to CreateHullShader succeeds.

If you pass a compiled shader to pShaderBytecode that uses any of the following instructions on a device that doesn?t support UAVs at every shader stage (including existing drivers that are not implemented to support UAVs at every shader stage), CreateHullShader fails. CreateHullShader also fails if the shader tries to use a UAV slot beyond the set of UAV slots that the hardware supports.

  • dcl_uav_typed
  • dcl_uav_raw
  • dcl_uav_structured
  • ld_raw
  • ld_structured
  • ld_uav_typed
  • store_raw
  • store_structured
  • store_uav_typed
  • sync_uglobal
  • All atomics and immediate atomics (for example, atomic_and and imm_atomic_and)
+
+ + ff476511 + HRESULT ID3D11Device::CreateHullShader([In] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In, Optional] ID3D11ClassLinkage* pClassLinkage,[Out, Fast] ID3D11HullShader** ppHullShader) + ID3D11Device::CreateHullShader +
+ + +

Create a domain shader .

+
+ No documentation. + No documentation. + No documentation. + No documentation. +

This method returns one of the following Direct3D 11 Return Codes.

+ +

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, provides the following new functionality for CreateDomainShader.

The following shader model 5.0 instructions are available to just pixel shaders and compute shaders in the Direct3D 11.0 runtime. For the Direct3D 11.1 runtime, because unordered access views (UAV) are available at all shader stages, you can use these instructions in all shader stages.

Therefore, if you use the following shader model 5.0 instructions in a domain shader, you can successfully pass the compiled domain shader to pShaderBytecode. That is, the call to CreateDomainShader succeeds.

If you pass a compiled shader to pShaderBytecode that uses any of the following instructions on a device that doesn?t support UAVs at every shader stage (including existing drivers that are not implemented to support UAVs at every shader stage), CreateDomainShader fails. CreateDomainShader also fails if the shader tries to use a UAV slot beyond the set of UAV slots that the hardware supports.

  • dcl_uav_typed
  • dcl_uav_raw
  • dcl_uav_structured
  • ld_raw
  • ld_structured
  • ld_uav_typed
  • store_raw
  • store_structured
  • store_uav_typed
  • sync_uglobal
  • All atomics and immediate atomics (for example, atomic_and and imm_atomic_and)
+
+ + ff476508 + HRESULT ID3D11Device::CreateDomainShader([In] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In, Optional] ID3D11ClassLinkage* pClassLinkage,[Out, Fast] ID3D11DomainShader** ppDomainShader) + ID3D11Device::CreateDomainShader +
+ + +

Create a compute shader.

+
+ No documentation. + No documentation. + No documentation. + No documentation. +

This method returns E_OUTOFMEMORY if there is insufficient memory to create the compute shader. See Direct3D 11 Return Codes for other possible return values.

+ +

For an example, see How To: Create a Compute Shader and HDRToneMappingCS11 Sample.

+
+ + ff476503 + HRESULT ID3D11Device::CreateComputeShader([In] const void* pShaderBytecode,[In] SIZE_T BytecodeLength,[In, Optional] ID3D11ClassLinkage* pClassLinkage,[Out, Fast] ID3D11ComputeShader** ppComputeShader) + ID3D11Device::CreateComputeShader +
+ + +

Creates class linkage libraries to enable dynamic shader linkage.

+
+

A reference to a class-linkage interface reference (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

The interface returned in ppLinkage is associated with a shader by passing it as a parameter to one of the create shader methods such as .

+
+ + ff476502 + HRESULT ID3D11Device::CreateClassLinkage([Out, Fast] ID3D11ClassLinkage** ppLinkage) + ID3D11Device::CreateClassLinkage +
+ + +

Create a blend-state object that encapsules blend state for the output-merger stage.

+
+

Pointer to a blend-state description (see ).

+

Address of a reference to the blend-state object created (see ).

+

This method returns E_OUTOFMEMORY if there is insufficient memory to create the blend-state object. See Direct3D 11 Return Codes for other possible return values.

+ +

An application can create up to 4096 unique blend-state objects. For each object created, the runtime checks to see if a previous object has the same state. If such a previous object exists, the runtime will return a reference to previous instance instead of creating a duplicate object.

+
+ + ff476500 + HRESULT ID3D11Device::CreateBlendState([In] const D3D11_BLEND_DESC* pBlendStateDesc,[Out, Fast] ID3D11BlendState** ppBlendState) + ID3D11Device::CreateBlendState +
+ + +

Create a depth-stencil state object that encapsulates depth-stencil test information for the output-merger stage.

+
+

Pointer to a depth-stencil state description (see ).

+

Address of a reference to the depth-stencil state object created (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

4096 unique depth-stencil state objects can be created on a device at a time.

If an application attempts to create a depth-stencil-state interface with the same state as an existing interface, the same interface will be returned and the total number of unique depth-stencil state objects will stay the same.

+
+ + ff476506 + HRESULT ID3D11Device::CreateDepthStencilState([In] const D3D11_DEPTH_STENCIL_DESC* pDepthStencilDesc,[Out, Fast] ID3D11DepthStencilState** ppDepthStencilState) + ID3D11Device::CreateDepthStencilState +
+ + +

Create a rasterizer state object that tells the rasterizer stage how to behave.

+
+

Pointer to a rasterizer state description (see ).

+

Address of a reference to the rasterizer state object created (see ).

+

This method returns E_OUTOFMEMORY if there is insufficient memory to create the compute shader. See Direct3D 11 Return Codes for other possible return values.

+ +

4096 unique rasterizer state objects can be created on a device at a time.

If an application attempts to create a rasterizer-state interface with the same state as an existing interface, the same interface will be returned and the total number of unique rasterizer state objects will stay the same.

+
+ + ff476516 + HRESULT ID3D11Device::CreateRasterizerState([In] const D3D11_RASTERIZER_DESC* pRasterizerDesc,[Out, Fast] ID3D11RasterizerState** ppRasterizerState) + ID3D11Device::CreateRasterizerState +
+ + +

Create a sampler-state object that encapsulates sampling information for a texture.

+
+

Pointer to a sampler state description (see ).

+

Address of a reference to the sampler state object created (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

4096 unique sampler state objects can be created on a device at a time.

If an application attempts to create a sampler-state interface with the same state as an existing interface, the same interface will be returned and the total number of unique sampler state objects will stay the same.

+
+ + ff476518 + HRESULT ID3D11Device::CreateSamplerState([In] const D3D11_SAMPLER_DESC* pSamplerDesc,[Out, Fast] ID3D11SamplerState** ppSamplerState) + ID3D11Device::CreateSamplerState +
+ + +

This interface encapsulates methods for querying information from the GPU.

+
+

Pointer to a query description (see ).

+

Address of a reference to the query object created (see ).

+

This method returns E_OUTOFMEMORY if there is insufficient memory to create the query object. See Direct3D 11 Return Codes for other possible return values.

+ + ff476515 + HRESULT ID3D11Device::CreateQuery([In] const D3D11_QUERY_DESC* pQueryDesc,[Out, Fast] ID3D11Query** ppQuery) + ID3D11Device::CreateQuery +
+ + +

Creates a predicate.

+
+

Pointer to a query description where the type of query must be a or (see ).

+

Address of a reference to a predicate (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476514 + HRESULT ID3D11Device::CreatePredicate([In] const D3D11_QUERY_DESC* pPredicateDesc,[Out, Fast] ID3D11Predicate** ppPredicate) + ID3D11Device::CreatePredicate +
+ + +

Create a counter object for measuring GPU performance.

+
+

Pointer to a counter description (see ).

+

Address of a reference to a counter (see ).

+

If this function succeeds, it will return . If it fails, possible return values are: S_FALSE, E_OUTOFMEMORY, , , or E_INVALIDARG.

is returned whenever the application requests to create a well-known counter, but the current device does not support it.

indicates that another device object is currently using the counters, so they cannot be used by this device at the moment.

E_INVALIDARG is returned whenever an out-of-range well-known or device-dependent counter is requested, or when the simulataneously active counters have been exhausted.

+ + ff476504 + HRESULT ID3D11Device::CreateCounter([In] const D3D11_COUNTER_DESC* pCounterDesc,[Out, Fast] ID3D11Counter** ppCounter) + ID3D11Device::CreateCounter +
+ + +

Creates a deferred context for play back of command lists.

+
+

Reserved for future use. Pass 0.

+

Upon completion of the method, the passed reference to an interface reference is initialized.

+

Returns if successful; otherwise, returns one of the following:

  • Returns if the video card has been physically removed from the system, or a driver upgrade for the video card has occurred. If this error occurs, you should destroy and recreate the device.
  • Returns if the CreateDeferredContext method cannot be called from the current context. For example, if the device was created with the value, CreateDeferredContext returns .
  • Returns E_INVALIDARG if the ContextFlags parameter is invalid.
  • Returns E_OUTOFMEMORY if the application has exhausted available memory.
+ +

A deferred context is a thread-safe context that you can use to record graphics commands on a thread other than the main rendering thread. Using a deferred context, you can record graphics commands into a command list that is encapsulated by the interface. After all scene items are recorded, you can then submit them to the main render thread for final rendering. In this manner, you can perform rendering tasks concurrently across multiple threads and potentially improve performance in multi-core CPU scenarios.

You can create multiple deferred contexts.

Note??If you use the value to create the device that is represented by , the CreateDeferredContext method will fail, and you will not be able to create a deferred context.

For more information about deferred contexts, see Immediate and Deferred Rendering.

+
+ + ff476505 + HRESULT ID3D11Device::CreateDeferredContext([In] unsigned int ContextFlags,[Out, Fast] ID3D11DeviceContext** ppDeferredContext) + ID3D11Device::CreateDeferredContext +
+ + +

Give a device access to a shared resource created on a different device.

+
+

A resource handle. See remarks.

+

The globally unique identifier () for the resource interface. See remarks.

+

Address of a reference to the resource we are gaining access to.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

The REFIID, or , of the interface to the resource can be obtained by using the __uuidof() macro. For example, __uuidof() will get the of the interface to a buffer resource.

The unique handle of the resource is obtained differently depending on the type of device that originally created the resource.

To share a resource between two Direct3D 11 devices the resource must have been created with the flag, if it was created using the interface. If it was created using a DXGI device interface, then the resource is always shared.

The REFIID, or , of the interface to the resource can be obtained by using the __uuidof() macro. For example, __uuidof() will get the of the interface to a buffer resource.

When sharing a resource between two Direct3D 10/11 devices the unique handle of the resource can be obtained by querying the resource for the interface and then calling GetSharedHandle.

 * pOtherResource(null);	
+            hr = pOtherDeviceResource->QueryInterface( __uuidof(), (void**)&pOtherResource );	
+            HANDLE sharedHandle;	
+            pOtherResource->GetSharedHandle(&sharedHandle); 

The only resources that can be shared are 2D non-mipmapped textures.

To share a resource between a Direct3D 9 device and a Direct3D 11 device the texture must have been created using the pSharedHandle argument of CreateTexture. The shared Direct3D 9 handle is then passed to OpenSharedResource in the hResource argument.

The following code illustrates the method calls involved.

 sharedHandle = null; // must be set to null to create, can use a valid handle here to open in D3D9 	
+            pDevice9->CreateTexture(..., pTex2D_9, &sharedHandle); 	
+            ... 	
+            pDevice11->OpenSharedResource(sharedHandle, __uuidof(), (void**)(&tempResource11)); 	
+            tempResource11->QueryInterface(__uuidof(), (void**)(&pTex2D_11)); 	
+            tempResource11->Release(); 	
+            // now use pTex2D_11 with pDevice11    

Textures being shared from D3D9 to D3D11 have the following restrictions.

  • Textures must be 2D
  • Only 1 mip level is allowed
  • Texture must have default usage
  • Texture must be write only
  • MSAA textures are not allowed
  • Bind flags must have SHADER_RESOURCE and RENDER_TARGET set
  • Only R10G10B10A2_UNORM, R16G16B16A16_FLOAT and R8G8B8A8_UNORM formats are allowed

If a shared texture is updated on one device must be called on that device.

+
+ + ff476531 + HRESULT ID3D11Device::OpenSharedResource([In] void* hResource,[In] const GUID& ReturnedInterface,[Out, Optional] void** ppResource) + ID3D11Device::OpenSharedResource +
+ + +

Get the support of a given format on the installed video device.

+
+

A enumeration that describes a format for which to check for support.

+

A bitfield of enumeration values describing how the specified format is supported on the installed device. The values are ORed together.

+ + ff476498 + HRESULT ID3D11Device::CheckFormatSupport([In] DXGI_FORMAT Format,[Out] D3D11_FORMAT_SUPPORT* pFormatSupport) + ID3D11Device::CheckFormatSupport +
+ + +

Get the number of quality levels available during multisampling.

+
+

The texture format. See .

+

The number of samples during multisampling.

+

Number of quality levels supported by the adapter. See remarks.

+ +

When multisampling a texture, the number of quality levels available for an adapter is dependent on the texture format used and the number of samples requested. The maximum number of quality levels is defined by in D3D11.h. If this method returns 0, the format and sample count combination is not supported for the installed adapter.

Furthermore, the definition of a quality level is up to each hardware vendor to define, however no facility is provided by Direct3D to help discover this information.

Note that FEATURE_LEVEL_10_1 devices are required to support 4x MSAA for all render targets except R32G32B32A32 and R32G32B32. FEATURE_LEVEL_11_0 devices are required to support 4x MSAA for all render target formats, and 8x MSAA for all render target formats except R32G32B32A32 formats.

+
+ + ff476499 + HRESULT ID3D11Device::CheckMultisampleQualityLevels([In] DXGI_FORMAT Format,[In] unsigned int SampleCount,[Out] unsigned int* pNumQualityLevels) + ID3D11Device::CheckMultisampleQualityLevels +
+ + +

Get a counter's information.

+
+ + ff476496 + void ID3D11Device::CheckCounterInfo([Out] D3D11_COUNTER_INFO* pCounterInfo) + ID3D11Device::CheckCounterInfo +
+ + +

Get the type, name, units of measure, and a description of an existing counter.

+
+

Pointer to a counter description (see ). Specifies which counter information is to be retrieved about.

+

Pointer to the data type of a counter (see ). Specifies the data type of the counter being retrieved.

+

Pointer to the number of hardware counters that are needed for this counter type to be created. All instances of the same counter type use the same hardware counters.

+

String to be filled with a brief name for the counter. May be null if the application is not interested in the name of the counter.

+

Length of the string returned to szName. Can be null.

+

Name of the units a counter measures, provided the memory the reference points to has enough room to hold the string. Can be null. The returned string will always be in English.

+

Length of the string returned to szUnits. Can be null.

+

A description of the counter, provided the memory the reference points to has enough room to hold the string. Can be null. The returned string will always be in English.

+

Length of the string returned to szDescription. Can be null.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

Length parameters can be null, which indicates the application is not interested in the length nor the corresponding string value. When a length parameter is non-null and the corresponding string is null, the input value of the length parameter is ignored, and the length of the corresponding string (including terminating null) will be returned through the length parameter. When length and the corresponding parameter are both non-null, the input value of length is checked to ensure there is enough room, and then the length of the string (including terminating null character) is passed out through the length parameter.

+
+ + ff476495 + HRESULT ID3D11Device::CheckCounter([In] const D3D11_COUNTER_DESC* pDesc,[Out] D3D11_COUNTER_TYPE* pType,[Out] unsigned int* pActiveCounters,[Out, Buffer, Optional] char* szName,[InOut, Optional] unsigned int* pNameLength,[Out, Buffer, Optional] char* szUnits,[InOut, Optional] unsigned int* pUnitsLength,[Out, Buffer, Optional] char* szDescription,[InOut, Optional] unsigned int* pDescriptionLength) + ID3D11Device::CheckCounter +
+ + +

Gets information about the features that are supported by the current graphics driver.

+
+

A member of the enumerated type that describes which feature to query for support.

+

Upon completion of the method, the passed structure is filled with data that describes the feature support.

+

The size of the structure passed to the pFeatureSupportData parameter.

+

Returns if successful; otherwise, returns E_INVALIDARG if an unsupported data type is passed to the pFeatureSupportData parameter or a size mismatch is detected for the FeatureSupportDataSize parameter.

+ +

To query for multi-threading support, pass the value to the Feature parameter, pass the structure to the pFeatureSupportData parameter, and pass the size of the structure to the FeatureSupportDataSize parameter.

Calling CheckFeatureSupport with Feature set to causes the method to return the same information that would be returned by .

+
+ + ff476497 + HRESULT ID3D11Device::CheckFeatureSupport([In] D3D11_FEATURE Feature,[Out, Buffer] void* pFeatureSupportData,[In] unsigned int FeatureSupportDataSize) + ID3D11Device::CheckFeatureSupport +
+ + +

Get application-defined data from a device.

+
+

Guid associated with the data.

+

A reference to a variable that on input contains the size, in bytes, of the buffer that pData points to, and on output contains the size, in bytes, of the amount of data that GetPrivateData retrieved.

+

A reference to a buffer that GetPrivateData fills with data from the device if pDataSize points to a value that specifies a buffer large enough to hold the data.

+

This method returns one of the codes described in the topic Direct3D 11 Return Codes.

+ + ff476530 + HRESULT ID3D11Device::GetPrivateData([In] const GUID& guid,[InOut] unsigned int* pDataSize,[Out, Buffer, Optional] void* pData) + ID3D11Device::GetPrivateData +
+ + +

Set data to a device and associate that data with a guid.

+
+

Guid associated with the data.

+

Size of the data.

+

Pointer to the data to be stored with this device. If pData is null, DataSize must also be 0, and any data previously associated with the guid will be destroyed.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

The data stored in the device with this method can be retrieved with .

The data and guid set with this method will typically be application-defined.

If an application uses this method to change the device type using GUID_DeviceType, results are undefined. However, GUID_DeviceType can be used to retrieve the device type using .

The debug layer reports memory leaks by outputting a list of object interface references along with their friendly names. The default friendly name is "<unnamed>". You can set the friendly name so that you can determine if the corresponding object interface reference caused the leak. To set the friendly name, use the SetPrivateData method and the that is in D3Dcommon.h. For example, to give pContext a friendly name of My name, use the following code:

 static const char c_szName[] = "My name";	
+            hr = pContext->SetPrivateData( , sizeof( c_szName ) - 1, c_szName );	
+            
+
+ + ff476533 + HRESULT ID3D11Device::SetPrivateData([In] const GUID& guid,[In] unsigned int DataSize,[In, Buffer, Optional] const void* pData) + ID3D11Device::SetPrivateData +
+ + +

Associate an -derived interface with this device child and associate that interface with an application-defined guid.

+
+

Guid associated with the interface.

+

Pointer to an -derived interface to be associated with the device child.

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476534 + HRESULT ID3D11Device::SetPrivateDataInterface([In] const GUID& guid,[In, Optional] const IUnknown* pData) + ID3D11Device::SetPrivateDataInterface +
+ + +

Gets the feature level of the hardware device.

+
+

A member of the enumerated type that describes the feature level of the hardware device.

+ +

Feature levels determine the capabilities of your device.

+
+ + ff476528 + D3D_FEATURE_LEVEL ID3D11Device::GetFeatureLevel() + ID3D11Device::GetFeatureLevel +
+ + +

Get the flags used during the call to create the device with .

+
+

A bitfield containing the flags used to create the device. See .

+ + ff476525 + unsigned int ID3D11Device::GetCreationFlags() + ID3D11Device::GetCreationFlags +
+ + +

Get the reason why the device was removed.

+
+

Possible return values include:

For more detail on these return codes, see DXGI_ERROR.

+ + ff476526 + HRESULT ID3D11Device::GetDeviceRemovedReason() + ID3D11Device::GetDeviceRemovedReason +
+ + +

Gets an immediate context which can record command lists.

+
+

Upon completion of the method, the passed reference to an interface reference is initialized.

+ +

The GetImmediateContext method returns an object that represents an immediate context which is used to perform rendering that you want immediately submitted to a device. For most applications, an immediate context is the primary object that is used to draw your scene.

The GetImmediateContext method increments the reference count of the immediate context by one. Therefore, you must call Release on the returned interface reference when you are done with it to avoid a memory leak.

+
+ + ff476529 + void ID3D11Device::GetImmediateContext([Out] ID3D11DeviceContext** ppImmediateContext) + ID3D11Device::GetImmediateContext +
+ + +

Get the exception-mode flags.

+
+

A value that contains one or more exception flags; each flag specifies a condition which will cause an exception to be raised. The flags are listed in D3D11_RAISE_FLAG. A default value of 0 means there are no flags.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

Set an exception-mode flag to elevate an error condition to a non-continuable exception.

Whenever an error occurs, a Direct3D device enters the DEVICEREMOVED state and if the appropriate exception flag has been set, an exception is raised. A raised exception is designed to terminate an application. Before termination, the last chance an application has to persist data is by using an UnhandledExceptionFilter (see Structured Exception Handling). In general, UnhandledExceptionFilters are leveraged to try to persist data when an application is crashing (to disk, for example). Any code that executes during an UnhandledExceptionFilter is not guaranteed to reliably execute (due to possible process corruption). Any data that the UnhandledExceptionFilter manages to persist, before the UnhandledExceptionFilter crashes again, should be treated as suspect, and therefore inspected by a new, non-corrupted process to see if it is usable.

+
+ + ff476532 + HRESULT ID3D11Device::SetExceptionMode([In] unsigned int RaiseFlags) + ID3D11Device::SetExceptionMode +
+ + +

Get the exception-mode flags.

+
+

A value that contains one or more exception flags; each flag specifies a condition which will cause an exception to be raised. The flags are listed in D3D11_RAISE_FLAG. A default value of 0 means there are no flags.

+ +

An exception-mode flag is used to elevate an error condition to a non-continuable exception.

+
+ + ff476527 + unsigned int ID3D11Device::GetExceptionMode() + ID3D11Device::GetExceptionMode +
+ + + Gets a value indicating whether the current device is using the reference rasterizer. + + + + + Gets or sets the debug-name for this object. + + + The debug name. + + + + +

Gets the feature level of the hardware device.

+
+ +

Feature levels determine the capabilities of your device.

+
+ + ff476528 + GetFeatureLevel + GetFeatureLevel + D3D_FEATURE_LEVEL ID3D11Device::GetFeatureLevel() +
+ + +

Get the flags used during the call to create the device with .

+
+ + ff476525 + GetCreationFlags + GetCreationFlags + unsigned int ID3D11Device::GetCreationFlags() +
+ + +

Get the reason why the device was removed.

+
+ + ff476526 + GetDeviceRemovedReason + GetDeviceRemovedReason + HRESULT ID3D11Device::GetDeviceRemovedReason() +
+ + +

Gets an immediate context which can record command lists.

+
+ +

The GetImmediateContext method returns an object that represents an immediate context which is used to perform rendering that you want immediately submitted to a device. For most applications, an immediate context is the primary object that is used to draw your scene.

The GetImmediateContext method increments the reference count of the immediate context by one. Therefore, you must call Release on the returned interface reference when you are done with it to avoid a memory leak.

+
+ + ff476529 + GetImmediateContext + GetImmediateContext + void ID3D11Device::GetImmediateContext([Out] ID3D11DeviceContext** ppImmediateContext) +
+ + +

Get or sets the exception-mode flags.

+
+ +

An exception-mode flag is used to elevate an error condition to a non-continuable exception.

+
+ + ff476527 + GetExceptionMode / SetExceptionMode + GetExceptionMode + unsigned int ID3D11Device::GetExceptionMode() +
+ + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Set the target output {{buffers}} for the {{StreamOutput}} stage, which enables/disables the pipeline to stream-out data. + + + Call ID3D10Device::SOSetTargets (before any draw calls) to stream data out; call SOSetTargets with NULL to stop streaming data out. For an example, see Exercise 01 from the GDC 2007 workshop, which sets the stream output rendertargets before calling draw methods in the RenderInstanceToStream function. An offset of -1 will cause the stream output buffer to be appended, continuing after the last location written to the buffer in a previous stream output pass. Calling this method using a buffer that is currently bound for writing will effectively bind NULL instead because a buffer cannot be bound as both an input and an output at the same time. The {{DeviceDebug Layer}} will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime. The method will not hold a reference to the interfaces passed in. For that reason, applications should be careful not to release an interface currently in use by the device. + + an array of output buffers (see ) to bind to the device. The buffers must have been created with the flag. + void SOSetTargets([In] int NumBuffers,[In, Buffer, Optional] const ID3D10Buffer** ppSOTargets,[In, Buffer, Optional] const int* pOffsets) + + + + Get the target output {{buffers}} for the {{StreamOutput}} stage of the pipeline. + + + Any returned interfaces will have their reference count incremented by one. Applications should call {{IUnknown::Release}} on the returned interfaces when they are no longer needed to avoid memory leaks. + + Number of buffers to get. A maximum of four output buffers can be retrieved. + an array of output buffers (see ) to bind to the device. + void SOGetTargets([In] int NumBuffers,[Out, Buffer, Optional] ID3D10Buffer** ppSOTargets,[Out, Buffer, Optional] int* pOffsets) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set the target output buffers for the stream-output stage of the pipeline.

+
+

The number of buffer to bind to the device. A maximum of four output buffers can be set. If less than four are defined by the call, the remaining buffer slots are set to null. See Remarks.

+

The array of output buffers (see ) to bind to the device. The buffers must have been created with the flag.

+

Array of offsets to the output buffers from ppSOTargets, one offset for each buffer. The offset values must be in bytes.

+ +

An offset of -1 will cause the stream output buffer to be appended, continuing after the last location written to the buffer in a previous stream output pass.

Calling this method using a buffer that is currently bound for writing will effectively bind null instead because a buffer cannot be bound as both an input and an output at the same time.

The debug layer will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476484 + void ID3D11DeviceContext::SOSetTargets([In] unsigned int NumBuffers,[In, Buffer, Optional] const ID3D11Buffer** ppSOTargets,[In, Buffer, Optional] const unsigned int* pOffsets) + ID3D11DeviceContext::SOSetTargets +
+ + +

Set the target output buffers for the stream-output stage of the pipeline.

+
+

The number of buffer to bind to the device. A maximum of four output buffers can be set. If less than four are defined by the call, the remaining buffer slots are set to null. See Remarks.

+

The array of output buffers (see ) to bind to the device. The buffers must have been created with the flag.

+

Array of offsets to the output buffers from ppSOTargets, one offset for each buffer. The offset values must be in bytes.

+ +

An offset of -1 will cause the stream output buffer to be appended, continuing after the last location written to the buffer in a previous stream output pass.

Calling this method using a buffer that is currently bound for writing will effectively bind null instead because a buffer cannot be bound as both an input and an output at the same time.

The debug layer will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476484 + void ID3D11DeviceContext::SOSetTargets([In] unsigned int NumBuffers,[In, Buffer, Optional] const ID3D11Buffer** ppSOTargets,[In, Buffer, Optional] const unsigned int* pOffsets) + ID3D11DeviceContext::SOSetTargets +
+ + +

Get the target output buffers for the stream-output stage of the pipeline.

+
+

Number of buffers to get.

+

An array of output buffers (see ) to be retrieved from the device.

+ +

A maximum of four output buffers can be retrieved.

The offsets to the output buffers pointed to in the returned ppSOTargets array may be assumed to be -1 (append), as defined for use in .

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476483 + void ID3D11DeviceContext::SOGetTargets([In] unsigned int NumBuffers,[Out, Buffer] ID3D11Buffer** ppSOTargets) + ID3D11DeviceContext::SOGetTargets +
+ + + Common Shader class. Provides a common set of methods for a Shader Stage. + TODO: check if usage of abstract is not introducing an unacceptable overhead... + + Type of the shader + + Functions + + + + + Constant SamplerRegisterComponents. + D3D11_COMMONSHADER_SAMPLER_REGISTER_COMPONENTS + + + Constant SamplerRegisterCount. + D3D11_COMMONSHADER_SAMPLER_REGISTER_COUNT + + + Constant ConstantBufferComponentBitCount. + D3D11_COMMONSHADER_CONSTANT_BUFFER_COMPONENT_BIT_COUNT + + + Constant InputResourceRegisterReadsPerInst. + D3D11_COMMONSHADER_INPUT_RESOURCE_REGISTER_READS_PER_INST + + + Constant TextureCoordRangeReductionMinimum. + D3D11_COMMONSHADER_TEXCOORD_RANGE_REDUCTION_MIN + + + Constant InputResourceSlotCount. + D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT + + + Constant TempRegisterComponents. + D3D11_COMMONSHADER_TEMP_REGISTER_COMPONENTS + + + Constant ImmediateValueComponentBitCount. + D3D11_COMMONSHADER_IMMEDIATE_VALUE_COMPONENT_BIT_COUNT + + + Constant ImmediateConstantBufferRegisterCount. + D3D11_COMMONSHADER_IMMEDIATE_CONSTANT_BUFFER_REGISTER_COUNT + + + Constant TextureElOffsetMaximumPositive. + D3D11_COMMONSHADER_TEXEL_OFFSET_MAX_POSITIVE + + + Constant ConstantBufferComponents. + D3D11_COMMONSHADER_CONSTANT_BUFFER_COMPONENTS + + + Constant TempRegisterReadsPerInst. + D3D11_COMMONSHADER_TEMP_REGISTER_READS_PER_INST + + + Constant SubRoutineNestingLimit. + D3D11_COMMONSHADER_SUBROUTINE_NESTING_LIMIT + + + Constant ImmediateConstantBufferRegisterReadPorts. + D3D11_COMMONSHADER_IMMEDIATE_CONSTANT_BUFFER_REGISTER_READ_PORTS + + + Constant ConstantBufferApiSlotCount. + D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT + + + Constant InputResourceRegisterReadPorts. + D3D11_COMMONSHADER_INPUT_RESOURCE_REGISTER_READ_PORTS + + + Constant ImmediateConstantBufferRegisterReadsPerInst. + D3D11_COMMONSHADER_IMMEDIATE_CONSTANT_BUFFER_REGISTER_READS_PER_INST + + + Constant InputResourceRegisterCount. + D3D11_COMMONSHADER_INPUT_RESOURCE_REGISTER_COUNT + + + Constant ConstantBufferRegisterReadPorts. + D3D11_COMMONSHADER_CONSTANT_BUFFER_REGISTER_READ_PORTS + + + Constant FlowcontrolNestingLimit. + D3D11_COMMONSHADER_FLOWCONTROL_NESTING_LIMIT + + + Constant SamplerRegisterReadsPerInst. + D3D11_COMMONSHADER_SAMPLER_REGISTER_READS_PER_INST + + + Constant TempRegisterComponentBitCount. + D3D11_COMMONSHADER_TEMP_REGISTER_COMPONENT_BIT_COUNT + + + Constant SamplerRegisterReadPorts. + D3D11_COMMONSHADER_SAMPLER_REGISTER_READ_PORTS + + + Constant TextureElOffsetMaximumNegative. + D3D11_COMMONSHADER_TEXEL_OFFSET_MAX_NEGATIVE + + + Constant TextureCoordRangeReductionMaximum. + D3D11_COMMONSHADER_TEXCOORD_RANGE_REDUCTION_MAX + + + Constant TempRegisterCount. + D3D11_COMMONSHADER_TEMP_REGISTER_COUNT + + + Constant ConstantBufferRegisterCount. + D3D11_COMMONSHADER_CONSTANT_BUFFER_REGISTER_COUNT + + + Constant ImmediateConstantBufferRegisterComponents. + D3D11_COMMONSHADER_IMMEDIATE_CONSTANT_BUFFER_REGISTER_COMPONENTS + + + Constant InputResourceRegisterComponents. + D3D11_COMMONSHADER_INPUT_RESOURCE_REGISTER_COMPONENTS + + + Constant TempRegisterReadPorts. + D3D11_COMMONSHADER_TEMP_REGISTER_READ_PORTS + + + Constant ConstantBufferRegisterComponents. + D3D11_COMMONSHADER_CONSTANT_BUFFER_REGISTER_COMPONENTS + + + Constant ConstantBufferHwSlotCount. + D3D11_COMMONSHADER_CONSTANT_BUFFER_HW_SLOT_COUNT + + + Constant SamplerSlotCount. + D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT + + + Constant ConstantBufferRegisterReadsPerInst. + D3D11_COMMONSHADER_CONSTANT_BUFFER_REGISTER_READS_PER_INST + + + + Initializes a new instance of the class. + + The pointer. + + + + Gets the constant buffers used by the shader stage. + + Index into the device's zero-based array from which to begin retrieving constant buffers. + Number of buffers to retrieve. + An array of constant buffers. + + + + Gets the sampler states used by the shader stage. + + Index into the device's zero-based array from which to begin retrieving samplers. + Number of samplers to retrieve. + An array of sampler states. + + + + Gets the shader resources used by the shader stage. + + Index into the device's zero-based array from which to begin retrieving shader resources. + Number of resources to retrieve. + An array of shader resources. + + + + Sets a single constant buffer to be used by the shader stage. + + Index into the device's zero-based array to which to set the constant buffer. + constant buffer to set + + + + Sets an array of constant buffers to be used by the shader stage. + + Index into the device's zero-based array to which to set the array of constant buffers. + An array of constant buffer to set + + + + Sets an array of constant buffers to be used by the shader stage. + + Index into the device's zero-based array to which to set the array of constant buffers. + An array of constant buffer to set + + + + Sets a single sampler to be used by the shader stage. + + Index into the device's zero-based array to which to set the sampler. + sampler state to set + + + + Sets an array of samplers to be used by the shader stage. + + Index into the device's zero-based array to which to set the array of sampler states. + An array of sampler state to set + + + + Sets an array of samplesr to be used by the shader stage. + + Index into the device's zero-based array to which to set the array of sampler states. + An array of sampler state to set + + + + Sets a single shader resource to be used by the shader stage. + + Index into the device's zero-based array to which to set the resource. + Resource view to attach + + + + Bind an array of shader resources to the shader stage. + + + If an overlapping resource view is already bound to an output slot, such as a rendertarget, then this API will fill the destination shader resource slot with NULL.For information about creating shader-resource views, see . The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - 1). + Array of {{shader resource view}} interfaces to set to the device. + + + + Bind an array of shader resources to the shader stage. + + + If an overlapping resource view is already bound to an output slot, such as a rendertarget, then this API will fill the destination shader resource slot with NULL.For information about creating shader-resource views, see . The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - 1). + Array of {{shader resource view}} interfaces to set to the device. + + + + Get the shader resources. + + + Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks. + + Index into the device's zero-based array to begin getting shader resources from (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - 1). + The number of resources to get from the device. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - StartSlot). + Array of {{shader resource view}} interfaces to be returned by the device. + void PSGetShaderResources([In] UINT StartSlot,[In] UINT NumViews,[Out, Buffer] ID3D11ShaderResourceView** ppShaderResourceViews) + + + + Get an array of sampler states from the shader pipeline stage. + + + Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks. + + Index into a zero-based array to begin getting samplers from (ranges from 0 to D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT - 1). + Number of samplers to get from a device context. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT - StartSlot). + Arry of sampler-state interface pointers (see ) to be returned by the device. + void PSGetSamplers([In] UINT StartSlot,[In] UINT NumSamplers,[Out, Buffer] ID3D11SamplerState** ppSamplers) + + + + Get the constant buffers used by the shader pipeline stage. + + + Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks. + + Index into the device's zero-based array to begin retrieving constant buffers from (ranges from 0 to D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT - 1). + Number of buffers to retrieve (ranges from 0 to D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT - StartSlot). + Array of constant buffer interface pointers (see ) to be returned by the method. + void PSGetConstantBuffers([In] UINT StartSlot,[In] UINT NumBuffers,[Out, Buffer] ID3D11Buffer** ppConstantBuffers) + + + + Bind an array of shader resources to the shader stage. + + + If an overlapping resource view is already bound to an output slot, such as a rendertarget, then this API will fill the destination shader resource slot with NULL.For information about creating shader-resource views, see . The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - 1). + Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - StartSlot). + Array of {{shader resource view}} interfaces to set to the device. + void PSSetShaderResources([In] UINT StartSlot,[In] UINT NumViews,[In, Buffer] const ID3D11ShaderResourceView** ppShaderResourceViews) + + + + Bind an array of shader resources to the shader stage. + + + If an overlapping resource view is already bound to an output slot, such as a rendertarget, then this API will fill the destination shader resource slot with NULL.For information about creating shader-resource views, see . The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - 1). + Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - StartSlot). + Array of {{shader resource view}} interfaces to set to the device. + void PSSetShaderResources([In] UINT StartSlot,[In] UINT NumViews,[In, Buffer] const ID3D11ShaderResourceView** ppShaderResourceViews) + + + + Bind an array of shader resources to the shader stage. + + + If an overlapping resource view is already bound to an output slot, such as a rendertarget, then this API will fill the destination shader resource slot with NULL.For information about creating shader-resource views, see . The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - 1). + Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT - StartSlot). + Array of {{shader resource view}} interfaces to set to the device. + void PSSetShaderResources([In] UINT StartSlot,[In] UINT NumViews,[In, Buffer] const ID3D11ShaderResourceView** ppShaderResourceViews) + + + + Set an array of sampler states to the shader pipeline stage. + + + Any sampler may be set to NULL; this invokes the default state, which is defined to be the following.StateDefault ValueFilterD3D11_FILTER_MIN_MAG_MIP_LINEARAddressUD3D11_TEXTURE_ADDRESS_CLAMPAddressVD3D11_TEXTURE_ADDRESS_CLAMPAddressWD3D11_TEXTURE_ADDRESS_CLAMPMipLODBias0MaxAnisotropy1ComparisonFuncD3D11_COMPARISON_NEVERBorderColor[0]1.0fBorderColor[1]1.0fBorderColor[2]1.0fBorderColor[3]1.0fMinLOD-FLT_MAXMaxLODFLT_MAX The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting samplers to (ranges from 0 to D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT - 1). + Number of samplers in the array. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT - StartSlot). + Pointer to an array of sampler-state interfaces (see ). See Remarks. + void PSSetSamplers([In] UINT StartSlot,[In] UINT NumSamplers,[In, Buffer] const ID3D11SamplerState** ppSamplers) + + + + Set an array of sampler states to the shader pipeline stage. + + + Any sampler may be set to NULL; this invokes the default state, which is defined to be the following.StateDefault ValueFilterD3D11_FILTER_MIN_MAG_MIP_LINEARAddressUD3D11_TEXTURE_ADDRESS_CLAMPAddressVD3D11_TEXTURE_ADDRESS_CLAMPAddressWD3D11_TEXTURE_ADDRESS_CLAMPMipLODBias0MaxAnisotropy1ComparisonFuncD3D11_COMPARISON_NEVERBorderColor[0]1.0fBorderColor[1]1.0fBorderColor[2]1.0fBorderColor[3]1.0fMinLOD-FLT_MAXMaxLODFLT_MAX The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting samplers to (ranges from 0 to D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT - 1). + Number of samplers in the array. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT - StartSlot). + Pointer to an array of sampler-state interfaces (see ). See Remarks. + void PSSetSamplers([In] UINT StartSlot,[In] UINT NumSamplers,[In, Buffer] const ID3D11SamplerState** ppSamplers) + + + + Set the constant buffers used by the shader pipeline stage. + + + The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting constant buffers to (ranges from 0 to D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT - 1). + Number of buffers to set (ranges from 0 to D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT - StartSlot). + Array of constant buffers (see ) being given to the device. + void PSSetConstantBuffers([In] UINT StartSlot,[In] UINT NumBuffers,[In, Buffer] const ID3D11Buffer** ppConstantBuffers) + + + + Set the constant buffers used by the shader pipeline stage. + + + The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + Index into the device's zero-based array to begin setting constant buffers to (ranges from 0 to D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT - 1). + Number of buffers to set (ranges from 0 to D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT - StartSlot). + Array of constant buffers (see ) being given to the device. + void PSSetConstantBuffers([In] UINT StartSlot,[In] UINT NumBuffers,[In, Buffer] const ID3D11Buffer** ppConstantBuffers) + + + + Common Shader class. Provides a common set of methods for a Shader Stage. + TODO: check if usage of abstract is not introducing an unacceptable overhead... + + Type of the shader + + + + Initializes a new instance of the class. + + The pointer. + + + + Gets the shader currently assigned to the device. + + The shader (null if no shader is assigned). + + + + Gets the shader currently assigned to the device. + + An array that will be used to contain any class instances currently active. + The shader (null if no shader is assigned). + + + + Assigns a compute shader to the device. + + The shader to assign to the device. Assign null to disable the compute shader. + + + + Assigns a compute shader to the device. + + The shader to assign to the device. Assign null to disable the compute shader. + An array of class-instance interfaces. Each interface used by a shader must have a corresponding class instance or the shader will get disabled. + + + + Assigns a compute shader to the device. + + The shader to assign to the device. Assign null to disable the compute shader. + An array of class-instance interfaces. Each interface used by a shader must have a corresponding class instance or the shader will get disabled. + + + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + Constant UnorderedAccessViewSlotCount. + D3D11_PS_CS_UAV_REGISTER_COUNT + + + Constant DispatchMaximumThreadGroupsPerDimension. + D3D11_CS_DISPATCH_MAX_THREAD_GROUPS_PER_DIMENSION + + + Constant ThreadLocalTempRegisterPool. + D3D11_CS_THREAD_LOCAL_TEMP_REGISTER_POOL + + + Constant ThreadGroupSharedMemoryRegisterCount. + D3D11_CS_TGSM_REGISTER_COUNT + + + Constant ThreadGroupMaximumY. + D3D11_CS_THREAD_GROUP_MAX_Y + + + Constant ThreadGroupSharedMemoryResourceRegisterReadPorts. + D3D11_CS_TGSM_RESOURCE_REGISTER_READ_PORTS + + + Constant ThreadGroupMinimumY. + D3D11_CS_THREAD_GROUP_MIN_Y + + + Constant ThreadGroupSharedMemoryRegisterReadsPerInst. + D3D11_CS_TGSM_REGISTER_READS_PER_INST + + + Constant ThreadGroupMinimumX. + D3D11_CS_THREAD_GROUP_MIN_X + + + Constant ThreadGroupSharedMemoryResourceRegisterComponents. + D3D11_CS_TGSM_RESOURCE_REGISTER_COMPONENTS + + + Constant ThreadGroupMaximumX. + D3D11_CS_THREAD_GROUP_MAX_X + + + Constant ThreadGroupMaximumThreadsPerGroup. + D3D11_CS_THREAD_GROUP_MAX_THREADS_PER_GROUP + + + Constant ThreadGroupMinimumZ. + D3D11_CS_THREAD_GROUP_MIN_Z + + + Constant ThreadGroupMaximumZ. + D3D11_CS_THREAD_GROUP_MAX_Z + + + + Gets an array of views for an unordered resource. + + + Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks. + + Index of the first element in the zero-based array to return (ranges from 0 to D3D11_PS_CS_UAV_REGISTER_COUNT - 1). + Number of views to get (ranges from 0 to D3D11_PS_CS_UAV_REGISTER_COUNT - StartSlot). + void CSGetUnorderedAccessViews([In] int StartSlot,[In] int NumUAVs,[Out, Buffer] ID3D11UnorderedAccessView** ppUnorderedAccessViews) + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an references to be set by the method. + void CSSetUnorderedAccessViews([In] int StartSlot,[In] int NumUAVs,[In, Buffer] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer] const int* pUAVInitialCounts) + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an references to be set by the method. + An Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. uAVInitialCount is only relevant for UAVs which have the flag, otherwise the argument is ignored. + void CSSetUnorderedAccessViews([In] int StartSlot,[In] int NumUAVs,[In, Buffer] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer] const int* pUAVInitialCounts) + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an array of references to be set by the method. + void CSSetUnorderedAccessViews([In] int StartSlot,[In] int NumUAVs,[In, Buffer] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer] const int* pUAVInitialCounts) + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an array of references to be set by the method. + An array of Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. pUAVInitialCounts is only relevant for UAVs which have the flag, otherwise the argument is ignored. + void CSSetUnorderedAccessViews([In] int StartSlot,[In] int NumUAVs,[In, Buffer] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer] const int* pUAVInitialCounts) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Bind an array of shader resources to the compute-shader stage.

+
+

Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to - 1).

+

Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources(ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to set to the device.

+ +

If an overlapping resource view is already bound to an output slot, such as a render target, then the method will fill the destination shader resource slot with null.

For information about creating shader-resource views, see .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. +

+
+ + ff476403 + void ID3D11DeviceContext::CSSetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[In, Buffer] const void** ppShaderResourceViews) + ID3D11DeviceContext::CSSetShaderResources +
+ + +

Sets an array of views for an unordered resource.

+
+

Index of the first element in the zero-based array to begin setting (ranges from 0 to D3D11_1_UAV_SLOT_COUNT - 1). D3D11_1_UAV_SLOT_COUNT is defined as 64.

+

Number of views to set (ranges from 0 to D3D11_1_UAV_SLOT_COUNT - StartSlot).

+

A reference to an array of references to be set by the method.

+

An array of append and consume buffer offsets. A value of -1 indicates to keep the current offset. Any other values set the hidden counter for that appendable and consumable UAV. pUAVInitialCounts is only relevant for UAVs that were created with either or specified when the UAV was created; otherwise, the argument is ignored.

+ + ff476404 + void ID3D11DeviceContext::CSSetUnorderedAccessViews([In] unsigned int StartSlot,[In] unsigned int NumUAVs,[In, Buffer] const void** ppUnorderedAccessViews,[In, Buffer] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::CSSetUnorderedAccessViews +
+ + +

Set a compute shader to the device.

+
+

Pointer to a compute shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476402 + void ID3D11DeviceContext::CSSetShader([In, Optional] ID3D11ComputeShader* pComputeShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::CSSetShader +
+ + +

Set a compute shader to the device.

+
+

Pointer to a compute shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476402 + void ID3D11DeviceContext::CSSetShader([In, Optional] ID3D11ComputeShader* pComputeShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::CSSetShader +
+ + +

Set an array of sampler states to the compute-shader stage.

+
+

Index into the device's zero-based array to begin setting samplers to (ranges from 0 to - 1).

+

Number of samplers in the array. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ). See Remarks.

+ +

Any sampler may be set to null; this invokes the default state, which is defined to be the following.

 //Default sampler state:	
+             SamplerDesc;	
+            SamplerDesc.Filter = ;	
+            SamplerDesc.AddressU = ;	
+            SamplerDesc.AddressV = ;	
+            SamplerDesc.AddressW = ;	
+            SamplerDesc.MipLODBias = 0;	
+            SamplerDesc.MaxAnisotropy = 1;	
+            SamplerDesc.ComparisonFunc = ;	
+            SamplerDesc.BorderColor[0] = 1.0f;	
+            SamplerDesc.BorderColor[1] = 1.0f;	
+            SamplerDesc.BorderColor[2] = 1.0f;	
+            SamplerDesc.BorderColor[3] = 1.0f;	
+            SamplerDesc.MinLOD = -FLT_MAX;	
+            SamplerDesc.MaxLOD = FLT_MAX; 

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476401 + void ID3D11DeviceContext::CSSetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[In, Buffer] const void** ppSamplers) + ID3D11DeviceContext::CSSetSamplers +
+ + +

Sets the constant buffers used by the compute-shader stage.

+
+

Index into the zero-based array to begin setting constant buffers to (ranges from 0 to - 1).

+

Number of buffers to set (ranges from 0 to - StartSlot).

+

Array of constant buffers (see ) being given to the device.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, can bind a larger number of resources to the shader than the maximum constant buffer size that is supported by shaders (4096 constants ? 4*32-bit components each). When you bind such a large buffer, the shader can access only the first 4096 4*32-bit component constants in the buffer, as if 4096 constants is the full size of the buffer.

If the application wants the shader to access other parts of the buffer, it must call the CSSetConstantBuffers1 method instead.

+
+ + ff476400 + void ID3D11DeviceContext::CSSetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void** ppConstantBuffers) + ID3D11DeviceContext::CSSetConstantBuffers +
+ + +

Get the compute-shader resources.

+
+

Index into the device's zero-based array to begin getting shader resources from (ranges from 0 to - 1).

+

The number of resources to get from the device. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476398 + void ID3D11DeviceContext::CSGetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[Out, Buffer] ID3D11ShaderResourceView** ppShaderResourceViews) + ID3D11DeviceContext::CSGetShaderResources +
+ + +

Gets an array of views for an unordered resource.

+
+

Index of the first element in the zero-based array to return (ranges from 0 to - 1).

+

Number of views to get (ranges from 0 to - StartSlot).

+

A reference to an array of interface references (see ) to get.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476399 + void ID3D11DeviceContext::CSGetUnorderedAccessViews([In] unsigned int StartSlot,[In] unsigned int NumUAVs,[Out, Buffer] ID3D11UnorderedAccessView** ppUnorderedAccessViews) + ID3D11DeviceContext::CSGetUnorderedAccessViews +
+ + +

Get the compute shader currently set on the device.

+
+

Address of a reference to a Compute shader (see ) to be returned by the method.

+

Pointer to an array of class instance interfaces (see ).

+

The number of class-instance elements in the array.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476397 + void ID3D11DeviceContext::CSGetShader([Out] ID3D11ComputeShader** ppComputeShader,[Out, Buffer, Optional] ID3D11ClassInstance** ppClassInstances,[InOut] unsigned int* pNumClassInstances) + ID3D11DeviceContext::CSGetShader +
+ + +

Get an array of sampler state interfaces from the compute-shader stage.

+
+

Index into a zero-based array to begin getting samplers from (ranges from 0 to - 1).

+

Number of samplers to get from a device context. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ).

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476396 + void ID3D11DeviceContext::CSGetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[Out, Buffer] ID3D11SamplerState** ppSamplers) + ID3D11DeviceContext::CSGetSamplers +
+ + +

Get the constant buffers used by the compute-shader stage.

+
+

Index into the device's zero-based array to begin retrieving constant buffers from (ranges from 0 to - 1).

+

Number of buffers to retrieve (ranges from 0 to - StartSlot).

+

Array of constant buffer interface references (see ) to be returned by the method.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476395 + void ID3D11DeviceContext::CSGetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[Out, Buffer] ID3D11Buffer** ppConstantBuffers) + ID3D11DeviceContext::CSGetConstantBuffers +
+ + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Constructs a new deferred context . + + The device with which to associate the state object. + The newly created object. + + + + Create a command list and record graphics commands into it. + + A flag indicating whether the immediate context state is saved (prior) and restored (after) the execution of a command list. + The created command list containing the queued rendering commands. + + + + Determines whether asynhronous query data is available. + + The data. + + true if asynhronous query data is available; otherwise, false. + + HRESULT ID3D11DeviceContext::GetData([In] ID3D11Asynchronous* pAsync,[Out, Buffer, Optional] void* pData,[In] unsigned int DataSize,[In] D3D11_ASYNC_GETDATA_FLAG GetDataFlags) + + + + Determines whether asynhronous query data is available. + + The data. + + true if asynhronous query data is available; otherwise, false. + + HRESULT ID3D11DeviceContext::GetData([In] ID3D11Asynchronous* pAsync,[Out, Buffer, Optional] void* pData,[In] unsigned int DataSize,[In] D3D11_ASYNC_GETDATA_FLAG GetDataFlags) + + + + Gets data from the GPU asynchronously. + + The asynchronous data provider. + The data retrieved from the GPU. + + + + Gets data from the GPU asynchronously. + + The asynchronous data provider. + The data retrieved from the GPU. + + + + Gets data from the GPU asynchronously. + + + The asynchronous data provider. + The data retrieved from the GPU. + + True if result contains valid data, false otherwise. + + + + + Gets data from the GPU asynchronously. + + The asynchronous data provider. + Flags specifying how the command should operate. + The data retrieved from the GPU. + + + + Gets data from the GPU asynchronously. + + The asynchronous data provider. + Flags specifying how the command should operate. + The data retrieved from the GPU. + + + + Gets data from the GPU asynchronously. + + + The asynchronous data provider. + Flags specifying how the command should operate. + The data retrieved from the GPU. + + True if result contains valid data, false otherwise. + + + + + Copy the entire contents of the source resource to the destination resource using the GPU. + + + This method is unusual in that it causes the GPU to perform the copy operation (similar to a memcpy by the CPU). As a result, it has a few restrictions designed for improving performance. For instance, the source and destination resources: Must be different resources. Must be the same type. Must have identical dimensions (including width, height, depth, and size as appropriate). Will only be copied. CopyResource does not support any stretch, color key, blend, or format conversions. Must have compatible DXGI formats, which means the formats must be identical or at least from the same type group. For example, a DXGI_FORMAT_R32G32B32_FLOAT texture can be copied to an DXGI_FORMAT_R32G32B32_UINT texture since both of these formats are in the DXGI_FORMAT_R32G32B32_TYPELESS group. Might not be currently mapped. You cannot use an {{Immutable}} resource as a destination. You can use a {{depth-stencil}} resource as either a source or a destination. Resources created with multisampling capability (see ) can be used as source and destination only if both source and destination have identical multisampled count and quality. If source and destination differ in multisampled count and quality or if one is multisampled and the other is not multisampled the call to ID3D11DeviceContext::CopyResource fails. The method is an asynchronous call which may be added to the command-buffer queue. This attempts to remove pipeline stalls that may occur when copying data. An application that only needs to copy a portion of the data in a resource should use instead. + + A reference to the source resource (see ). + A reference to the destination resource (see ). + void ID3D11DeviceContext::CopyResource([In] ID3D11Resource* pDstResource,[In] ID3D11Resource* pSrcResource) + ff476392 + void ID3D11DeviceContext::CopyResource([In] ID3D11Resource* pDstResource,[In] ID3D11Resource* pSrcResource) + ID3D11DeviceContext::CopyResource + + + + Copy a region from a source resource to a destination resource. + + + The source box must be within the size of the source resource. The destination offsets, (x, y, and z) allow the source box to be offset when writing into the destination resource; however, the dimensions of the source box and the offsets must be within the size of the resource. If the resources are buffers, all coordinates are in bytes; if the resources are textures, all coordinates are in texels. {{D3D11CalcSubresource}} is a helper function for calculating subresource indexes. CopySubresourceRegion performs the copy on the GPU (similar to a memcpy by the CPU). As a consequence, the source and destination resources: Must be different subresources (although they can be from the same resource). Must be the same type. Must have compatible DXGI formats (identical or from the same type group). For example, a DXGI_FORMAT_R32G32B32_FLOAT texture can be copied to an DXGI_FORMAT_R32G32B32_UINT texture since both of these formats are in the DXGI_FORMAT_R32G32B32_TYPELESS group. May not be currently mapped. CopySubresourceRegion only supports copy; it does not support any stretch, color key, blend, or format conversions. An application that needs to copy an entire resource should use instead. CopySubresourceRegion is an asynchronous call which may be added to the command-buffer queue, this attempts to remove pipeline stalls that may occur when copying data. See performance considerations for more details. Note??If you use CopySubresourceRegion with a depth-stencil buffer or a multisampled resource, you must copy the whole subresource. In this situation, you must pass 0 to the DstX, DstY, and DstZ parameters and NULL to the pSrcBox parameter. In addition, source and destination resources, which are represented by the pSrcResource and pDstResource parameters, should have identical sample count values. Example The following code snippet copies a box (located at (120,100),(200,220)) from a source texture into a reqion (10,20),(90,140) in a destination texture. + D3D11_BOX sourceRegion; + sourceRegion.left = 120; + sourceRegion.right = 200; + sourceRegion.top = 100; + sourceRegion.bottom = 220; + sourceRegion.front = 0; + sourceRegion.back = 1; pd3dDeviceContext->CopySubresourceRegion( pDestTexture, 0, 10, 20, 0, pSourceTexture, 0, &sourceRegion ); + + Notice, that for a 2D texture, front and back are set to 0 and 1 respectively. + + A reference to the source resource (see ). + Source subresource index. + A reference to a 3D box (see ) that defines the source subresources that can be copied. If NULL, the entire source subresource is copied. The box must fit within the source resource. + A reference to the destination resource (see ). + Destination subresource index. + The x-coordinate of the upper left corner of the destination region. + The y-coordinate of the upper left corner of the destination region. For a 1D subresource, this must be zero. + The z-coordinate of the upper left corner of the destination region. For a 1D or 2D subresource, this must be zero. + ff476394 + void ID3D11DeviceContext::CopySubresourceRegion([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In] unsigned int DstX,[In] unsigned int DstY,[In] unsigned int DstZ,[In] ID3D11Resource* pSrcResource,[In] unsigned int SrcSubresource,[In, Optional] const D3D11_BOX* pSrcBox) + ID3D11DeviceContext::CopySubresourceRegion + + + + Copy a multisampled resource into a non-multisampled resource. + + + This API is most useful when re-using the resulting rendertarget of one render pass as an input to a second render pass. The source and destination resources must be the same resource type and have the same dimensions. In addition, they must have compatible formats. There are three scenarios for this: ScenarioRequirements Source and destination are prestructured and typedBoth the source and destination must have identical formats and that format must be specified in the Format parameter. One resource is prestructured and typed and the other is prestructured and typelessThe typed resource must have a format that is compatible with the typeless resource (i.e. the typed resource is DXGI_FORMAT_R32_FLOAT and the typeless resource is DXGI_FORMAT_R32_TYPELESS). The format of the typed resource must be specified in the Format parameter. Source and destination are prestructured and typelessBoth the source and desintation must have the same typeless format (i.e. both must have DXGI_FORMAT_R32_TYPELESS), and the Format parameter must specify a format that is compatible with the source and destination (i.e. if both are DXGI_FORMAT_R32_TYPELESS then DXGI_FORMAT_R32_FLOAT could be specified in the Format parameter). For example, given the DXGI_FORMAT_R16G16B16A16_TYPELESS format: The source (or dest) format could be DXGI_FORMAT_R16G16B16A16_UNORM The dest (or source) format could be DXGI_FORMAT_R16G16B16A16_FLOAT ? + + Source resource. Must be multisampled. + >The source subresource of the source resource. + Destination resource. Must be a created with the flag and be single-sampled. See . + A zero-based index, that identifies the destination subresource. Use {{D3D11CalcSubresource}} to calculate the index. + A that indicates how the multisampled resource will be resolved to a single-sampled resource. See remarks. + void ID3D11DeviceContext::ResolveSubresource([In] ID3D11Resource* pDstResource,[In] int DstSubresource,[In] ID3D11Resource* pSrcResource,[In] int SrcSubresource,[In] DXGI_FORMAT Format) + + + + Maps the data contained in a subresource to a memory pointer, and denies the GPU access to that subresource. + + The resource. + The mip slice. + The array slice. + The mode. + The flags. + The output stream containing the pointer. + + The locked + + HRESULT ID3D11DeviceContext::Map([In] ID3D11Resource* pResource,[In] unsigned int Subresource,[In] D3D11_MAP MapType,[In] D3D11_MAP_FLAG MapFlags,[Out] D3D11_MAPPED_SUBRESOURCE* pMappedResource) + + + + Maps the data contained in a subresource to a memory pointer, and denies the GPU access to that subresource. + + The resource. + The mip slice. + The array slice. + The mode. + The flags. + The output stream containing the pointer. + + The locked + + HRESULT ID3D11DeviceContext::Map([In] ID3D11Resource* pResource,[In] unsigned int Subresource,[In] D3D11_MAP MapType,[In] D3D11_MAP_FLAG MapFlags,[Out] D3D11_MAPPED_SUBRESOURCE* pMappedResource) + + + + Maps the data contained in a subresource to a memory pointer, and denies the GPU access to that subresource. + + The resource. + The mip slice. + The array slice. + The mode. + The flags. + The output stream containing the pointer. + + The locked + + HRESULT ID3D11DeviceContext::Map([In] ID3D11Resource* pResource,[In] unsigned int Subresource,[In] D3D11_MAP MapType,[In] D3D11_MAP_FLAG MapFlags,[Out] D3D11_MAPPED_SUBRESOURCE* pMappedResource) + + + + Maps the data contained in a subresource to a memory pointer, and denies the GPU access to that subresource. + + The resource. + The mode. + The flags. + The output stream containing the pointer. + + The locked + + HRESULT ID3D11DeviceContext::Map([In] ID3D11Resource* pResource,[In] unsigned int Subresource,[In] D3D11_MAP MapType,[In] D3D11_MAP_FLAG MapFlags,[Out] D3D11_MAPPED_SUBRESOURCE* pMappedResource) + + + + Maps the data contained in a subresource to a memory pointer, and denies the GPU access to that subresource. + + The resource. + The mip slice. + The array slice. + The mode. + The flags. + Size of the selected miplevel. + + The locked + + HRESULT ID3D11DeviceContext::Map([In] ID3D11Resource* pResource,[In] unsigned int Subresource,[In] D3D11_MAP MapType,[In] D3D11_MAP_FLAG MapFlags,[Out] D3D11_MAPPED_SUBRESOURCE* pMappedResource) + + + + Maps the data contained in a subresource to a memory pointer, and denies the GPU access to that subresource. + + The resource. + The subresource. + The mode. + The flags. + The output stream containing the pointer. + The locked + HRESULT ID3D11DeviceContext::Map([In] ID3D11Resource* pResource,[In] unsigned int Subresource,[In] D3D11_MAP MapType,[In] D3D11_MAP_FLAG MapFlags,[Out] D3D11_MAPPED_SUBRESOURCE* pMappedResource) + + + + Copies data from the CPU to to a non-mappable subresource region. + + Type of the data to upload + A reference to the data to upload. + The destination resource. + The destination subresource. + The row pitch. + The depth pitch. + + This method is implementing the workaround for defered context. + + ff476486 + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + ID3D11DeviceContext::UpdateSubresource + + + + Copies data from the CPU to to a non-mappable subresource region. + + Type of the data to upload + A reference to the data to upload. + The destination resource. + The destination subresource. + The row pitch. + The depth pitch. + A region that defines the portion of the destination subresource to copy the resource data into. Coordinates are in bytes for buffers and in texels for textures. + ff476486 + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + ID3D11DeviceContext::UpdateSubresource + This method is implementing the workaround for defered context. + + + + Copies data from the CPU to to a non-mappable subresource region. + + The source data. + The destination resource. + The destination subresource. + + This method is implementing the workaround for defered context. + + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + + + + Copies data from the CPU to to a non-mappable subresource region. + + The source data. + The destination resource. + The destination subresource. + The destination region within the resource. + + This method is implementing the workaround for defered context. + + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + + + + Copies data from the CPU to to a non-mappable subresource region. + + Type of the data to upload + A reference to the data to upload. + The destination resource. + The size in bytes per pixel/block element. + The destination subresource. + The row pitch. + The depth pitch. + if set to true the resource is a block/compressed resource + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + + This method is implementing the workaround for defered context. + + + + + Copies data from the CPU to to a non-mappable subresource region. + + Type of the data to upload + A reference to the data to upload. + The destination resource. + The size in bytes per pixel/block element. + The destination subresource. + The row pitch. + The depth pitch. + if set to true the resource is a block/compressed resource + + This method is implementing the workaround for defered context. + + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + + + + Copies data from the CPU to to a non-mappable subresource region. + + The source data. + The destination resource. + The size in bytes per pixel/block element. + The destination subresource. + if set to true the resource is a block/compressed resource + + This method is implementing the workaround for defered context. + + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + + + + Copies data from the CPU to to a non-mappable subresource region. + + The source data. + The destination resource. + The size in bytes per pixel/block element. + The destination subresource. + The destination region within the resource. + if set to true the resource is a block/compressed resource + + This method is implementing the workaround for defered context. + + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + + + + Updates the subresource safe method. + + The DST resource ref. + The DST subresource. + The DST box ref. + The p SRC data. + The SRC row pitch. + The SRC depth pitch. + The size in bytes per pixel/block element. + if set to true the resource is a block/compressed resource + + + This method is implementing the workaround for defered context. + + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + Update nested inner interfaces pointer + + + +

Draw indexed, non-instanced primitives.

+
+

Number of indices to draw.

+

The location of the first index read by the GPU from the index buffer.

+

A value added to each index before reading a vertex from the vertex buffer.

+ +

A draw API submits work to the rendering pipeline.

If the sum of both indices is negative, the result of the function call is undefined.

+
+ + ff476409 + void ID3D11DeviceContext::DrawIndexed([In] unsigned int IndexCount,[In] unsigned int StartIndexLocation,[In] int BaseVertexLocation) + ID3D11DeviceContext::DrawIndexed +
+ + +

Draw non-indexed, non-instanced primitives.

+
+

Number of vertices to draw.

+

Index of the first vertex, which is usually an offset in a vertex buffer; it could also be used as the first vertex id generated for a shader parameter marked with the SV_TargetId system-value semantic.

+ +

A draw API submits work to the rendering pipeline.

The vertex data for a draw call normally comes from a vertex buffer that is bound to the pipeline. However, you could also provide the vertex data from a shader that has vertex data marked with the SV_VertexId system-value semantic.

+
+ + ff476407 + void ID3D11DeviceContext::Draw([In] unsigned int VertexCount,[In] unsigned int StartVertexLocation) + ID3D11DeviceContext::Draw +
+ + +

Gets a reference to the data contained in a subresource, and denies the GPU access to that subresource.

+
+

A reference to a interface.

+

Index number of the subresource.

+

Specifies the CPU's read and write permissions for a resource. For possible values, see .

+

Flag that specifies what the CPU should do when the GPU is busy. This flag is optional.

+

A reference to the mapped subresource (see ).

+ +

If you call Map on a deferred context, you can only pass , , or both to the MapType parameter. Other -typed values are not supported for a deferred context.

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, can map shader resource views (SRVs) of dynamic buffers with . The Direct3D 11 and earlier runtimes limited mapping to vertex or index buffers.

+
+ + ff476457 + HRESULT ID3D11DeviceContext::Map([In] ID3D11Resource* pResource,[In] unsigned int Subresource,[In] D3D11_MAP MapType,[In] D3D11_MAP_FLAG MapFlags,[Out] D3D11_MAPPED_SUBRESOURCE* pMappedResource) + ID3D11DeviceContext::Map +
+ + +

Invalidate the reference to a resource and re-enable the GPU's access to that resource.

+
+

A reference to a interface.

+

A subresource to be unmapped.

+ + ff476485 + void ID3D11DeviceContext::Unmap([In] ID3D11Resource* pResource,[In] unsigned int Subresource) + ID3D11DeviceContext::Unmap +
+ + +

Draw indexed, instanced primitives.

+
+

Number of indices read from the index buffer for each instance.

+

Number of instances to draw.

+

The location of the first index read by the GPU from the index buffer.

+

A value added to each index before reading a vertex from the vertex buffer.

+

A value added to each index before reading per-instance data from a vertex buffer.

+ +

A draw API submits work to the rendering pipeline.

Instancing may extend performance by reusing the same geometry to draw multiple objects in a scene. One example of instancing could be to draw the same object with different positions and colors. Indexing requires multiple vertex buffers: at least one for per-vertex data and a second buffer for per-instance data.

+
+ + ff476410 + void ID3D11DeviceContext::DrawIndexedInstanced([In] unsigned int IndexCountPerInstance,[In] unsigned int InstanceCount,[In] unsigned int StartIndexLocation,[In] int BaseVertexLocation,[In] unsigned int StartInstanceLocation) + ID3D11DeviceContext::DrawIndexedInstanced +
+ + +

Draw non-indexed, instanced primitives.

+
+

Number of vertices to draw.

+

Number of instances to draw.

+

Index of the first vertex.

+

A value added to each index before reading per-instance data from a vertex buffer.

+ +

A draw API submits work to the rendering pipeline.

Instancing may extend performance by reusing the same geometry to draw multiple objects in a scene. One example of instancing could be to draw the same object with different positions and colors.

The vertex data for an instanced draw call normally comes from a vertex buffer that is bound to the pipeline. However, you could also provide the vertex data from a shader that has instanced data identified with a system-value semantic (SV_InstanceID).

+
+ + ff476412 + void ID3D11DeviceContext::DrawInstanced([In] unsigned int VertexCountPerInstance,[In] unsigned int InstanceCount,[In] unsigned int StartVertexLocation,[In] unsigned int StartInstanceLocation) + ID3D11DeviceContext::DrawInstanced +
+ + +

Mark the beginning of a series of commands.

+
+

A reference to an interface.

+ +

Use to mark the ending of the series of commands.

+
+ + ff476386 + void ID3D11DeviceContext::Begin([In] ID3D11Asynchronous* pAsync) + ID3D11DeviceContext::Begin +
+ + +

Mark the end of a series of commands.

+
+

A reference to an interface.

+ +

Use to mark the beginning of the series of commands.

+
+ + ff476422 + void ID3D11DeviceContext::End([In] ID3D11Asynchronous* pAsync) + ID3D11DeviceContext::End +
+ + +

Get data from the graphics processing unit (GPU) asynchronously.

+
+

A reference to an interface for the object about which GetData retrieves data.

+

Address of memory that will receive the data. If null, GetData will be used only to check status. The type of data output depends on the type of asynchronous interface.

+

Size of the data to retrieve or 0. Must be 0 when pData is null.

+

Optional flags. Can be 0 or any combination of the flags enumerated by .

+

This method returns one of the Direct3D 11 Return Codes. A return value of indicates that the data at pData is available for the calling application to access. A return value of S_FALSE indicates that the data is not yet available. If the data is not yet available, the application must call GetData until the data is available.

+ +

Queries in a deferred context are limited to predicated drawing. That is, you cannot call on a deferred context to get data about a query; you can only call GetData on the immediate context to get data about a query. For predicated drawing, the results of a predication-type query are used by the GPU and not returned to an application. For more information about predication and predicated drawing, see D3D11DeviceContext::SetPredication.

GetData retrieves the data that the runtime collected between calls to and . Certain queries only require a call to in which case the data returned by GetData is accurate up to the last call to . For information about the queries that only require a call to and about the type of data that GetData retrieves for each query, see .

If DataSize is 0, GetData is only used to check status.

An application gathers counter data by calling , issuing some graphics commands, calling , and then calling to get data about what happened in between the Begin and End calls. For information about performance counter types, see . The counter data is of type FLOAT32.

+
+ + ff476428 + HRESULT ID3D11DeviceContext::GetData([In] ID3D11Asynchronous* pAsync,[Out, Buffer, Optional] void* pData,[In] unsigned int DataSize,[In] D3D11_ASYNC_GETDATA_FLAG GetDataFlags) + ID3D11DeviceContext::GetData +
+ + +

Set a rendering predicate.

+
+

Pointer to a predicate (see ). A null value indicates "no" predication; in this case, the value of PredicateValue is irrelevent but will be preserved for .

+

If TRUE, rendering will be affected by when the predicate's conditions are met. If , rendering will be affected when the conditions are not met.

+ +

The predicate must be in the "issued" or "signaled" state to be used for predication. While the predicate is set for predication, calls to and are invalid.

This method is used to denote that subsequent rendering and resource manipulation commands are not actually performed if the resulting Predicate data of the Predicate is equal to the PredicateValue. However, some Predicates are only hints, so they may not actually prevent operations from being performed.

The primary usefulness of Predication is to allow an application to issue graphics commands without taking the performance hit of spinning, waiting for to return. So, Predication can occur while returns S_FALSE. Another way to think of it: an application can also use Predication as a fallback, if it is possible that returns S_FALSE. If returns , the application can skip calling the graphics commands manually with it's own application logic.

+
+ + ff476481 + void ID3D11DeviceContext::SetPredication([In, Optional] ID3D11Predicate* pPredicate,[In] BOOL PredicateValue) + ID3D11DeviceContext::SetPredication +
+ + +

Draw geometry of an unknown size.

+
+ +

A draw API submits work to the rendering pipeline. This API submits work of an unknown size that was processed by the input assembler, vertex shader, and stream-output stages; the work may or may not have gone through the geometry-shader stage.

After data has been streamed out to stream-output stage buffers, those buffers can be again bound to the Input Assembler stage at input slot 0 and DrawAuto will draw them without the application needing to know the amount of data that was written to the buffers. A measurement of the amount of data written to the SO stage buffers is maintained internally when the data is streamed out. This means that the CPU does not need to fetch the measurement before re-binding the data that was streamed as input data. Although this amount is tracked internally, it is still the responsibility of applications to use input layouts to describe the format of the data in the SO stage buffers so that the layouts are available when the buffers are again bound to the input assembler.

The following diagram shows the DrawAuto process.

Calling DrawAuto does not change the state of the streaming-output buffers that were bound again as inputs.

DrawAuto only works when drawing with one input buffer bound as an input to the IA stage at slot 0. Applications must create the SO buffer resource with both binding flags, and .

This API does not support indexing or instancing.

If an application needs to retrieve the size of the streaming-output buffer, it can query for statistics on streaming output by using .

+
+ + ff476408 + void ID3D11DeviceContext::DrawAuto() + ID3D11DeviceContext::DrawAuto +
+ + +

Draw indexed, instanced, GPU-generated primitives.

+
+

A reference to an , which is a buffer containing the GPU generated primitives.

+

Offset in pBufferForArgs to the start of the GPU generated primitives.

+ +

When an application creates a buffer that is associated with the interface that pBufferForArgs points to, the application must set the flag in the MiscFlags member of the structure that describes the buffer. To create the buffer, the application calls the method and in this call passes a reference to in the pDesc parameter.

+
+ + ff476411 + void ID3D11DeviceContext::DrawIndexedInstancedIndirect([In] ID3D11Buffer* pBufferForArgs,[In] unsigned int AlignedByteOffsetForArgs) + ID3D11DeviceContext::DrawIndexedInstancedIndirect +
+ + +

Draw instanced, GPU-generated primitives.

+
+

A reference to an , which is a buffer containing the GPU generated primitives.

+

Offset in pBufferForArgs to the start of the GPU generated primitives.

+ +

When an application creates a buffer that is associated with the interface that pBufferForArgs points to, the application must set the flag in the MiscFlags member of the structure that describes the buffer. To create the buffer, the application calls the method and in this call passes a reference to in the pDesc parameter.

+
+ + ff476413 + void ID3D11DeviceContext::DrawInstancedIndirect([In] ID3D11Buffer* pBufferForArgs,[In] unsigned int AlignedByteOffsetForArgs) + ID3D11DeviceContext::DrawInstancedIndirect +
+ + +

Execute a command list from a thread group.

+
+

The number of groups dispatched in the x direction. ThreadGroupCountX must be less than (65535).

+

The number of groups dispatched in the y direction. ThreadGroupCountY must be less than (65535).

+

The number of groups dispatched in the z direction. ThreadGroupCountZ must be less than (65535). In feature level 10 the value for ThreadGroupCountZ must be 1.

+ +

You call the Dispatch method to execute commands in a compute shader. A compute shader can be run on many threads in parallel, within a thread group. Index a particular thread, within a thread group using a 3D vector given by (x,y,z).

In the following illustration, assume a thread group with 50 threads where the size of the group is given by (5,5,2). A single thread is identified from a thread group with 50 threads in it, using the vector (4,1,1).

The following illustration shows the relationship between the parameters passed to , Dispatch(5,3,2), the values specified in the numthreads attribute, numthreads(10,8,3), and values that will passed to the compute shader for the thread-related system values + (SV_GroupIndex,SV_DispatchThreadID,SV_GroupThreadID,SV_GroupID).

+
+ + ff476405 + void ID3D11DeviceContext::Dispatch([In] unsigned int ThreadGroupCountX,[In] unsigned int ThreadGroupCountY,[In] unsigned int ThreadGroupCountZ) + ID3D11DeviceContext::Dispatch +
+ + +

Execute a command list over one or more thread groups.

+
+

A reference to an , which must be loaded with data that matches the argument list for .

+

A byte-aligned offset between the start of the buffer and the arguments.

+ +

You call the DispatchIndirect method to execute commands in a compute shader.

When an application creates a buffer that is associated with the interface that pBufferForArgs points to, the application must set the flag in the MiscFlags member of the structure that describes the buffer. To create the buffer, the application calls the method and in this call passes a reference to in the pDesc parameter.

+
+ + ff476406 + void ID3D11DeviceContext::DispatchIndirect([In] ID3D11Buffer* pBufferForArgs,[In] unsigned int AlignedByteOffsetForArgs) + ID3D11DeviceContext::DispatchIndirect +
+ + +

Copy a region from a source resource to a destination resource.

+
+

A reference to the destination resource (see ).

+

Destination subresource index.

+

The x-coordinate of the upper left corner of the destination region.

+

The y-coordinate of the upper left corner of the destination region. For a 1D subresource, this must be zero.

+

The z-coordinate of the upper left corner of the destination region. For a 1D or 2D subresource, this must be zero.

+

A reference to the source resource (see ).

+

Source subresource index.

+

A reference to a 3D box (see ) that defines the source subresources that can be copied. If null, the entire source subresource is copied. The box must fit within the source resource.

+ +

The source box must be within the size of the source resource. The destination offsets, (x, y, and z) allow the source box to be offset when writing into the destination resource; however, the dimensions of the source box and the offsets must be within the size of the resource.

If the resources are buffers, all coordinates are in bytes; if the resources are textures, all coordinates are in texels. D3D11CalcSubresource is a helper function for calculating subresource indexes.

CopySubresourceRegion performs the copy on the GPU (similar to a memcpy by the CPU). As a consequence, the source and destination resources:

  • Must be different subresources (although they can be from the same resource).
  • Must be the same type.
  • Must have compatible DXGI formats (identical or from the same type group). For example, a texture can be copied to an texture since both of these formats are in the group.
  • May not be currently mapped.

CopySubresourceRegion only supports copy; it does not support any stretch, color key, blend, or format conversions. An application that needs to copy an entire resource should use instead.

CopySubresourceRegion is an asynchronous call, which may be added to the command-buffer queue, this attempts to remove pipeline stalls that may occur when copying data. For more information about pipeline stalls, see performance considerations.

Note??If you use CopySubresourceRegion with a depth-stencil buffer or a multisampled resource, you must copy the whole subresource. In this situation, you must pass 0 to the DstX, DstY, and DstZ parameters and null to the pSrcBox parameter. In addition, source and destination resources, which are represented by the pSrcResource and pDstResource parameters, should have identical sample count values.

Example

The following code snippet copies a box (located at (120,100),(200,220)) from a source texture into a reqion (10,20),(90,140) in a destination texture.

  sourceRegion;	
+            sourceRegion.left = 120;	
+            sourceRegion.right = 200;	
+            sourceRegion.top = 100;	
+            sourceRegion.bottom = 220;	
+            sourceRegion.front = 0;	
+            sourceRegion.back = 1; pd3dDeviceContext->CopySubresourceRegion( pDestTexture, 0, 10, 20, 0, pSourceTexture, 0, &sourceRegion );	
+            

Notice, that for a 2D texture, front and back are set to 0 and 1 respectively.

+
+ + ff476394 + void ID3D11DeviceContext::CopySubresourceRegion([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In] unsigned int DstX,[In] unsigned int DstY,[In] unsigned int DstZ,[In] ID3D11Resource* pSrcResource,[In] unsigned int SrcSubresource,[In, Optional] const D3D11_BOX* pSrcBox) + ID3D11DeviceContext::CopySubresourceRegion +
+ + +

Copy the entire contents of the source resource to the destination resource using the GPU.

+
+

A reference to the destination resource (see ).

+

A reference to the source resource (see ).

+ +

This method is unusual in that it causes the GPU to perform the copy operation (similar to a memcpy by the CPU). As a result, it has a few restrictions designed for improving performance. For instance, the source and destination resources:

  • Must be different resources.
  • Must be the same type.
  • Must have identical dimensions (including width, height, depth, and size as appropriate).
  • Will only be copied. CopyResource does not support any stretch, color key, blend, or format conversions.
  • Must have compatible DXGI formats, which means the formats must be identical or at least from the same type group. For example, a texture can be copied to an texture since both of these formats are in the group.
  • Might not be currently mapped.

You cannot use an Immutable resource as a destination. You can use a depth-stencil resource as either a source or a destination. Resources created with multisampling capability (see ) can be used as source and destination only if both source and destination have identical multisampled count and quality. If source and destination differ in multisampled count and quality or if one is multisampled and the other is not multisampled the call to fails.

The method is an asynchronous call which may be added to the command-buffer queue. This attempts to remove pipeline stalls that may occur when copying data.

An application that only needs to copy a portion of the data in a resource should use instead.

+
+ + ff476392 + void ID3D11DeviceContext::CopyResource([In] ID3D11Resource* pDstResource,[In] ID3D11Resource* pSrcResource) + ID3D11DeviceContext::CopyResource +
+ + +

The CPU copies data from memory to a subresource created in non-mappable memory.

+
+

A reference to the destination resource (see ).

+

A zero-based index, that identifies the destination subresource. See D3D11CalcSubresource for more details.

+

A reference to a box that defines the portion of the destination subresource to copy the resource data into. Coordinates are in bytes for buffers and in texels for textures. If null, the data is written to the destination subresource with no offset. The dimensions of the source must fit the destination (see ).

+

A reference to the source data in memory.

+

The size of one row of the source data.

+

The size of one depth slice of source data.

+ +

For a shader-constant buffer; set pDstBox to null. It is not possible to use this method to partially update a shader-constant buffer.

A resource cannot be used as a destination if:

  • the resource is created with immutable or dynamic usage.
  • the resource is created as a depth-stencil resource.
  • the resource is created with multisampling capability (see ).

When UpdateSubresource returns, the application is free to change or even free the data pointed to by pSrcData because the method has already copied/snapped away the original contents.

The performance of UpdateSubresource depends on whether or not there is contention for the destination resource. For example, contention for a vertex buffer resource occurs when the application executes a Draw call and later calls UpdateSubresource on the same vertex buffer before the Draw call is actually executed by the GPU.

  • When there is contention for the resource, UpdateSubresource will perform 2 copies of the source data. First, the data is copied by the CPU to a temporary storage space accessible by the command buffer. This copy happens before the method returns. A second copy is then performed by the GPU to copy the source data into non-mappable memory. This second copy happens asynchronously because it is executed by GPU when the command buffer is flushed.
  • When there is no resource contention, the behavior of UpdateSubresource is dependent on which is faster (from the CPU's perspective): copying the data to the command buffer and then having a second copy execute when the command buffer is flushed, or having the CPU copy the data to the final resource location. This is dependent on the architecture of the underlying system.

To better understand the source row pitch and source depth pitch parameters, the following illustration shows a 3D volume texture.

Each block in this visual represents an element of data, and the size of each element is dependent on the resource's format. For example, if the resource format is , the size of each element would be 128 bits, or 16 bytes. This 3D volume texture has a width of two, a height of three, and a depth of four.

To calculate the source row pitch and source depth pitch for a given resource, use the following formulas:

  • Source Row Pitch = [size of one element in bytes] * [number of elements in one row]
  • Source Depth Pitch = [Source Row Pitch] * [number of rows (height)]

In the case of this example 3D volume texture where the size of each element is 16 bytes, the formulas are as follows:

  • Source Row Pitch = 16 * 2 = 32
  • Source Depth Pitch = 16 * 2 * 3 = 96

The following illustration shows the resource as it is laid out in memory.

For example, the following code snippet shows how to specify a destination region in a 2D texture. Assume the destination texture is 512x512 and the operation will copy the data pointed to by pData to [(120,100)..(200,220)] in the destination texture. Also assume that rowPitch has been initialized with the proper value (as explained above). front and back are set to 0 and 1 respectively, because by having front equal to back, the box is technically empty.

  destRegion;	
+            destRegion.left = 120;	
+            destRegion.right = 200;	
+            destRegion.top = 100;	
+            destRegion.bottom = 220;	
+            destRegion.front = 0;	
+            destRegion.back = 1; pd3dDeviceContext->UpdateSubresource( pDestTexture, 0, &destRegion, pData, rowPitch, 0 );	
+            

The 1D case is similar. The following snippet shows how to specify a destination region in a 1D texture. Use the same assumptions as above, except that the texture is 512 in length.

  destRegion;	
+            destRegion.left = 120	
+            destRegion.right = 200;	
+            destRegion.top = 0;	
+            destRegion.bottom = 1;	
+            destRegion.front = 0;	
+            destRegion.back = 1; pd3dDeviceContext->UpdateSubresource( pDestTexture, 0, &destRegion, pData, rowPitch, 0 );	
+            
Calling UpdateSubresource on a Deferred Context

If your application calls UpdateSubresource on a deferred context with a destination box?to which pDstBox points?that has a non-(0,0,0) offset, and if the driver does not support command lists, UpdateSubresource inappropriately applies that destination-box offset to the pSrcData parameter. To work around this behavior, use the following code:

  UpdateSubresource_Workaround(  *pDevice,  *pDeviceContext,  *pDstResource, UINT dstSubresource, const  *pDstBox, const void *pSrcData, UINT srcBytesPerElement, UINT srcRowPitch, UINT srcDepthPitch, bool* pDidWorkAround )	
+            {  hr = ; bool needWorkaround = false;  contextType = pDeviceContext->GetType(); if( pDstBox && ( == contextType) ) {  threadingCaps = { ,  }; hr = pDevice->CheckFeatureSupport( , &threadingCaps, sizeof(threadingCaps) ); if( SUCCEEDED(hr) ) { if( !threadingCaps.DriverCommandLists ) { needWorkaround = true; } } } const void* pAdjustedSrcData = pSrcData; if( needWorkaround ) {  alignedBox = *pDstBox; // convert from pixels to blocks if( m_bBC ) { alignedBox.left     /= 4; alignedBox.right    /= 4; alignedBox.top      /= 4; alignedBox.bottom   /= 4; } pAdjustedSrcData = ((const BYTE*)pSrcData) - (alignedBox.front * srcDepthPitch) - (alignedBox.top * srcRowPitch) - (alignedBox.left * srcBytesPerElement); } pDeviceContext->UpdateSubresource( pDstResource, dstSubresource, pDstBox, pAdjustedSrcData, srcRowPitch, srcDepthPitch ); if( pDidWorkAround ) { *pDidWorkAround = needWorkaround; } return hr;	
+            }	
+            
+
+ + ff476486 + void ID3D11DeviceContext::UpdateSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In, Optional] const D3D11_BOX* pDstBox,[In] const void* pSrcData,[In] unsigned int SrcRowPitch,[In] unsigned int SrcDepthPitch) + ID3D11DeviceContext::UpdateSubresource +
+ + +

Copies data from a buffer holding variable length data.

+
+

Pointer to . This can be any buffer resource that other copy commands, such as or , are able to write to.

+

Offset from the start of pDstBuffer to write 32-bit UINT structure (vertex) count from pSrcView.

+

Pointer to an of a Structured Buffer resource created with either or specified when the UAV was created. These types of resources have hidden counters tracking "how many" records have been written.

+ + ff476393 + void ID3D11DeviceContext::CopyStructureCount([In] ID3D11Buffer* pDstBuffer,[In] unsigned int DstAlignedByteOffset,[In] ID3D11UnorderedAccessView* pSrcView) + ID3D11DeviceContext::CopyStructureCount +
+ + +

Set all the elements in a render target to one value.

+
+

Pointer to the rendertarget.

+

A 4-component array that represents the color to fill the render target with.

+ +

Applications that wish to clear a render target to a specific integer value bit pattern should render a screen-aligned quad instead of using this method. The reason for this is because this method accepts as input a floating point value, which may not have the same bit pattern as the original integer.

Differences between Direct3D 9 and Direct3D 11/10:

Unlike Direct3D 9, the full extent of the resource view is always cleared. Viewport and scissor settings are not applied.

?

+
+ + ff476388 + void ID3D11DeviceContext::ClearRenderTargetView([In] ID3D11RenderTargetView* pRenderTargetView,[In] const SHARPDX_COLOR4* ColorRGBA) + ID3D11DeviceContext::ClearRenderTargetView +
+ + +

Clears an unordered access resource with bit-precise values.

+
+ No documentation. + No documentation. + +

This API copies the lower ni bits from each array element i to the corresponding channel, where ni is the number of bits in the ith channel of the resource format (for example, R8G8B8_FLOAT has 8 bits for the first 3 channels). This works on any UAV with no format conversion. For a raw or structured buffer view, only the first array element value is used.

+
+ + ff476391 + void ID3D11DeviceContext::ClearUnorderedAccessViewUint([In] ID3D11UnorderedAccessView* pUnorderedAccessView,[In] const SHARPDX_INT4* Values) + ID3D11DeviceContext::ClearUnorderedAccessViewUint +
+ + +

Clears an unordered access resource with a float value.

+
+ No documentation. + No documentation. + +

This API works on FLOAT, UNORM, and SNORM unordered access views (UAVs), with format conversion from FLOAT to *NORM where appropriate. On other UAVs, the operation is invalid and the call will not reach the driver.

+
+ + ff476390 + void ID3D11DeviceContext::ClearUnorderedAccessViewFloat([In] ID3D11UnorderedAccessView* pUnorderedAccessView,[In] const SHARPDX_VECTOR4* Values) + ID3D11DeviceContext::ClearUnorderedAccessViewFloat +
+ + +

Clears the depth-stencil resource.

+
+

Pointer to the depth stencil to be cleared.

+

Identify the type of data to clear (see ).

+

Clear the depth buffer with this value. This value will be clamped between 0 and 1.

+

Clear the stencil buffer with this value.

+ +

Differences between Direct3D 9 and Direct3D 11/10:

Unlike Direct3D 9, the full extent of the resource view is always cleared. Viewport and scissor settings are not applied.

?

+
+ + ff476387 + void ID3D11DeviceContext::ClearDepthStencilView([In] ID3D11DepthStencilView* pDepthStencilView,[In] D3D11_CLEAR_FLAG ClearFlags,[In] float Depth,[In] unsigned char Stencil) + ID3D11DeviceContext::ClearDepthStencilView +
+ + +

Generate mipmaps for the given shader resource.

+
+

Pointer to an interface that represents the shader resource.

+ +

GenerateMips may be called on any shader-resource view in order to generate the lower mipmap levels. GenerateMips uses the largest mipmap level of the view to recursively generate the lower levels of the mip, stopping with the smallest level specified by the view. If the base resource was not created with and , this call has no effect.

All video adapters support generating mipmaps if you are using any of the following formats:

 	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            	
+            

Some video adapters support generating mipmaps if you are using this format:

 	
+            

For all other unsupported formats, this method will silently fail.

+
+ + ff476426 + void ID3D11DeviceContext::GenerateMips([In] ID3D11ShaderResourceView* pShaderResourceView) + ID3D11DeviceContext::GenerateMips +
+ + +

Sets the minimum level-of-detail (LOD) for a resource.

+
+

A reference to an that represents the resource.

+

The level-of-detail, which ranges between 0 and the maximum number of mipmap levels of the resource. For example, the maximum number of mipmap levels of a 1D texture is specified in the MipLevels member of the structure.

+ +

To use a resource with SetResourceMinLOD, you must set the flag when you create that resource.

For Direct3D 10 and Direct3D 10.1, when sampling from a texture resource in a shader, the sampler can define a minimum LOD clamp to force sampling from less detailed mip levels. For Direct3D 11, this functionality is extended from the sampler to the entire resource. Therefore, the application can specify the highest-resolution mip level of a resource that is available for access. This restricts the set of mip levels that are required to be resident in GPU memory, thereby saving memory.

The set of mip levels resident per-resource in GPU memory can be specified by the user.

Minimum LOD affects all of the resident mip levels. Therefore, only the resident mip levels can be updated and read from.

All methods that access texture resources must adhere to minimum LOD clamps.

Empty-set accesses are handled as out-of-bounds cases.

+
+ + ff476482 + void ID3D11DeviceContext::SetResourceMinLOD([In] ID3D11Resource* pResource,[In] float MinLOD) + ID3D11DeviceContext::SetResourceMinLOD +
+ + +

Gets the minimum level-of-detail (LOD).

+
+

A reference to an which represents the resource.

+

Returns the minimum LOD.

+ + ff476430 + float ID3D11DeviceContext::GetResourceMinLOD([In] ID3D11Resource* pResource) + ID3D11DeviceContext::GetResourceMinLOD +
+ + +

Copy a multisampled resource into a non-multisampled resource.

+
+

Destination resource. Must be a created with the flag and be single-sampled. See .

+

A zero-based index, that identifies the destination subresource. Use D3D11CalcSubresource to calculate the index.

+

Source resource. Must be multisampled.

+

>The source subresource of the source resource.

+

A that indicates how the multisampled resource will be resolved to a single-sampled resource. See remarks.

+ +

This API is most useful when re-using the resulting rendertarget of one render pass as an input to a second render pass.

The source and destination resources must be the same resource type and have the same dimensions. In addition, they must have compatible formats. There are three scenarios for this:

ScenarioRequirements
Source and destination are prestructured and typedBoth the source and destination must have identical formats and that format must be specified in the Format parameter.
One resource is prestructured and typed and the other is prestructured and typelessThe typed resource must have a format that is compatible with the typeless resource (i.e. the typed resource is and the typeless resource is ). The format of the typed resource must be specified in the Format parameter.
Source and destination are prestructured and typelessBoth the source and desintation must have the same typeless format (i.e. both must have ), and the Format parameter must specify a format that is compatible with the source and destination (i.e. if both are then could be specified in the Format parameter).

For example, given the format:

  • The source (or dest) format could be
  • The dest (or source) format could be

?

+
+ + ff476474 + void ID3D11DeviceContext::ResolveSubresource([In] ID3D11Resource* pDstResource,[In] unsigned int DstSubresource,[In] ID3D11Resource* pSrcResource,[In] unsigned int SrcSubresource,[In] DXGI_FORMAT Format) + ID3D11DeviceContext::ResolveSubresource +
+ + +

Queues commands from a command list onto a device.

+
+

A reference to an interface that encapsulates a command list.

+

A Boolean flag that determines whether the immediate context state is saved prior to and restored after the execution of a command list. Use TRUE to indicate that the runtime needs to save and restore the state. Use to indicate that no state shall be saved or restored, which causes the immediate context to return to its default state after the command list executes. Applications should typically use unless they will restore the state to be nearly equivalent to the state that the runtime would restore if TRUE were passed. When applications use , they can avoid unnecessary and inefficient state transitions.

+ +

Use this method to play back a command list that was recorded by a deferred context on any thread.

This method performs some runtime validation related to queries. Queries that are begun in a device context cannot be manipulated indirectly by executing a command list (that is, Begin or End was invoked against the same query by the deferred context which generated the command list). If such a condition occurs, the ExecuteCommandList method does not execute the command list. However, the state of the device context is still maintained, as would be expected ( is performed, unless the application indicates to preserve the device context state).

+
+ + ff476423 + void ID3D11DeviceContext::ExecuteCommandList([In] ID3D11CommandList* pCommandList,[In] BOOL RestoreContextState) + ID3D11DeviceContext::ExecuteCommandList +
+ + +

Get the rendering predicate state.

+
+

Address of a boolean to fill with the predicate comparison value. upon device creation.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476429 + void ID3D11DeviceContext::GetPredication([Out, Optional] ID3D11Predicate** ppPredicate,[Out, Optional] BOOL* pPredicateValue) + ID3D11DeviceContext::GetPredication +
+ + +

Restore all default settings.

+
+ +

This method resets any device context to the default settings. This sets all input/output resource slots, shaders, input layouts, predications, scissor rectangles, depth-stencil state, rasterizer state, blend state, sampler state, and viewports to null. The primitive topology is set to UNDEFINED.

For a scenario where you would like to clear a list of commands recorded so far, call and throw away the resulting .

+
+ + ff476389 + void ID3D11DeviceContext::ClearState() + ID3D11DeviceContext::ClearState +
+ + +

Sends queued-up commands in the command buffer to the graphics processing unit (GPU).

+
+ +

Most applications don't need to call this method. If an application calls this method when not necessary, it incurs a performance penalty. Each call to Flush incurs a significant amount of overhead.

When Microsoft Direct3D state-setting, present, or draw commands are called by an application, those commands are queued into an internal command buffer. Flush sends those commands to the GPU for processing. Typically, the Direct3D runtime sends these commands to the GPU automatically whenever the runtime determines that they need to be sent, such as when the command buffer is full or when an application maps a resource. Flush sends the commands manually.

We recommend that you use Flush when the CPU waits for an arbitrary amount of time (such as when you call the Sleep function).

Because Flush operates asynchronously, it can return either before or after the GPU finishes executing the queued graphics commands. However, the graphics commands eventually always complete. You can call the method with the value to create an event query; you can then use that event query in a call to the method to determine when the GPU is finished processing the graphics commands. +

Microsoft Direct3D?11 defers the destruction of objects. Therefore, an application can't rely upon objects immediately being destroyed. By calling Flush, you destroy any objects whose destruction was deferred. If an application requires synchronous destruction of an object, we recommend that the application release all its references, call , and then call Flush.

Deferred Destruction Issues with Flip Presentation Swap Chains

Direct3D?11 defers the destruction of objects like views and resources until it can efficiently destroy them. This deferred destruction can cause problems with flip presentation model swap chains. Flip presentation model swap chains have the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL flag set. When you create a flip presentation model swap chain, you can associate only one swap chain at a time with an , IWindow, or composition surface. If an application attempts to destroy a flip presentation model swap chain and replace it with another swap chain, the original swap chain is not destroyed when the application immediately frees all of the original swap chain's references.

Most applications typically use the method for the majority of scenarios where they replace new swap chain buffers for old swap chain buffers. However, if an application must actually destroy an old swap chain and create a new swap chain, the application must force the destruction of all objects that the application freed. To force the destruction, call (or otherwise ensure no views are bound to pipeline state), and then call Flush on the immediate context. You must force destruction before you call IDXGIFactory2::CreateSwapChainForHwnd, IDXGIFactory2::CreateSwapChainForImmersiveWindow, or IDXGIFactory2::CreateSwapChainForCompositionSurface again to create a new swap chain.

+
+ + ff476425 + void ID3D11DeviceContext::Flush() + ID3D11DeviceContext::Flush +
+ + +

Gets the type of device context.

+
+

A member of that indicates the type of device context.

+ + ff476431 + D3D11_DEVICE_CONTEXT_TYPE ID3D11DeviceContext::GetType() + ID3D11DeviceContext::GetType +
+ + +

Gets the initialization flags associated with the current deferred context.

+
+ No documentation. + +

The GetContextFlags method gets the flags that were supplied to the ContextFlags parameter of ; however, the context flag is reserved for future use.

+
+ + ff476427 + unsigned int ID3D11DeviceContext::GetContextFlags() + ID3D11DeviceContext::GetContextFlags +
+ + +

Create a command list and record graphics commands into it.

+
+

A Boolean flag that determines whether the runtime saves deferred context state before it executes FinishCommandList and restores it afterwards. Use TRUE to indicate that the runtime needs to save and restore the state. Use to indicate that the runtime will not save or restore any state. In this case, the deferred context will return to its default state after the call to FinishCommandList completes. For information about default state, see . Typically, use unless you restore the state to be nearly equivalent to the state that the runtime would restore if you passed TRUE. When you use , you can avoid unnecessary and inefficient state transitions.

Note??This parameter does not affect the command list that the current call to FinishCommandList returns. However, this parameter affects the command list of the next call to FinishCommandList on the same deferred context.

+

Upon completion of the method, the passed reference to an interface reference is initialized with the recorded command list information.

+

Returns if successful; otherwise, returns one of the following:

  • Returns if the video card has been physically removed from the system, or a driver upgrade for the video card has occurred. If this error occurs, you should destroy and recreate the device.
  • Returns if FinishCommandList cannot be called from the current context. See remarks.
  • Returns E_OUTOFMEMORY if the application has exhausted available memory.
+ +

Create a command list from a deferred context and record commands into it by calling FinishCommandList. Play back a command list with an immediate context by calling .

Immediate context state is cleared before and after a command list is executed. A command list has no concept of inheritance. Each call to FinishCommandList will record only the state set since any previous call to FinishCommandList.

For example, the state of a device context is its render state or pipeline state. To retrieve device context state, an application can call or .

For more information about how to use FinishCommandList, see How to: Record a Command List.

+
+ + ff476424 + HRESULT ID3D11DeviceContext::FinishCommandList([In] BOOL RestoreDeferredContextState,[Out, Optional] ID3D11CommandList** ppCommandList) + ID3D11DeviceContext::FinishCommandList +
+ + Inner interface giving access to VertexShaderStage methods. + + + Inner interface giving access to PixelShaderStage methods. + + + Inner interface giving access to InputAssemblerStage methods. + + + Inner interface giving access to GeometryShaderStage methods. + + + Inner interface giving access to OutputMergerStage methods. + + + Inner interface giving access to StreamOutputStage methods. + + + Inner interface giving access to RasterizerStage methods. + + + Inner interface giving access to HullShaderStage methods. + + + Inner interface giving access to DomainShaderStage methods. + + + Inner interface giving access to ComputeShaderStage methods. + + + +

Gets the type of device context.

+
+ + ff476431 + GetType + GetType + D3D11_DEVICE_CONTEXT_TYPE ID3D11DeviceContext::GetType() +
+ + +

Gets the initialization flags associated with the current deferred context.

+
+ +

The GetContextFlags method gets the flags that were supplied to the ContextFlags parameter of ; however, the context flag is reserved for future use.

+
+ + ff476427 + GetContextFlags + GetContextFlags + unsigned int ID3D11DeviceContext::GetContextFlags() +
+ + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + Constant IndexInputResourceSlotCount. + D3D11_IA_INDEX_INPUT_RESOURCE_SLOT_COUNT + + + Constant VertexIdBitCount. + D3D11_IA_VERTEX_ID_BIT_COUNT + + + Constant DefaultIndexBufferOffsetInBytes. + D3D11_IA_DEFAULT_INDEX_BUFFER_OFFSET_IN_BYTES + + + Constant DefaultPrimitiveTopology. + D3D11_IA_DEFAULT_PRIMITIVE_TOPOLOGY + + + Constant IntegerArithmeticBitCount. + D3D11_IA_INTEGER_ARITHMETIC_BIT_COUNT + + + Constant VertexInputStructureElementsComponents. + D3D11_IA_VERTEX_INPUT_STRUCTURE_ELEMENTS_COMPONENTS + + + Constant VertexInputStructureElementCount. + D3D11_IA_VERTEX_INPUT_STRUCTURE_ELEMENT_COUNT + + + Constant PatchMaximumControlPointCount. + D3D11_IA_PATCH_MAX_CONTROL_POINT_COUNT + + + Constant DefaultVertexBufferOffsetInBytes. + D3D11_IA_DEFAULT_VERTEX_BUFFER_OFFSET_IN_BYTES + + + Constant InstanceIdBitCount. + D3D11_IA_INSTANCE_ID_BIT_COUNT + + + Constant VertexInputResourceSlotCount. + D3D11_IA_VERTEX_INPUT_RESOURCE_SLOT_COUNT + + + Constant PrimitiveIdBitCount. + D3D11_IA_PRIMITIVE_ID_BIT_COUNT + + + +

Bind a single vertex buffer to the input-assembler stage.

+
+

The first input slot for binding. The first vertex buffer is explicitly bound to the start slot; this causes each additional vertex buffer in the array to be implicitly bound to each subsequent input slot. The maximum of 16 or 32 input slots (ranges from 0 to - 1) are available; the maximum number of input slots depends on the feature level.

+

A . The vertex buffer must have been created with the flag.

/// +

For information about creating vertex buffers, see Create a Vertex Buffer.

Calling this method using a buffer that is currently bound for writing (i.e. bound to the stream output pipeline stage) will effectively bind null instead because a buffer cannot be bound as both an input and an output at the same time.

The debug layer will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ ff476456 + void ID3D11DeviceContext::IASetVertexBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void* ppVertexBuffers,[In, Buffer] const void* pStrides,[In, Buffer] const void* pOffsets) + ID3D11DeviceContext::IASetVertexBuffers +
+ + +

Bind an array of vertex buffers to the input-assembler stage.

+
+

The first input slot for binding. The first vertex buffer is explicitly bound to the start slot; this causes each additional vertex buffer in the array to be implicitly bound to each subsequent input slot. The maximum of 16 or 32 input slots (ranges from 0 to - 1) are available; the maximum number of input slots depends on the feature level.

+

A reference to an array of . The vertex buffers must have been created with the flag.

/// +

For information about creating vertex buffers, see Create a Vertex Buffer.

Calling this method using a buffer that is currently bound for writing (i.e. bound to the stream output pipeline stage) will effectively bind null instead because a buffer cannot be bound as both an input and an output at the same time.

The debug layer will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ ff476456 + void ID3D11DeviceContext::IASetVertexBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void* ppVertexBuffers,[In, Buffer] const void* pStrides,[In, Buffer] const void* pOffsets) + ID3D11DeviceContext::IASetVertexBuffers +
+ + +

Bind an array of vertex buffers to the input-assembler stage.

+
+

The first input slot for binding. The first vertex buffer is explicitly bound to the start slot; this causes each additional vertex buffer in the array to be implicitly bound to each subsequent input slot. The maximum of 16 or 32 input slots (ranges from 0 to - 1) are available; the maximum number of input slots depends on the feature level.

+

A reference to an array of vertex buffers (see ). The vertex buffers must have been created with the flag.

+

Pointer to an array of stride values; one stride value for each buffer in the vertex-buffer array. Each stride is the size (in bytes) of the elements that are to be used from that vertex buffer.

+

Pointer to an array of offset values; one offset value for each buffer in the vertex-buffer array. Each offset is the number of bytes between the first element of a vertex buffer and the first element that will be used.

+ +

For information about creating vertex buffers, see Create a Vertex Buffer.

Calling this method using a buffer that is currently bound for writing (i.e. bound to the stream output pipeline stage) will effectively bind null instead because a buffer cannot be bound as both an input and an output at the same time.

The debug layer will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ ff476456 + void ID3D11DeviceContext::IASetVertexBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void* ppVertexBuffers,[In, Buffer] const void* pStrides,[In, Buffer] const void* pOffsets) + ID3D11DeviceContext::IASetVertexBuffers +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Bind an input-layout object to the input-assembler stage.

+
+

A reference to the input-layout object (see ), which describes the input buffers that will be read by the IA stage.

+ +

Input-layout objects describe how vertex buffer data is streamed into the IA pipeline stage. To create an input-layout object, call .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476454 + void ID3D11DeviceContext::IASetInputLayout([In, Optional] ID3D11InputLayout* pInputLayout) + ID3D11DeviceContext::IASetInputLayout +
+ + +

Bind an array of vertex buffers to the input-assembler stage.

+
+

The first input slot for binding. The first vertex buffer is explicitly bound to the start slot; this causes each additional vertex buffer in the array to be implicitly bound to each subsequent input slot. The maximum of 16 or 32 input slots (ranges from 0 to - 1) are available; the maximum number of input slots depends on the feature level.

+

The number of vertex buffers in the array. The number of buffers (plus the starting slot) cannot exceed the total number of IA-stage input slots (ranges from 0 to - StartSlot).

+

A reference to an array of vertex buffers (see ). The vertex buffers must have been created with the flag.

+

Pointer to an array of stride values; one stride value for each buffer in the vertex-buffer array. Each stride is the size (in bytes) of the elements that are to be used from that vertex buffer.

+

Pointer to an array of offset values; one offset value for each buffer in the vertex-buffer array. Each offset is the number of bytes between the first element of a vertex buffer and the first element that will be used.

+ +

For information about creating vertex buffers, see Create a Vertex Buffer.

Calling this method using a buffer that is currently bound for writing (i.e. bound to the stream output pipeline stage) will effectively bind null instead because a buffer cannot be bound as both an input and an output at the same time.

The debug layer will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476456 + void ID3D11DeviceContext::IASetVertexBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void* ppVertexBuffers,[In, Buffer] const void* pStrides,[In, Buffer] const void* pOffsets) + ID3D11DeviceContext::IASetVertexBuffers +
+ + +

Bind an index buffer to the input-assembler stage.

+
+

A reference to an object, that contains indices. The index buffer must have been created with the flag.

+

A that specifies the format of the data in the index buffer. The only formats allowed for index buffer data are 16-bit () and 32-bit () integers.

+

Offset (in bytes) from the start of the index buffer to the first index to use.

+ +

For information about creating index buffers, see How to: Create an Index Buffer.

Calling this method using a buffer that is currently bound for writing (i.e. bound to the stream output pipeline stage) will effectively bind null instead because a buffer cannot be bound as both an input and an output at the same time.

The debug layer will generate a warning whenever a resource is prevented from being bound simultaneously as an input and an output, but this will not prevent invalid data from being used by the runtime.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476453 + void ID3D11DeviceContext::IASetIndexBuffer([In, Optional] ID3D11Buffer* pIndexBuffer,[In] DXGI_FORMAT Format,[In] unsigned int Offset) + ID3D11DeviceContext::IASetIndexBuffer +
+ + +

Bind information about the primitive type, and data order that describes input data for the input assembler stage.

+
+

The type of primitive and ordering of the primitive data (see D3D11_PRIMITIVE_TOPOLOGY).

+ + ff476455 + void ID3D11DeviceContext::IASetPrimitiveTopology([In] D3D_PRIMITIVE_TOPOLOGY Topology) + ID3D11DeviceContext::IASetPrimitiveTopology +
+ + +

Get a reference to the input-layout object that is bound to the input-assembler stage.

+
+

A reference to the input-layout object (see ), which describes the input buffers that will be read by the IA stage.

+ +

For information about creating an input-layout object, see Creating the Input-Layout Object.

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476450 + void ID3D11DeviceContext::IAGetInputLayout([Out] ID3D11InputLayout** ppInputLayout) + ID3D11DeviceContext::IAGetInputLayout +
+ + +

Get the vertex buffers bound to the input-assembler stage.

+
+

The input slot of the first vertex buffer to get. The first vertex buffer is explicitly bound to the start slot; this causes each additional vertex buffer in the array to be implicitly bound to each subsequent input slot. The maximum of 16 or 32 input slots (ranges from 0 to - 1) are available; the maximum number of input slots depends on the feature level.

+

The number of vertex buffers to get starting at the offset. The number of buffers (plus the starting slot) cannot exceed the total number of IA-stage input slots.

+

A reference to an array of vertex buffers returned by the method (see ).

+

Pointer to an array of stride values returned by the method; one stride value for each buffer in the vertex-buffer array. Each stride value is the size (in bytes) of the elements that are to be used from that vertex buffer.

+

Pointer to an array of offset values returned by the method; one offset value for each buffer in the vertex-buffer array. Each offset is the number of bytes between the first element of a vertex buffer and the first element that will be used.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476452 + void ID3D11DeviceContext::IAGetVertexBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[Out, Buffer, Optional] ID3D11Buffer** ppVertexBuffers,[Out, Buffer, Optional] unsigned int* pStrides,[Out, Buffer, Optional] unsigned int* pOffsets) + ID3D11DeviceContext::IAGetVertexBuffers +
+ + +

Get a reference to the index buffer that is bound to the input-assembler stage.

+
+

A reference to an index buffer returned by the method (see ).

+

Specifies format of the data in the index buffer (see ). These formats provide the size and type of the data in the buffer. The only formats allowed for index buffer data are 16-bit () and 32-bit () integers.

+

Offset (in bytes) from the start of the index buffer, to the first index to use.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476449 + void ID3D11DeviceContext::IAGetIndexBuffer([Out, Optional] ID3D11Buffer** pIndexBuffer,[Out, Optional] DXGI_FORMAT* Format,[Out, Optional] unsigned int* Offset) + ID3D11DeviceContext::IAGetIndexBuffer +
+ + +

Get information about the primitive type, and data order that describes input data for the input assembler stage.

+
+

A reference to the type of primitive, and ordering of the primitive data (see D3D11_PRIMITIVE_TOPOLOGY).

+ + ff476451 + void ID3D11DeviceContext::IAGetPrimitiveTopology([Out] D3D_PRIMITIVE_TOPOLOGY* pTopology) + ID3D11DeviceContext::IAGetPrimitiveTopology +
+ + +

Get or sets a reference to the input-layout object that is bound to the input-assembler stage.

+
+ +

For information about creating an input-layout object, see Creating the Input-Layout Object.

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476450 + IAGetInputLayout / IASetInputLayout + IAGetInputLayout + void ID3D11DeviceContext::IAGetInputLayout([Out] ID3D11InputLayout** ppInputLayout) +
+ + +

Get or sets information about the primitive type, and data order that describes input data for the input assembler stage.

+
+ + ff476451 + IAGetPrimitiveTopology / IASetPrimitiveTopology + IAGetPrimitiveTopology + void ID3D11DeviceContext::IAGetPrimitiveTopology([Out] D3D_PRIMITIVE_TOPOLOGY* pTopology) +
+ + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Get references to the render targets that are available to the {{output-merger stage}}. + + + Any returned interfaces will have their reference count incremented by one. Applications should call {{IUnknown::Release}} on the returned interfaces when they are no longer needed to avoid memory leaks. + + a depth-stencil view (see ) to be filled with the depth-stencil information from the device. + void OMGetRenderTargets([In] int NumViews,[Out, Buffer, Optional] ID3D10RenderTargetView** ppRenderTargetViews,[Out, Optional] ID3D10DepthStencilView** ppDepthStencilView) + + + + Get references to the render targets that are available to the {{output-merger stage}}. + + + Any returned interfaces will have their reference count incremented by one. Applications should call {{IUnknown::Release}} on the returned interfaces when they are no longer needed to avoid memory leaks. + + Number of render targets to retrieve. + an array of render targets views (see ) to be filled with the render targets from the device. + void OMGetRenderTargets([In] int NumViews,[Out, Buffer, Optional] ID3D10RenderTargetView** ppRenderTargetViews,[Out, Optional] ID3D10DepthStencilView** ppDepthStencilView) + + + + Get references to the render targets and the depth-stencil buffer that are available to the {{output-merger stage}}. + + + Any returned interfaces will have their reference count incremented by one. Applications should call {{IUnknown::Release}} on the returned interfaces when they are no longer needed to avoid memory leaks. + + Number of render targets to retrieve. + Pointer to a depth-stencil view (see ) to be filled with the depth-stencil information from the device. + an array of render targets views (see ) to be filled with the render targets from the device. + void OMGetRenderTargets([In] int NumViews,[Out, Buffer, Optional] ID3D10RenderTargetView** ppRenderTargetViews,[Out, Optional] ID3D10DepthStencilView** ppDepthStencilView) + + + + Get the {{blend state}} of the output-merger stage. + + + The reference count of the returned interface will be incremented by one when the blend state is retrieved. Applications must release returned reference(s) when they are no longer needed, or else there will be a memory leak. + + Array of blend factors, one for each RGBA component. + Pointer to a {{sample mask}}. + a reference to a blend-state interface (see ). + void OMGetBlendState([Out, Optional] ID3D10BlendState** ppBlendState,[Out, Optional] float BlendFactor[4],[Out, Optional] int* pSampleMask) + + + + Gets the {{depth-stencil}} state of the output-merger stage. + + + Any returned interfaces will have their reference count incremented by one. Applications should call {{IUnknown::Release}} on the returned interfaces when they are no longer needed to avoid memory leaks. + + Pointer to the stencil reference value used in the {{depth-stencil}} test. + a reference to a depth-stencil state interface (see ) to be filled with information from the device. + void OMGetDepthStencilState([Out, Optional] ID3D10DepthStencilState** ppDepthStencilState,[Out, Optional] int* pStencilRef) + + + + Gets an array of views for an unordered resource. + + + Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks. + + Index of the first element in the zero-based array to return (ranges from 0 to D3D11_PS_CS_UAV_REGISTER_COUNT - 1). + Number of views to get (ranges from 0 to D3D11_PS_CS_UAV_REGISTER_COUNT - StartSlot). + void OMGetRenderTargetsAndUnorderedAccessViews([In] int NumRTVs,[Out, Buffer, Optional] ID3D11RenderTargetView** ppRenderTargetViews,[Out, Optional] ID3D11DepthStencilView** ppDepthStencilView,[In] int UAVStartSlot,[In] int NumUAVs,[Out, Buffer, Optional] ID3D11UnorderedAccessView** ppUnorderedAccessViews) + + + + Unbinds all depth-stencil buffer and render targets from the output-merger stage. + + ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets + + + +

Bind one or more render targets atomically and the depth-stencil buffer to the output-merger stage.

+
+ A set of render target views to bind. + +

The maximum number of active render targets a device can have active at any given time is set by a #define in D3D11.h called D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT. It is invalid to try to set the same subresource to multiple render target slots. Any render targets not defined by this call are set to null.

If any subresources are also currently bound for reading in a different stage or writing (perhaps in a different part of the pipeline), those bind points will be set to null, in order to prevent the same subresource from being read and written simultaneously in a single rendering operation.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

If the render-target views were created from an array resource type, then all of the render-target views must have the same array size. This restriction also applies to the depth-stencil view, its array size must match that of the render-target views being bound.

The pixel shader must be able to simultaneously render to at least eight separate render targets. All of these render targets must access the same type of resource: Buffer, Texture1D, Texture1DArray, Texture2D, Texture2DArray, Texture3D, or TextureCube. All render targets must have the same size in all dimensions (width and height, and depth for 3D or array size for *Array types). If render targets use multisample anti-aliasing, all bound render targets and depth buffer must be the same form of multisample resource (that is, the sample counts must be the same). Each render target can have a different data format. These render target formats are not required to have identical bit-per-element counts.

Any combination of the eight slots for render targets can have a render target set or not set.

The same resource view cannot be bound to multiple render target slots simultaneously. However, you can set multiple non-overlapping resource views of a single resource as simultaneous multiple render targets.

+
+ ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets +
+ + + Binds a single render target to the output-merger stage. + + A view of the render target to bind. + +

The maximum number of active render targets a device can have active at any given time is set by a #define in D3D11.h called D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT. It is invalid to try to set the same subresource to multiple render target slots. Any render targets not defined by this call are set to null.

If any subresources are also currently bound for reading in a different stage or writing (perhaps in a different part of the pipeline), those bind points will be set to null, in order to prevent the same subresource from being read and written simultaneously in a single rendering operation.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

If the render-target views were created from an array resource type, then all of the render-target views must have the same array size. This restriction also applies to the depth-stencil view, its array size must match that of the render-target views being bound.

The pixel shader must be able to simultaneously render to at least eight separate render targets. All of these render targets must access the same type of resource: Buffer, Texture1D, Texture1DArray, Texture2D, Texture2DArray, Texture3D, or TextureCube. All render targets must have the same size in all dimensions (width and height, and depth for 3D or array size for *Array types). If render targets use multisample anti-aliasing, all bound render targets and depth buffer must be the same form of multisample resource (that is, the sample counts must be the same). Each render target can have a different data format. These render target formats are not required to have identical bit-per-element counts.

Any combination of the eight slots for render targets can have a render target set or not set.

The same resource view cannot be bound to multiple render target slots simultaneously. However, you can set multiple non-overlapping resource views of a single resource as simultaneous multiple render targets.

+
+ ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets +
+ + + Binds a depth-stencil buffer and a set of render targets to the output-merger stage. + + A view of the depth-stencil buffer to bind. + A set of render target views to bind. + +

The maximum number of active render targets a device can have active at any given time is set by a #define in D3D11.h called D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT. It is invalid to try to set the same subresource to multiple render target slots. Any render targets not defined by this call are set to null.

If any subresources are also currently bound for reading in a different stage or writing (perhaps in a different part of the pipeline), those bind points will be set to null, in order to prevent the same subresource from being read and written simultaneously in a single rendering operation.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

If the render-target views were created from an array resource type, then all of the render-target views must have the same array size. This restriction also applies to the depth-stencil view, its array size must match that of the render-target views being bound.

The pixel shader must be able to simultaneously render to at least eight separate render targets. All of these render targets must access the same type of resource: Buffer, Texture1D, Texture1DArray, Texture2D, Texture2DArray, Texture3D, or TextureCube. All render targets must have the same size in all dimensions (width and height, and depth for 3D or array size for *Array types). If render targets use multisample anti-aliasing, all bound render targets and depth buffer must be the same form of multisample resource (that is, the sample counts must be the same). Each render target can have a different data format. These render target formats are not required to have identical bit-per-element counts.

Any combination of the eight slots for render targets can have a render target set or not set.

The same resource view cannot be bound to multiple render target slots simultaneously. However, you can set multiple non-overlapping resource views of a single resource as simultaneous multiple render targets.

+
+ ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets +
+ + + Binds a depth-stencil buffer and a single render target to the output-merger stage. + + A view of the depth-stencil buffer to bind. + A view of the render target to bind. + +

The maximum number of active render targets a device can have active at any given time is set by a #define in D3D11.h called D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT. It is invalid to try to set the same subresource to multiple render target slots. Any render targets not defined by this call are set to null.

If any subresources are also currently bound for reading in a different stage or writing (perhaps in a different part of the pipeline), those bind points will be set to null, in order to prevent the same subresource from being read and written simultaneously in a single rendering operation.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

If the render-target views were created from an array resource type, then all of the render-target views must have the same array size. This restriction also applies to the depth-stencil view, its array size must match that of the render-target views being bound.

The pixel shader must be able to simultaneously render to at least eight separate render targets. All of these render targets must access the same type of resource: Buffer, Texture1D, Texture1DArray, Texture2D, Texture2DArray, Texture3D, or TextureCube. All render targets must have the same size in all dimensions (width and height, and depth for 3D or array size for *Array types). If render targets use multisample anti-aliasing, all bound render targets and depth buffer must be the same form of multisample resource (that is, the sample counts must be the same). Each render target can have a different data format. These render target formats are not required to have identical bit-per-element counts.

Any combination of the eight slots for render targets can have a render target set or not set.

The same resource view cannot be bound to multiple render target slots simultaneously. However, you can set multiple non-overlapping resource views of a single resource as simultaneous multiple render targets.

+
+ ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets +
+ + + Binds a depth-stencil buffer and a set of render targets to the output-merger stage. + + A view of the depth-stencil buffer to bind. + A set of render target views to bind. + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + +

The maximum number of active render targets a device can have active at any given time is set by a #define in D3D11.h called D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT. It is invalid to try to set the same subresource to multiple render target slots. Any render targets not defined by this call are set to null.

If any subresources are also currently bound for reading in a different stage or writing (perhaps in a different part of the pipeline), those bind points will be set to null, in order to prevent the same subresource from being read and written simultaneously in a single rendering operation.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

If the render-target views were created from an array resource type, then all of the render-target views must have the same array size. This restriction also applies to the depth-stencil view, its array size must match that of the render-target views being bound.

The pixel shader must be able to simultaneously render to at least eight separate render targets. All of these render targets must access the same type of resource: Buffer, Texture1D, Texture1DArray, Texture2D, Texture2DArray, Texture3D, or TextureCube. All render targets must have the same size in all dimensions (width and height, and depth for 3D or array size for *Array types). If render targets use multisample anti-aliasing, all bound render targets and depth buffer must be the same form of multisample resource (that is, the sample counts must be the same). Each render target can have a different data format. These render target formats are not required to have identical bit-per-element counts.

Any combination of the eight slots for render targets can have a render target set or not set.

The same resource view cannot be bound to multiple render target slots simultaneously. However, you can set multiple non-overlapping resource views of a single resource as simultaneous multiple render targets.

+
+ ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets +
+ + + Binds a set of render targets to the output-merger stage and clear the depth stencil view. + + A set of render target views to bind. + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + +

The maximum number of active render targets a device can have active at any given time is set by a #define in D3D11.h called D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT. It is invalid to try to set the same subresource to multiple render target slots. Any render targets not defined by this call are set to null.

If any subresources are also currently bound for reading in a different stage or writing (perhaps in a different part of the pipeline), those bind points will be set to null, in order to prevent the same subresource from being read and written simultaneously in a single rendering operation.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

If the render-target views were created from an array resource type, then all of the render-target views must have the same array size. This restriction also applies to the depth-stencil view, its array size must match that of the render-target views being bound.

The pixel shader must be able to simultaneously render to at least eight separate render targets. All of these render targets must access the same type of resource: Buffer, Texture1D, Texture1DArray, Texture2D, Texture2DArray, Texture3D, or TextureCube. All render targets must have the same size in all dimensions (width and height, and depth for 3D or array size for *Array types). If render targets use multisample anti-aliasing, all bound render targets and depth buffer must be the same form of multisample resource (that is, the sample counts must be the same). Each render target can have a different data format. These render target formats are not required to have identical bit-per-element counts.

Any combination of the eight slots for render targets can have a render target set or not set.

The same resource view cannot be bound to multiple render target slots simultaneously. However, you can set multiple non-overlapping resource views of a single resource as simultaneous multiple render targets.

+
+ ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets +
+ + + Binds a set of unordered access views and a single render target to the output-merger stage. + + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A view of the render target to bind. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Binds a set of unordered access views and a set of render targets to the output-merger stage. + + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A set of render target views to bind. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Binds a depth-stencil buffer, a set of unordered access views, and a single render target to the output-merger stage. + + A view of the depth-stencil buffer to bind. + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A view of the render target to bind. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Binds a depth-stencil buffer, a set of unordered access views, and a set of render targets to the output-merger stage. + + A view of the depth-stencil buffer to bind. + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A set of render target views to bind. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Binds a set of unordered access views and a single render target to the output-merger stage. + + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A view of the render target to bind. + An array of Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Binds a set of unordered access views and a set of render targets to the output-merger stage. + + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A set of render target views to bind. + An array of Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Binds a depth-stencil buffer, a set of unordered access views, and a single render target to the output-merger stage. + + A view of the depth-stencil buffer to bind. + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A view of the render target to bind. + An array of Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Binds a depth-stencil buffer, a set of unordered access views, and a set of render targets to the output-merger stage. + + A view of the depth-stencil buffer to bind. + Index into a zero-based array to begin setting unordered access views. + A set of unordered access views to bind. + A set of render target views to bind. + An array of Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an references to be set by the method. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an references to be set by the method. + An Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. uAVInitialCount is only relevant for UAVs which have the flag, otherwise the argument is ignored. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an array of references to be set by the method. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + + Sets an array of views for an unordered resource. + + + + Index of the first element in the zero-based array to begin setting. + A reference to an array of references to be set by the method. + An array of Append/Consume buffer offsets. A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable/Consumeable UAV. pUAVInitialCounts is only relevant for UAVs which have the flag, otherwise the argument is ignored. + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews + + + +

Binds resources to the output-merger stage.

+
+

Number of render-target views (ppRenderTargetViews) and depth-stencil view (ppDepthStencilView) to bind. If you set NumViews to D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL (0xffffffff), this method does not modify the currently bound render-target views (RTVs) and also does not modify depth-stencil view (DSV).

+

Pointer to an array of s, which represent render-target views. Specify null to set none.

+

Pointer to a , which represents a depth-stencil view. Specify null to set none.

+

Index into a zero-based array to begin setting unordered-access views (ranges from 0 to - 1).

For the Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, this value can range from 0 to D3D11_1_UAV_SLOT_COUNT - 1. D3D11_1_UAV_SLOT_COUNT is defined as 64.

For pixel shaders, UAVStartSlot should be equal to the number of render-target views being bound.

+

Number of unordered-access views (UAVs) in ppUnorderedAccessView. If you set NumUAVs to D3D11_KEEP_UNORDERED_ACCESS_VIEWS (0xffffffff), this method does not modify the currently bound unordered-access views.

For the Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, this value can range from 0 to D3D11_1_UAV_SLOT_COUNT - UAVStartSlot.

+

Pointer to an array of s, which represent unordered-access views.

+

An array of append and consume buffer offsets. A value of -1 indicates to keep the current offset. Any other values set the hidden counter for that appendable and consumable UAV. pUAVInitialCounts is relevant only for UAVs that were created with either or specified when the UAV was created; otherwise, the argument is ignored.

+ +

For pixel shaders, the render targets and unordered-access views share the same resource slots when being written out. This means that UAVs must be given an offset so that they are placed in the slots after the render target views that are being bound.

Note??RTVs, DSV, and UAVs cannot be set independently; they all need to be set at the same time.

Two RTVs conflict if they share a subresource (and therefore share the same resource).

Two UAVs conflict if they share a subresource (and therefore share the same resource).

An RTV conflicts with a UAV if they share a subresource or share a bind point.

OMSetRenderTargetsAndUnorderedAccessViews operates properly in the following situations:

  1. NumViews != D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL and NumUAVs != D3D11_KEEP_UNORDERED_ACCESS_VIEWS

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • NumViews <= 8
    • UAVStartSlot >= NumViews
    • UAVStartSlot + NumUAVs <= 8
    • There must be no conflicts in the set of all ppRenderTargetViews and ppUnorderedAccessView.
    • ppDepthStencilView must match the render-target views. For more information about resource views, see Introduction to a Resource in Direct3D 11.

    OMSetRenderTargetsAndUnorderedAccessViews performs the following tasks:

    • Unbinds all currently bound conflicting resources (stream-output target resources (SOTargets), compute shader (CS) UAVs, shader-resource views (SRVs)).
    • Binds ppRenderTargetViews, ppDepthStencilView, and ppUnorderedAccessView.
  2. NumViews == D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL

    In this situation, OMSetRenderTargetsAndUnorderedAccessViews binds only UAVs.

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • UAVStartSlot + NumUAVs <= 8
    • There must be no conflicts in ppUnorderedAccessView.

    OMSetRenderTargetsAndUnorderedAccessViews unbinds the following items:

    • All RTVs in slots >= UAVStartSlot
    • All RTVs that conflict with any UAVs in ppUnorderedAccessView
    • All currently bound resources (SOTargets, CS UAVs, SRVs) that conflict with ppUnorderedAccessView

    OMSetRenderTargetsAndUnorderedAccessViews binds ppUnorderedAccessView.

    OMSetRenderTargetsAndUnorderedAccessViews ignores ppDepthStencilView, and the current depth-stencil view remains bound.

  3. NumUAVs == D3D11_KEEP_UNORDERED_ACCESS_VIEWS

    In this situation, OMSetRenderTargetsAndUnorderedAccessViews binds only RTVs and DSV.

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • NumViews <= 8
    • There must be no conflicts in ppRenderTargetViews.
    • ppDepthStencilView must match the render-target views. For more information about resource views, see Introduction to a Resource in Direct3D 11.

    OMSetRenderTargetsAndUnorderedAccessViews unbinds the following items:

    • All UAVs in slots < NumViews
    • All UAVs that conflict with any RTVs in ppRenderTargetViews
    • All currently bound resources (SOTargets, CS UAVs, SRVs) that conflict with ppRenderTargetViews

    OMSetRenderTargetsAndUnorderedAccessViews binds ppRenderTargetViews and ppDepthStencilView.

    OMSetRenderTargetsAndUnorderedAccessViews ignores UAVStartSlot.

+
+ ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews +
+ + +

Binds resources to the output-merger stage.

+
+

Number of render-target views (ppRenderTargetViews) and depth-stencil view (ppDepthStencilView) to bind. If you set NumViews to D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL (0xffffffff), this method does not modify the currently bound render-target views (RTVs) and also does not modify depth-stencil view (DSV).

+

Pointer to an array of s, which represent render-target views. Specify null to set none.

+

Pointer to a , which represents a depth-stencil view. Specify null to set none.

+

Index into a zero-based array to begin setting unordered-access views (ranges from 0 to - 1).

For the Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, this value can range from 0 to D3D11_1_UAV_SLOT_COUNT - 1. D3D11_1_UAV_SLOT_COUNT is defined as 64.

For pixel shaders, UAVStartSlot should be equal to the number of render-target views being bound.

+

Number of unordered-access views (UAVs) in ppUnorderedAccessView. If you set NumUAVs to D3D11_KEEP_UNORDERED_ACCESS_VIEWS (0xffffffff), this method does not modify the currently bound unordered-access views.

For the Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, this value can range from 0 to D3D11_1_UAV_SLOT_COUNT - UAVStartSlot.

+

Pointer to an array of s, which represent unordered-access views.

+

An array of append and consume buffer offsets. A value of -1 indicates to keep the current offset. Any other values set the hidden counter for that appendable and consumable UAV. pUAVInitialCounts is relevant only for UAVs that were created with either or specified when the UAV was created; otherwise, the argument is ignored.

+ +

For pixel shaders, the render targets and unordered-access views share the same resource slots when being written out. This means that UAVs must be given an offset so that they are placed in the slots after the render target views that are being bound.

Note??RTVs, DSV, and UAVs cannot be set independently; they all need to be set at the same time.

Two RTVs conflict if they share a subresource (and therefore share the same resource).

Two UAVs conflict if they share a subresource (and therefore share the same resource).

An RTV conflicts with a UAV if they share a subresource or share a bind point.

OMSetRenderTargetsAndUnorderedAccessViews operates properly in the following situations:

  1. NumViews != D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL and NumUAVs != D3D11_KEEP_UNORDERED_ACCESS_VIEWS

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • NumViews <= 8
    • UAVStartSlot >= NumViews
    • UAVStartSlot + NumUAVs <= 8
    • There must be no conflicts in the set of all ppRenderTargetViews and ppUnorderedAccessView.
    • ppDepthStencilView must match the render-target views. For more information about resource views, see Introduction to a Resource in Direct3D 11.

    OMSetRenderTargetsAndUnorderedAccessViews performs the following tasks:

    • Unbinds all currently bound conflicting resources (stream-output target resources (SOTargets), compute shader (CS) UAVs, shader-resource views (SRVs)).
    • Binds ppRenderTargetViews, ppDepthStencilView, and ppUnorderedAccessView.
  2. NumViews == D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL

    In this situation, OMSetRenderTargetsAndUnorderedAccessViews binds only UAVs.

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • UAVStartSlot + NumUAVs <= 8
    • There must be no conflicts in ppUnorderedAccessView.

    OMSetRenderTargetsAndUnorderedAccessViews unbinds the following items:

    • All RTVs in slots >= UAVStartSlot
    • All RTVs that conflict with any UAVs in ppUnorderedAccessView
    • All currently bound resources (SOTargets, CS UAVs, SRVs) that conflict with ppUnorderedAccessView

    OMSetRenderTargetsAndUnorderedAccessViews binds ppUnorderedAccessView.

    OMSetRenderTargetsAndUnorderedAccessViews ignores ppDepthStencilView, and the current depth-stencil view remains bound.

  3. NumUAVs == D3D11_KEEP_UNORDERED_ACCESS_VIEWS

    In this situation, OMSetRenderTargetsAndUnorderedAccessViews binds only RTVs and DSV.

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • NumViews <= 8
    • There must be no conflicts in ppRenderTargetViews.
    • ppDepthStencilView must match the render-target views. For more information about resource views, see Introduction to a Resource in Direct3D 11.

    OMSetRenderTargetsAndUnorderedAccessViews unbinds the following items:

    • All UAVs in slots < NumViews
    • All UAVs that conflict with any RTVs in ppRenderTargetViews
    • All currently bound resources (SOTargets, CS UAVs, SRVs) that conflict with ppRenderTargetViews

    OMSetRenderTargetsAndUnorderedAccessViews binds ppRenderTargetViews and ppDepthStencilView.

    OMSetRenderTargetsAndUnorderedAccessViews ignores UAVStartSlot.

+
+ ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const ID3D11RenderTargetView** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const ID3D11UnorderedAccessView** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews +
+ + + Set the blend state of the output-merger stage. + + Pointer to a blend-state interface (see ). Passing in null implies a default blend state. See remarks for further details. + Array of blend factors, one for each RGBA component. This requires a blend state object that specifies the option. + 32-bit sample coverage. The default value is 0xffffffff. See remarks. + + Blend state is used by the output-merger stage to determine how to blend together two pixel values. The two values are commonly the current pixel value and the pixel value already in the output render target. Use the blend operation to control where the two pixel values come from and how they are mathematically combined.To create a blend-state interface, call .Passing in null for the blend-state interface indicates to the runtime to set a default blending state. The following table indicates the default blending parameters.StateDefault Value AlphaToCoverageEnableFALSE BlendEnableFALSE[8] SrcBlendD3D11_BLEND_ONE DstBlendD3D11_BLEND_ZERO BlendOpD3D11_BLEND_OP_ADD SrcBlendAlphaD3D11_BLEND_ONE DstBlendAlphaD3D11_BLEND_ZERO BlendOpAlphaD3D11_BLEND_OP_ADD RenderTargetWriteMask[8][8]?A sample mask determines which samples get updated in all the active render targets. The mapping of bits in a sample mask to samples in a multisample render target is the responsibility of an individual application. A sample mask is always applied; it is independent of whether multisampling is enabled, and does not depend on whether an application uses multisample render targets.The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10. + + void ID3D11DeviceContext::OMSetBlendState([In, Optional] ID3D11BlendState* pBlendState,[In, Optional] const SHARPDX_COLOR4* BlendFactor,[In] unsigned int SampleMask) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Bind one or more render targets atomically and the depth-stencil buffer to the output-merger stage.

+
+

Number of render targets to bind (ranges between 0 and D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT).

+

Pointer to an array of render targets (see ) to bind to the device. If this parameter is null, no render targets are bound. See Remarks.

+

Pointer to a depth-stencil view (see ) to bind to the device. If this parameter is null, the depth-stencil state is not bound.

+ +

The maximum number of active render targets a device can have active at any given time is set by a #define in D3D11.h called D3D11_SIMULTANEOUS_RENDER_TARGET_COUNT. It is invalid to try to set the same subresource to multiple render target slots. Any render targets not defined by this call are set to null.

If any subresources are also currently bound for reading in a different stage or writing (perhaps in a different part of the pipeline), those bind points will be set to null, in order to prevent the same subresource from being read and written simultaneously in a single rendering operation.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

If the render-target views were created from an array resource type, then all of the render-target views must have the same array size. This restriction also applies to the depth-stencil view, its array size must match that of the render-target views being bound.

The pixel shader must be able to simultaneously render to at least eight separate render targets. All of these render targets must access the same type of resource: Buffer, Texture1D, Texture1DArray, Texture2D, Texture2DArray, Texture3D, or TextureCube. All render targets must have the same size in all dimensions (width and height, and depth for 3D or array size for *Array types). If render targets use multisample anti-aliasing, all bound render targets and depth buffer must be the same form of multisample resource (that is, the sample counts must be the same). Each render target can have a different data format. These render target formats are not required to have identical bit-per-element counts.

Any combination of the eight slots for render targets can have a render target set or not set.

The same resource view cannot be bound to multiple render target slots simultaneously. However, you can set multiple non-overlapping resource views of a single resource as simultaneous multiple render targets.

+
+ + ff476464 + void ID3D11DeviceContext::OMSetRenderTargets([In] unsigned int NumViews,[In] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView) + ID3D11DeviceContext::OMSetRenderTargets +
+ + +

Binds resources to the output-merger stage.

+
+

Number of render-target views (ppRenderTargetViews) and depth-stencil view (ppDepthStencilView) to bind. If you set NumViews to D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL (0xffffffff), this method does not modify the currently bound render-target views (RTVs) and also does not modify depth-stencil view (DSV).

+

Pointer to an array of s, which represent render-target views. Specify null to set none.

+

Pointer to a , which represents a depth-stencil view. Specify null to set none.

+

Index into a zero-based array to begin setting unordered-access views (ranges from 0 to - 1).

For the Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, this value can range from 0 to D3D11_1_UAV_SLOT_COUNT - 1. D3D11_1_UAV_SLOT_COUNT is defined as 64.

For pixel shaders, UAVStartSlot should be equal to the number of render-target views being bound.

+

Number of unordered-access views (UAVs) in ppUnorderedAccessView. If you set NumUAVs to D3D11_KEEP_UNORDERED_ACCESS_VIEWS (0xffffffff), this method does not modify the currently bound unordered-access views.

For the Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, this value can range from 0 to D3D11_1_UAV_SLOT_COUNT - UAVStartSlot.

+

Pointer to an array of s, which represent unordered-access views.

+

An array of append and consume buffer offsets. A value of -1 indicates to keep the current offset. Any other values set the hidden counter for that appendable and consumable UAV. pUAVInitialCounts is relevant only for UAVs that were created with either or specified when the UAV was created; otherwise, the argument is ignored.

+ +

For pixel shaders, the render targets and unordered-access views share the same resource slots when being written out. This means that UAVs must be given an offset so that they are placed in the slots after the render target views that are being bound.

Note??RTVs, DSV, and UAVs cannot be set independently; they all need to be set at the same time.

Two RTVs conflict if they share a subresource (and therefore share the same resource).

Two UAVs conflict if they share a subresource (and therefore share the same resource).

An RTV conflicts with a UAV if they share a subresource or share a bind point.

OMSetRenderTargetsAndUnorderedAccessViews operates properly in the following situations:

  1. NumViews != D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL and NumUAVs != D3D11_KEEP_UNORDERED_ACCESS_VIEWS

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • NumViews <= 8
    • UAVStartSlot >= NumViews
    • UAVStartSlot + NumUAVs <= 8
    • There must be no conflicts in the set of all ppRenderTargetViews and ppUnorderedAccessView.
    • ppDepthStencilView must match the render-target views. For more information about resource views, see Introduction to a Resource in Direct3D 11.

    OMSetRenderTargetsAndUnorderedAccessViews performs the following tasks:

    • Unbinds all currently bound conflicting resources (stream-output target resources (SOTargets), compute shader (CS) UAVs, shader-resource views (SRVs)).
    • Binds ppRenderTargetViews, ppDepthStencilView, and ppUnorderedAccessView.
  2. NumViews == D3D11_KEEP_RENDER_TARGETS_AND_DEPTH_STENCIL

    In this situation, OMSetRenderTargetsAndUnorderedAccessViews binds only UAVs.

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • UAVStartSlot + NumUAVs <= 8
    • There must be no conflicts in ppUnorderedAccessView.

    OMSetRenderTargetsAndUnorderedAccessViews unbinds the following items:

    • All RTVs in slots >= UAVStartSlot
    • All RTVs that conflict with any UAVs in ppUnorderedAccessView
    • All currently bound resources (SOTargets, CS UAVs, SRVs) that conflict with ppUnorderedAccessView

    OMSetRenderTargetsAndUnorderedAccessViews binds ppUnorderedAccessView.

    OMSetRenderTargetsAndUnorderedAccessViews ignores ppDepthStencilView, and the current depth-stencil view remains bound.

  3. NumUAVs == D3D11_KEEP_UNORDERED_ACCESS_VIEWS

    In this situation, OMSetRenderTargetsAndUnorderedAccessViews binds only RTVs and DSV.

    The following conditions must be true for OMSetRenderTargetsAndUnorderedAccessViews to succeed and for the runtime to pass the bind information to the driver:

    • NumViews <= 8
    • There must be no conflicts in ppRenderTargetViews.
    • ppDepthStencilView must match the render-target views. For more information about resource views, see Introduction to a Resource in Direct3D 11.

    OMSetRenderTargetsAndUnorderedAccessViews unbinds the following items:

    • All UAVs in slots < NumViews
    • All UAVs that conflict with any RTVs in ppRenderTargetViews
    • All currently bound resources (SOTargets, CS UAVs, SRVs) that conflict with ppRenderTargetViews

    OMSetRenderTargetsAndUnorderedAccessViews binds ppRenderTargetViews and ppDepthStencilView.

    OMSetRenderTargetsAndUnorderedAccessViews ignores UAVStartSlot.

+
+ + ff476465 + void ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[In, Buffer, Optional] const void** ppRenderTargetViews,[In, Optional] ID3D11DepthStencilView* pDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[In, Buffer, Optional] const void** ppUnorderedAccessViews,[In, Buffer, Optional] const unsigned int* pUAVInitialCounts) + ID3D11DeviceContext::OMSetRenderTargetsAndUnorderedAccessViews +
+ + +

Set the blend state of the output-merger stage.

+
+

Pointer to a blend-state interface (see ). Passing in null implies a default blend state. See remarks for further details.

+

Array of blend factors, one for each RGBA component. This requires a blend state object that specifies the option.

+

32-bit sample coverage. The default value is 0xffffffff. See remarks.

+ +

Blend state is used by the output-merger stage to determine how to blend together two pixel values. The two values are commonly the current pixel value and the pixel value already in the output render target. Use the blend operation to control where the two pixel values come from and how they are mathematically combined.

To create a blend-state interface, call .

Passing in null for the blend-state interface indicates to the runtime to set a default blending state. The following table indicates the default blending parameters.

StateDefault Value
AlphaToCoverageEnable
BlendEnable[8]
SrcBlend
DstBlend
BlendOp
SrcBlendAlpha
DstBlendAlpha
BlendOpAlpha
RenderTargetWriteMask[8][8]

?

A sample mask determines which samples get updated in all the active render targets. The mapping of bits in a sample mask to samples in a multisample render target is the responsibility of an individual application. A sample mask is always applied; it is independent of whether multisampling is enabled, and does not depend on whether an application uses multisample render targets.

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476462 + void ID3D11DeviceContext::OMSetBlendState([In, Optional] ID3D11BlendState* pBlendState,[In, Optional] const SHARPDX_COLOR4* BlendFactor,[In] unsigned int SampleMask) + ID3D11DeviceContext::OMSetBlendState +
+ + +

Sets the depth-stencil state of the output-merger stage.

+
+

Pointer to a depth-stencil state interface (see ) to bind to the device. Set this to null to use the default state listed in .

+

Reference value to perform against when doing a depth-stencil test. See remarks.

+ +

To create a depth-stencil state interface, call .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476463 + void ID3D11DeviceContext::OMSetDepthStencilState([In, Optional] ID3D11DepthStencilState* pDepthStencilState,[In] unsigned int StencilRef) + ID3D11DeviceContext::OMSetDepthStencilState +
+ + +

Get references to the resources bound to the output-merger stage.

+
+

Number of render targets to retrieve.

+

Pointer to an array of s which represent render target views. Specify null for this parameter when retrieval of a render target is not needed.

+

Pointer to a , which represents a depth-stencil view. Specify null for this parameter when retrieval of the depth-stencil view is not needed.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476460 + void ID3D11DeviceContext::OMGetRenderTargets([In] unsigned int NumViews,[Out, Buffer, Optional] ID3D11RenderTargetView** ppRenderTargetViews,[Out, Optional] ID3D11DepthStencilView** ppDepthStencilView) + ID3D11DeviceContext::OMGetRenderTargets +
+ + +

Get references to the resources bound to the output-merger stage.

+
+

The number of render-target views to retrieve.

+

Pointer to an array of s, which represent render-target views. Specify null for this parameter when retrieval of render-target views is not required.

+

Pointer to a , which represents a depth-stencil view. Specify null for this parameter when retrieval of the depth-stencil view is not required.

+

Index into a zero-based array to begin retrieving unordered-access views (ranges from 0 to - 1). For pixel shaders UAVStartSlot should be equal to the number of render-target views that are bound.

+

Number of unordered-access views to return in ppUnorderedAccessViews. This number ranges from 0 to - UAVStartSlot.

+

Pointer to an array of s, which represent unordered-access views that are retrieved. Specify null for this parameter when retrieval of unordered-access views is not required.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476461 + void ID3D11DeviceContext::OMGetRenderTargetsAndUnorderedAccessViews([In] unsigned int NumRTVs,[Out, Buffer, Optional] ID3D11RenderTargetView** ppRenderTargetViews,[Out, Optional] ID3D11DepthStencilView** ppDepthStencilView,[In] unsigned int UAVStartSlot,[In] unsigned int NumUAVs,[Out, Buffer, Optional] ID3D11UnorderedAccessView** ppUnorderedAccessViews) + ID3D11DeviceContext::OMGetRenderTargetsAndUnorderedAccessViews +
+ + +

Get the blend state of the output-merger stage.

+
+

Address of a reference to a blend-state interface (see ).

+

Array of blend factors, one for each RGBA component.

+

Pointer to a sample mask.

+ +

The reference count of the returned interface will be incremented by one when the blend state is retrieved. Applications must release returned reference(s) when they are no longer needed, or else there will be a memory leak.

+
+ + ff476458 + void ID3D11DeviceContext::OMGetBlendState([Out, Optional] ID3D11BlendState** ppBlendState,[Out, Optional] SHARPDX_COLOR4* BlendFactor,[Out, Optional] unsigned int* pSampleMask) + ID3D11DeviceContext::OMGetBlendState +
+ + +

Gets the depth-stencil state of the output-merger stage.

+
+

Address of a reference to a depth-stencil state interface (see ) to be filled with information from the device.

+

Pointer to the stencil reference value used in the depth-stencil test.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476459 + void ID3D11DeviceContext::OMGetDepthStencilState([Out, Optional] ID3D11DepthStencilState** ppDepthStencilState,[Out, Optional] unsigned int* pStencilRef) + ID3D11DeviceContext::OMGetDepthStencilState +
+ + + Gets or sets the blend factor. + + The blend factor. + + + + Gets or sets the blend sample mask. + + The blend sample mask. + + + + Gets or sets the state of the blend. + + The state of the blend. + + + + Gets or sets the depth stencil reference. + + The depth stencil reference. + + + + Gets or sets the state of the depth stencil. + + The state of the depth stencil. + + + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Get the array of {{viewports}} bound to the {{rasterizer stage}} + + An array of viewports (see ). + void RSGetViewports([InOut] int* NumViewports,[Out, Buffer, Optional] D3D10_VIEWPORT* pViewports) + ff476477 + void ID3D11DeviceContext::RSGetViewports([InOut] unsigned int* pNumViewports,[Out, Buffer, Optional] D3D11_VIEWPORT* pViewports) + ID3D11DeviceContext::RSGetViewports + + + + Get the array of {{viewports}} bound to the {{rasterizer stage}} + + An array of viewports (see ). + void RSGetViewports([InOut] int* NumViewports,[Out, Buffer, Optional] D3D10_VIEWPORT* pViewports) + ff476477 + void ID3D11DeviceContext::RSGetViewports([InOut] unsigned int* pNumViewports,[Out, Buffer, Optional] D3D11_VIEWPORT* pViewports) + ID3D11DeviceContext::RSGetViewports + + + + Get the array of {{scissor rectangles}} bound to the {{rasterizer stage}}. + + An array of scissor rectangles (see ). + void RSGetScissorRects([InOut] int* NumRects,[Out, Buffer, Optional] D3D10_RECT* pRects) + ff476475 + void ID3D11DeviceContext::RSGetScissorRects([InOut] unsigned int* pNumRects,[Out, Buffer, Optional] RECT* pRects) + ID3D11DeviceContext::RSGetScissorRects + + + + Get the array of {{scissor rectangles}} bound to the {{rasterizer stage}}. + + An array of scissor rectangles (see ). + void RSGetScissorRects([InOut] int* NumRects,[Out, Buffer, Optional] D3D10_RECT* pRects) + ff476475 + void ID3D11DeviceContext::RSGetScissorRects([InOut] unsigned int* pNumRects,[Out, Buffer, Optional] RECT* pRects) + ID3D11DeviceContext::RSGetScissorRects + + + + Binds a single scissor rectangle to the rasterizer stage. + + The left. + The top. + The right. + The bottom. + +

All scissor rects must be set atomically as one operation. Any scissor rects not defined by the call are disabled.

The scissor rectangles will only be used if ScissorEnable is set to true in the rasterizer state (see ).

Which scissor rectangle to use is determined by the SV_ViewportArrayIndex semantic output by a geometry shader (see shader semantic syntax). If a geometry shader does not make use of the SV_ViewportArrayIndex semantic then Direct3D will use the first scissor rectangle in the array.

Each scissor rectangle in the array corresponds to a viewport in an array of viewports (see ).

+
+ ff476478 + void ID3D11DeviceContext::RSSetScissorRects([In] unsigned int NumRects,[In, Buffer, Optional] const void* pRects) + ID3D11DeviceContext::RSSetScissorRects +
+ + + Binds a set of scissor rectangles to the rasterizer stage. + + The set of scissor rectangles to bind. + +

All scissor rects must be set atomically as one operation. Any scissor rects not defined by the call are disabled.

The scissor rectangles will only be used if ScissorEnable is set to true in the rasterizer state (see ).

Which scissor rectangle to use is determined by the SV_ViewportArrayIndex semantic output by a geometry shader (see shader semantic syntax). If a geometry shader does not make use of the SV_ViewportArrayIndex semantic then Direct3D will use the first scissor rectangle in the array.

Each scissor rectangle in the array corresponds to a viewport in an array of viewports (see ).

+
+ ff476478 + void ID3D11DeviceContext::RSSetScissorRects([In] unsigned int NumRects,[In, Buffer, Optional] const void* pRects) + ID3D11DeviceContext::RSSetScissorRects +
+ + + Binds a single viewport to the rasterizer stage. + + The x coord of the viewport. + The x coord of the viewport. + The width. + The height. + The min Z. + The max Z. + +

All viewports must be set atomically as one operation. Any viewports not defined by the call are disabled.

Which viewport to use is determined by the SV_ViewportArrayIndex semantic output by a geometry shader; if a geometry shader does not specify the semantic, Direct3D will use the first viewport in the array.

+
+ ff476480 + void ID3D11DeviceContext::RSSetViewports([In] unsigned int NumViewports,[In, Buffer, Optional] const void* pViewports) + ID3D11DeviceContext::RSSetViewports +
+ + + Binds a single viewport to the rasterizer stage. + + The viewport. + +

All viewports must be set atomically as one operation. Any viewports not defined by the call are disabled.

Which viewport to use is determined by the SV_ViewportArrayIndex semantic output by a geometry shader; if a geometry shader does not specify the semantic, Direct3D will use the first viewport in the array.

+
+ ff476480 + void ID3D11DeviceContext::RSSetViewports([In] unsigned int NumViewports,[In, Buffer, Optional] const void* pViewports) + ID3D11DeviceContext::RSSetViewports +
+ + + Binds a set of viewports to the rasterizer stage. + + The set of viewports to bind. + +

All viewports must be set atomically as one operation. Any viewports not defined by the call are disabled.

Which viewport to use is determined by the SV_ViewportArrayIndex semantic output by a geometry shader; if a geometry shader does not specify the semantic, Direct3D will use the first viewport in the array.

+
+ ff476480 + void ID3D11DeviceContext::RSSetViewports([In] unsigned int NumViewports,[In, Buffer, Optional] const void* pViewports) + ID3D11DeviceContext::RSSetViewports +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set the rasterizer state for the rasterizer stage of the pipeline.

+
+ No documentation. + +

To create a rasterizer state interface, call .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476479 + void ID3D11DeviceContext::RSSetState([In, Optional] ID3D11RasterizerState* pRasterizerState) + ID3D11DeviceContext::RSSetState +
+ + +

Bind an array of viewports to the rasterizer stage of the pipeline.

+
+

Number of viewports to bind.

+

An array of structures to bind to the device. See the structure page for details about how the viewport size is dependent on the device feature level which has changed between Direct3D 11 and Direct3D 10.

+ +

All viewports must be set atomically as one operation. Any viewports not defined by the call are disabled.

Which viewport to use is determined by the SV_ViewportArrayIndex semantic output by a geometry shader; if a geometry shader does not specify the semantic, Direct3D will use the first viewport in the array.

+
+ + ff476480 + void ID3D11DeviceContext::RSSetViewports([In] unsigned int NumViewports,[In, Buffer, Optional] const void* pViewports) + ID3D11DeviceContext::RSSetViewports +
+ + +

Bind an array of scissor rectangles to the rasterizer stage.

+
+

Number of scissor rectangles to bind.

+

An array of scissor rectangles (see D3D11_RECT).

+ +

All scissor rects must be set atomically as one operation. Any scissor rects not defined by the call are disabled.

The scissor rectangles will only be used if ScissorEnable is set to true in the rasterizer state (see ).

Which scissor rectangle to use is determined by the SV_ViewportArrayIndex semantic output by a geometry shader (see shader semantic syntax). If a geometry shader does not make use of the SV_ViewportArrayIndex semantic then Direct3D will use the first scissor rectangle in the array.

Each scissor rectangle in the array corresponds to a viewport in an array of viewports (see ).

+
+ + ff476478 + void ID3D11DeviceContext::RSSetScissorRects([In] unsigned int NumRects,[In, Buffer, Optional] const void* pRects) + ID3D11DeviceContext::RSSetScissorRects +
+ + +

Get the rasterizer state from the rasterizer stage of the pipeline.

+
+ No documentation. + +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476476 + void ID3D11DeviceContext::RSGetState([Out] ID3D11RasterizerState** ppRasterizerState) + ID3D11DeviceContext::RSGetState +
+ + +

Get the array of viewports bound to the rasterizer stage

+
+

The input specifies the number of viewports (ranges from 0 to D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE) in pViewports, the output contains the actual number of viewports returned. If pViewports is null, this will be filled with the number of viewports currently bound.

+

An array of structures that are bound to the device. If the number of viewports (in pNumViewports) is greater than the actual number of viewports currently bound, then unused members of the array will contain 0. See the structure page for details about how the viewport size is dependent on the device feature level which has changed between Direct3D 11 and Direct3D 10.

+ + ff476477 + void ID3D11DeviceContext::RSGetViewports([InOut] unsigned int* pNumViewports,[Out, Buffer, Optional] D3D11_VIEWPORT* pViewports) + ID3D11DeviceContext::RSGetViewports +
+ + +

Get the array of scissor rectangles bound to the rasterizer stage.

+
+

The number of scissor rectangles (ranges between 0 and D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE) bound; set pRects to null to use pNumRects to see how many rectangles would be returned.

+

An array of scissor rectangles (see D3D11_RECT). If NumRects is greater than the number of scissor rects currently bound, then unused members of the array will contain 0.

+ + ff476475 + void ID3D11DeviceContext::RSGetScissorRects([InOut] unsigned int* pNumRects,[Out, Buffer, Optional] RECT* pRects) + ID3D11DeviceContext::RSGetScissorRects +
+ + +

Get or sets the rasterizer state from the rasterizer stage of the pipeline.

+
+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476476 + RSGetState / RSSetState + RSGetState + void ID3D11DeviceContext::RSGetState([Out] ID3D11RasterizerState** ppRasterizerState) +
+ + +

A domain-shader interface manages an executable program (a domain shader) that controls the domain-shader stage.

+
+ +

The domain-shader interface has no methods; use HLSL to implement your shader functionality. All shaders are implemented from a common set of features referred to as the common-shader core..

To create a domain-shader interface, call . Before using a domain shader you must bind it to the device by calling .

This interface is defined in D3D11.h.

+
+ + ff476535 + ID3D11DomainShader + ID3D11DomainShader +
+ + + Initializes a new instance of the class. + + The device used to create the shader. + The compiled shader bytecode. + A dynamic class linkage interface. + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Encapsulates forward and inverse FFTs.

+
+ + ff476846 + ID3DX11FFT + ID3DX11FFT +
+ + + Initializes a new instance of the class. + + The device context used to create the FFT. + Information that describes the shape of the FFT data as well as the scaling factors that should be used for forward and inverse transforms. + + + + Initializes a new instance of the class. + + The device context used to create the FFT. + Information that describes the shape of the FFT data as well as the scaling factors that should be used for forward and inverse transforms. + Flag affecting the behavior of the FFT. + + + + Attaches buffers to an FFT context and performs any required precomputations. + + + The buffers must be no smaller than the corresponding buffer sizes returned by D3DX11CreateFFT*(). Temporary buffers can be shared between multiple contexts, though care should be taken not to concurrently execute multiple FFTs which share temp buffers. + + Temporary buffers to attach. + Buffers to hold precomputed data. + Returns one of the return codes described in the topic {{Direct3D 11 Return Codes}}. + HRESULT ID3DX11FFT::AttachBuffersAndPrecompute([In] int NumTempBuffers,[In, Buffer] const ID3D11UnorderedAccessView** ppTempBuffers,[In] int NumPrecomputeBuffers,[In, Buffer] const ID3D11UnorderedAccessView** ppPrecomputeBufferSizes) + + + + Creates a new one-dimensional complex FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + an interface reference. + HRESULT D3DX11CreateFFT1DComplex([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new one-dimensional complex FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Flag affecting the behavior of the FFT, can be 0 or a combination of flags from . + an interface reference. + HRESULT D3DX11CreateFFT1DComplex([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new one-dimensional real FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new one-dimensional real FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Flag affecting the behavior of the FFT, can be 0 or a combination of flags from . + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new two-dimensional complex FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new two-dimensional complex FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + Flag affecting the behavior of the FFT, can be 0 or a combination of flags from . + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new two-dimensional real FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new two-dimensional real FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + Flag affecting the behavior of the FFT, can be 0 or a combination of flags from . + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new three-dimensional complex FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + Length of the third dimension of the FFT. + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new three-dimensional complex FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + Length of the third dimension of the FFT. + Flag affecting the behavior of the FFT, can be 0 or a combination of flags from . + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new three-dimensional real FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + Length of the third dimension of the FFT. + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Creates a new three-dimensional real FFT. + + Pointer to the interface to use for the FFT. + Length of the first dimension of the FFT. + Length of the second dimension of the FFT. + Length of the third dimension of the FFT. + Flag affecting the behavior of the FFT, can be 0 or a combination of flags from . + an interface reference. + HRESULT D3DX11CreateFFT1DReal([None] ID3D11DeviceContext* pDeviceContext,[None] int X,[None] int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + + + + Performs a forward FFT. + + Pointer to onto the input buffer. + + Returns the computation in a temp buffers; in addition, the last buffer written to is returned. + + HRESULT ID3DX11FFT::ForwardTransform([In] const ID3D11UnorderedAccessView* pInputBuffer,[InOut] void** ppOutputBuffer) + + ForwardTransform can be called after buffers have been attached to the context using . The combination of pInputBuffer and *ppOuputBuffer can be one of the temp buffers.The format of complex data is interleaved components (for example, (Real0, Imag0), (Real1, Imag1) ... , and so on). Data is stored in row major order. + + + + + Performs an inverse FFT. + + Pointer to onto the input buffer. + + Returns the computation in a temp buffers; in addition, the last buffer written to is returned. + + HRESULT ID3DX11FFT::InverseTransform([In] const ID3D11UnorderedAccessView* pInputBuffer,[InOut] void** ppOutputBuffer) + + + + Performs a forward FFT. + + Pointer to onto the input buffer. + Buffer reference used as the output buffer. + Returns one of the return codes described in the topic Direct3D 11 Return Codes. + HRESULT ID3DX11FFT::ForwardTransform([In] const ID3D11UnorderedAccessView* pInputBuffer,[InOut] void** ppOutputBuffer) + + ForwardTransform can be called after buffers have been attached to the context using . The combination of pInputBuffer and *ppOuputBuffer can be one of the temp buffers.The format of complex data is interleaved components (for example, (Real0, Imag0), (Real1, Imag1) ... , and so on). Data is stored in row major order. + + + + + Performs an inverse FFT. + + Pointer to onto the input buffer. + Buffer reference used as the output buffer. + Returns one of the return codes described in the topic Direct3D 11 Return Codes. + HRESULT ID3DX11FFT::InverseTransform([In] const ID3D11UnorderedAccessView* pInputBuffer,[InOut] void** ppOutputBuffer) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets the scale used for forward transforms.

+
+

The scale to use for forward transforms. Setting ForwardScale to 0 causes the default values of 1 to be used.

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

SetForwardScale sets the scale used by .

+
+ + ff476852 + HRESULT ID3DX11FFT::SetForwardScale([In] float ForwardScale) + ID3DX11FFT::SetForwardScale +
+ + +

Gets the scale for forward transforms.

+
+

Scale for forward transforms.

+ + ff476849 + float ID3DX11FFT::GetForwardScale() + ID3DX11FFT::GetForwardScale +
+ + +

Sets the scale used for inverse transforms.

+
+

Scale used for inverse transforms. Setting InverseScale to 0 causes the default value of 1/N to be used, where N is the product of the transformed dimension lengths.

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

SetInverseScale sets the scale used by .

+
+ + ff476853 + HRESULT ID3DX11FFT::SetInverseScale([In] float InverseScale) + ID3DX11FFT::SetInverseScale +
+ + +

Get the scale for inverse transforms.

+
+

Scale for inverse transforms.

+ + ff476850 + float ID3DX11FFT::GetInverseScale() + ID3DX11FFT::GetInverseScale +
+ + +

Attaches buffers to an FFT context and performs any required precomputations.

+
+

Number of buffers in ppTempBuffers.

+

Temporary buffers to attach.

+

Number of buffers in ppPrecomputeBuffers.

+

Buffers to hold precomputed data.

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

The buffers must be no smaller than the corresponding buffer sizes returned by *(). Temporary buffers can be shared between multiple contexts, though care should be taken not to concurrently execute multiple FFTs which share temp buffers.

+
+ + ff476847 + HRESULT ID3DX11FFT::AttachBuffersAndPrecompute([In] unsigned int NumTempBuffers,[In, Buffer] const ID3D11UnorderedAccessView** ppTempBuffers,[In] unsigned int NumPrecomputeBuffers,[In, Buffer] const ID3D11UnorderedAccessView** ppPrecomputeBufferSizes) + ID3DX11FFT::AttachBuffersAndPrecompute +
+ + +

Attaches buffers to an FFT context and performs any required precomputations.

+
+

Number of buffers in ppTempBuffers.

+

Temporary buffers to attach.

+

Number of buffers in ppPrecomputeBuffers.

+

Buffers to hold precomputed data.

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

The buffers must be no smaller than the corresponding buffer sizes returned by *(). Temporary buffers can be shared between multiple contexts, though care should be taken not to concurrently execute multiple FFTs which share temp buffers.

+
+ + ff476847 + HRESULT ID3DX11FFT::AttachBuffersAndPrecompute([In] unsigned int NumTempBuffers,[In, Buffer] const ID3D11UnorderedAccessView** ppTempBuffers,[In] unsigned int NumPrecomputeBuffers,[In, Buffer] const ID3D11UnorderedAccessView** ppPrecomputeBufferSizes) + ID3DX11FFT::AttachBuffersAndPrecompute +
+ + +

Performs a forward FFT.

+
+

Pointer to onto the input buffer.

+

Pointer to a reference. If *ppOutputBuffer is null, the computation will switch between temp buffers; in addition, the last buffer written to is stored at *ppOutputBuffer. Otherwise, *ppOutputBuffer is used as the output buffer (which might incur an extra copy).

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

ForwardTransform can be called after buffers have been attached to the context using . The combination of pInputBuffer and *ppOuputBuffer can be one of the temp buffers.

The format of complex data is interleaved components (for example, (Real0, Imag0), (Real1, Imag1) ... , and so on). Data is stored in row major order.

+
+ + ff476848 + HRESULT ID3DX11FFT::ForwardTransform([In] const ID3D11UnorderedAccessView* pInputBuffer,[InOut] void** ppOutputBuffer) + ID3DX11FFT::ForwardTransform +
+ + +

Performs an inverse FFT.

+
+

Pointer to onto the input buffer.

+

Pointer to a reference. If *ppOutput is null, then the computation will switch between temp buffers; in addition, the last buffer written to is stored at *ppOutput. Otherwise, *ppOutput is used as the output buffer (which might incur an extra copy).

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ + ff476851 + HRESULT ID3DX11FFT::InverseTransform([In] const ID3D11UnorderedAccessView* pInputBuffer,[InOut] void** ppOutputBuffer) + ID3DX11FFT::InverseTransform +
+ + + Gets the buffer requirements. + + The buffer requirements. + + + +

Gets or sets the scale for forward transforms.

+
+ + ff476849 + GetForwardScale / SetForwardScale + GetForwardScale + float ID3DX11FFT::GetForwardScale() +
+ + +

Get or sets the scale for inverse transforms.

+
+ + ff476850 + GetInverseScale / SetInverseScale + GetInverseScale + float ID3DX11FFT::GetInverseScale() +
+ + +

Optional flags that control the behavior of .

+
+ + ff476084 + D3D11_ASYNC_GETDATA_FLAG + D3D11_ASYNC_GETDATA_FLAG +
+ + + No documentation. + + + D3D11_ASYNC_GETDATA_DONOTFLUSH + D3D11_ASYNC_GETDATA_DONOTFLUSH + + + + None. + + + None + None + + + +

Identifies how to bind a resource to the pipeline.

+
+ +

In general, binding flags can be combined using a logical OR (except the constant-buffer flag); however, you should use a single flag to allow the device to optimize the resource usage.

This enumeration is used by a:

  • Buffer description when creating a buffer.
  • Texture description when creating a texture (see or or ).

A shader-resource buffer is NOT a constant buffer; rather, it is a texture or buffer resource that is bound to a shader, that contains texture or buffer data (it is not limited to a single element type in the buffer). A shader-resource buffer is created with the flag and is bound to the pipeline using one of these APIs: , , or . Furthermore, a shader-resource buffer cannot use the flag.

+
+ + ff476085 + D3D11_BIND_FLAG + D3D11_BIND_FLAG +
+ + +

Bind a buffer as a vertex buffer to the input-assembler stage.

+
+ + ff476085 + D3D11_BIND_VERTEX_BUFFER + D3D11_BIND_VERTEX_BUFFER +
+ + +

Bind a buffer as an index buffer to the input-assembler stage.

+
+ + ff476085 + D3D11_BIND_INDEX_BUFFER + D3D11_BIND_INDEX_BUFFER +
+ + +

Bind a buffer as a constant buffer to a shader stage; this flag may NOT be combined with any other bind flag.

+
+ + ff476085 + D3D11_BIND_CONSTANT_BUFFER + D3D11_BIND_CONSTANT_BUFFER +
+ + +

Bind a buffer or texture to a shader stage; this flag cannot be used with the flag.

+
+ + ff476085 + D3D11_BIND_SHADER_RESOURCE + D3D11_BIND_SHADER_RESOURCE +
+ + +

Bind an output buffer for the stream-output stage.

+
+ + ff476085 + D3D11_BIND_STREAM_OUTPUT + D3D11_BIND_STREAM_OUTPUT +
+ + +

Bind a texture as a render target for the output-merger stage.

+
+ + ff476085 + D3D11_BIND_RENDER_TARGET + D3D11_BIND_RENDER_TARGET +
+ + +

Bind a texture as a depth-stencil target for the output-merger stage.

+
+ + ff476085 + D3D11_BIND_DEPTH_STENCIL + D3D11_BIND_DEPTH_STENCIL +
+ + +

Bind an unordered access resource.

+
+ + ff476085 + D3D11_BIND_UNORDERED_ACCESS + D3D11_BIND_UNORDERED_ACCESS +
+ + + None. + + + None + None + + + +

RGB or alpha blending operation.

+
+ +

The runtime implements RGB blending and alpha blending separately. Therefore, blend state requires separate blend operations for RGB data and alpha data. These blend operations are specified in a blend description. The two sources?Source 1, called SrcBlend and SrcBlendAlpha, and Source 2, called DestBlend and DestBlendAlpha?are shown in the blending block diagram.

+
+ + ff476088 + D3D11_BLEND_OP + D3D11_BLEND_OP +
+ + +

Add source 1 and source 2.

+
+ + ff476088 + D3D11_BLEND_OP_ADD + D3D11_BLEND_OP_ADD +
+ + +

Subtract source 1 from source 2.

+
+ + ff476088 + D3D11_BLEND_OP_SUBTRACT + D3D11_BLEND_OP_SUBTRACT +
+ + +

Subtract source 2 from source 1.

+
+ + ff476088 + D3D11_BLEND_OP_REV_SUBTRACT + D3D11_BLEND_OP_REV_SUBTRACT +
+ + +

Find the minimum of source 1 and source 2.

+
+ + ff476088 + D3D11_BLEND_OP_MIN + D3D11_BLEND_OP_MIN +
+ + +

Find the maximum of source 1 and source 2.

+
+ + ff476088 + D3D11_BLEND_OP_MAX + D3D11_BLEND_OP_MAX +
+ + +

Applies to: desktop apps | Metro style apps

Blend options. A blend option identifies the data source and an optional pre-blend operation.

+
+ +

Blend operations are specified in a blend description.

+
+ + ff476086 + D3D11_BLEND + D3D11_BLEND +
+ + +

The data source is the color black (0, 0, 0, 0). No pre-blend operation.

+
+ + ff476086 + D3D11_BLEND_ZERO + D3D11_BLEND_ZERO +
+ + +

The data source is the color white (1, 1, 1, 1). No pre-blend operation.

+
+ + ff476086 + D3D11_BLEND_ONE + D3D11_BLEND_ONE +
+ + +

The data source is color data (RGB) from a pixel shader. No pre-blend operation.

+
+ + ff476086 + D3D11_BLEND_SRC_COLOR + D3D11_BLEND_SRC_COLOR +
+ + +

The data source is color data (RGB) from a pixel shader. The pre-blend operation inverts the data, generating 1 - RGB.

+
+ + ff476086 + D3D11_BLEND_INV_SRC_COLOR + D3D11_BLEND_INV_SRC_COLOR +
+ + +

The data source is alpha data (A) from a pixel shader. No pre-blend operation.

+
+ + ff476086 + D3D11_BLEND_SRC_ALPHA + D3D11_BLEND_SRC_ALPHA +
+ + +

The data source is alpha data (A) from a pixel shader. The pre-blend operation inverts the data, generating 1 - A.

+
+ + ff476086 + D3D11_BLEND_INV_SRC_ALPHA + D3D11_BLEND_INV_SRC_ALPHA +
+ + +

The data source is alpha data from a rendertarget. No pre-blend operation.

+
+ + ff476086 + D3D11_BLEND_DEST_ALPHA + D3D11_BLEND_DEST_ALPHA +
+ + +

The data source is alpha data from a rendertarget. The pre-blend operation inverts the data, generating 1 - A.

+
+ + ff476086 + D3D11_BLEND_INV_DEST_ALPHA + D3D11_BLEND_INV_DEST_ALPHA +
+ + +

The data source is color data from a rendertarget. No pre-blend operation.

+
+ + ff476086 + D3D11_BLEND_DEST_COLOR + D3D11_BLEND_DEST_COLOR +
+ + +

The data source is color data from a rendertarget. The pre-blend operation inverts the data, generating 1 - RGB.

+
+ + ff476086 + D3D11_BLEND_INV_DEST_COLOR + D3D11_BLEND_INV_DEST_COLOR +
+ + +

The data source is alpha data from a pixel shader. The pre-blend operation clamps the data to 1 or less. +

+
+ + ff476086 + D3D11_BLEND_SRC_ALPHA_SAT + D3D11_BLEND_SRC_ALPHA_SAT +
+ + +

The data source is the blend factor set with . No pre-blend operation.

+
+ + ff476086 + D3D11_BLEND_BLEND_FACTOR + D3D11_BLEND_BLEND_FACTOR +
+ + +

The data source is the blend factor set with . The pre-blend operation inverts the blend factor, generating 1 - blend_factor.

+
+ + ff476086 + D3D11_BLEND_INV_BLEND_FACTOR + D3D11_BLEND_INV_BLEND_FACTOR +
+ + +

The data sources are both color data output by a pixel shader. There is no pre-blend operation. This options supports dual-source color blending.

+
+ + ff476086 + D3D11_BLEND_SRC1_COLOR + D3D11_BLEND_SRC1_COLOR +
+ + +

The data sources are both color data output by a pixel shader. The pre-blend operation inverts the data, generating 1 - RGB. This options supports dual-source color blending.

+
+ + ff476086 + D3D11_BLEND_INV_SRC1_COLOR + D3D11_BLEND_INV_SRC1_COLOR +
+ + +

The data sources are alpha data output by a pixel shader. There is no pre-blend operation. This options supports dual-source color blending.

+
+ + ff476086 + D3D11_BLEND_SRC1_ALPHA + D3D11_BLEND_SRC1_ALPHA +
+ + +

The data sources are alpha data output by a pixel shader. The pre-blend operation inverts the data, generating 1 - A. This options supports dual-source color blending.

+
+ + ff476086 + D3D11_BLEND_INV_SRC1_ALPHA + D3D11_BLEND_INV_SRC1_ALPHA +
+ + +

These flags are used by functions which operate on one or more channels in a texture.

+
+ + ff476302 + D3DX11_CHANNEL_FLAG + D3DX11_CHANNEL_FLAG +
+ + +

Indicates the red channel should be used.

+
+ + ff476302 + D3DX11_CHANNEL_RED + D3DX11_CHANNEL_RED +
+ + +

Indicates the blue channel should be used.

+
+ + ff476302 + D3DX11_CHANNEL_BLUE + D3DX11_CHANNEL_BLUE +
+ + +

Indicates the green channel should be used.

+
+ + ff476302 + D3DX11_CHANNEL_GREEN + D3DX11_CHANNEL_GREEN +
+ + +

Indicates the alpha channel should be used.

+
+ + ff476302 + D3DX11_CHANNEL_ALPHA + D3DX11_CHANNEL_ALPHA +
+ + +

Indicates the luminaces of the red, green, and blue channels should be used.

+
+ + ff476302 + D3DX11_CHANNEL_LUMINANCE + D3DX11_CHANNEL_LUMINANCE +
+ + + None. + + + None + None + + + +

Identify which components of each pixel of a render target are writable during blending.

+
+ +

These flags can be combined with a bitwise OR.

+
+ + ff476100 + D3D11_COLOR_WRITE_ENABLE + D3D11_COLOR_WRITE_ENABLE +
+ + +

Allow data to be stored in the red component.

+
+ + ff476100 + D3D11_COLOR_WRITE_ENABLE_RED + D3D11_COLOR_WRITE_ENABLE_RED +
+ + +

Allow data to be stored in the green component.

+
+ + ff476100 + D3D11_COLOR_WRITE_ENABLE_GREEN + D3D11_COLOR_WRITE_ENABLE_GREEN +
+ + +

Allow data to be stored in the blue component.

+
+ + ff476100 + D3D11_COLOR_WRITE_ENABLE_BLUE + D3D11_COLOR_WRITE_ENABLE_BLUE +
+ + +

Allow data to be stored in the alpha component.

+
+ + ff476100 + D3D11_COLOR_WRITE_ENABLE_ALPHA + D3D11_COLOR_WRITE_ENABLE_ALPHA +
+ + +

Allow data to be stored in all components.

+
+ + ff476100 + D3D11_COLOR_WRITE_ENABLE_ALL + D3D11_COLOR_WRITE_ENABLE_ALL +
+ + +

Comparison options.

+
+ +

A comparison option determines whether how the runtime compares source (new) data against destination (existing) data before storing the new data. The comparison option is declared in a description before an object is created. The API allows you to set a comparison option for a depth-stencil buffer (see ), depth-stencil operations (see ), or sampler state (see ).

+
+ + ff476101 + D3D11_COMPARISON_FUNC + D3D11_COMPARISON_FUNC +
+ + +

Never pass the comparison.

+
+ + ff476101 + D3D11_COMPARISON_NEVER + D3D11_COMPARISON_NEVER +
+ + +

If the source data is less than the destination data, the comparison passes.

+
+ + ff476101 + D3D11_COMPARISON_LESS + D3D11_COMPARISON_LESS +
+ + +

If the source data is equal to the destination data, the comparison passes.

+
+ + ff476101 + D3D11_COMPARISON_EQUAL + D3D11_COMPARISON_EQUAL +
+ + +

If the source data is less than or equal to the destination data, the comparison passes.

+
+ + ff476101 + D3D11_COMPARISON_LESS_EQUAL + D3D11_COMPARISON_LESS_EQUAL +
+ + +

If the source data is greater than the destination data, the comparison passes.

+
+ + ff476101 + D3D11_COMPARISON_GREATER + D3D11_COMPARISON_GREATER +
+ + +

If the source data is not equal to the destination data, the comparison passes.

+
+ + ff476101 + D3D11_COMPARISON_NOT_EQUAL + D3D11_COMPARISON_NOT_EQUAL +
+ + +

If the source data is greater than or equal to the destination data, the comparison passes.

+
+ + ff476101 + D3D11_COMPARISON_GREATER_EQUAL + D3D11_COMPARISON_GREATER_EQUAL +
+ + +

Always pass the comparison.

+
+ + ff476101 + D3D11_COMPARISON_ALWAYS + D3D11_COMPARISON_ALWAYS +
+ + +

Unordered resource support options for a compute shader resource (see ).

+
+ + ff476135 + D3D11_FORMAT_SUPPORT2 + D3D11_FORMAT_SUPPORT2 +
+ + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_ADD + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_ADD + + + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_BITWISE_OPS + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_BITWISE_OPS + + + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_COMPARE_STORE_OR_COMPARE_EXCHANGE + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_COMPARE_STORE_OR_COMPARE_EXCHANGE + + + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_EXCHANGE + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_EXCHANGE + + + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_SIGNED_MIN_OR_MAX + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_SIGNED_MIN_OR_MAX + + + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_UNSIGNED_MIN_OR_MAX + D3D11_FORMAT_SUPPORT2_UAV_ATOMIC_UNSIGNED_MIN_OR_MAX + + + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_TYPED_LOAD + D3D11_FORMAT_SUPPORT2_UAV_TYPED_LOAD + + + + No documentation. + + + D3D11_FORMAT_SUPPORT2_UAV_TYPED_STORE + D3D11_FORMAT_SUPPORT2_UAV_TYPED_STORE + + + + None. + + + None + None + + + +

Describes a counter.

+
+ +

This structure is used by , and .

+
+ + ff476103 + D3D11_COUNTER + D3D11_COUNTER +
+ + +

Type of counter (see ).

+
+ + ff476103 + D3D11_COUNTER_DEVICE_DEPENDENT_0 + D3D11_COUNTER_DEVICE_DEPENDENT_0 +
+ + +

Data type of a performance counter.

+
+ +

These flags are an output parameter in .

+
+ + ff476105 + D3D11_COUNTER_TYPE + D3D11_COUNTER_TYPE +
+ + +

32-bit floating point.

+
+ + ff476105 + D3D11_COUNTER_TYPE_FLOAT32 + D3D11_COUNTER_TYPE_FLOAT32 +
+ + +

16-bit unsigned integer.

+
+ + ff476105 + D3D11_COUNTER_TYPE_UINT16 + D3D11_COUNTER_TYPE_UINT16 +
+ + +

32-bit unsigned integer.

+
+ + ff476105 + D3D11_COUNTER_TYPE_UINT32 + D3D11_COUNTER_TYPE_UINT32 +
+ + +

64-bit unsigned integer.

+
+ + ff476105 + D3D11_COUNTER_TYPE_UINT64 + D3D11_COUNTER_TYPE_UINT64 +
+ + +

Specifies the types of CPU access allowed for a resource.

+
+ +

This enumeration is used in , , , .

Applications may combine one or more of these flags with a logical OR. When possible, create resources with no CPU access flags, as this enables better resource optimiztion.

+
+ + ff476106 + D3D11_CPU_ACCESS_FLAG + D3D11_CPU_ACCESS_FLAG +
+ + +

The resource is to be mappable so that the CPU can change its contents. Resources created with this flag cannot be set as outputs of the pipeline and must be created with either dynamic or staging usage (see ).

+
+ + ff476106 + D3D11_CPU_ACCESS_WRITE + D3D11_CPU_ACCESS_WRITE +
+ + +

The resource is to be mappable so that the CPU can read its contents. Resources created with this flag cannot be set as either inputs or outputs to the pipeline and must be created with staging usage (see ).

+
+ + ff476106 + D3D11_CPU_ACCESS_READ + D3D11_CPU_ACCESS_READ +
+ + + None. + + + None + None + + + +

Indicates triangles facing a particular direction are not drawn.

+
+ +

This enumeration is part of a rasterizer-state object description (see ).

+
+ + ff476108 + D3D11_CULL_MODE + D3D11_CULL_MODE +
+ + +

Always draw all triangles.

+
+ + ff476108 + D3D11_CULL_NONE + D3D11_CULL_NONE +
+ + +

Do not draw triangles that are front-facing.

+
+ + ff476108 + D3D11_CULL_FRONT + D3D11_CULL_FRONT +
+ + +

Do not draw triangles that are back-facing.

+
+ + ff476108 + D3D11_CULL_BACK + D3D11_CULL_BACK +
+ + + No documentation. + + + D3D11_DEBUG_FEATURE_FLAGS + D3D11_DEBUG_FEATURE_FLAGS + + + + No documentation. + + + D3D11_DEBUG_FEATURE_FLUSH_PER_RENDER_OP + D3D11_DEBUG_FEATURE_FLUSH_PER_RENDER_OP + + + + No documentation. + + + D3D11_DEBUG_FEATURE_FINISH_PER_RENDER_OP + D3D11_DEBUG_FEATURE_FINISH_PER_RENDER_OP + + + + No documentation. + + + D3D11_DEBUG_FEATURE_PRESENT_PER_RENDER_OP + D3D11_DEBUG_FEATURE_PRESENT_PER_RENDER_OP + + + +

Specifies the parts of the depth stencil to clear.

+
+ +

These flags are used when calling ; the flags can be combined with a bitwise OR.

+
+ + ff476099 + D3D11_CLEAR_FLAG + D3D11_CLEAR_FLAG +
+ + +

Clear the depth buffer.

+
+ + ff476099 + D3D11_CLEAR_DEPTH + D3D11_CLEAR_DEPTH +
+ + +

Clear the stencil buffer.

+
+ + ff476099 + D3D11_CLEAR_STENCIL + D3D11_CLEAR_STENCIL +
+ + +

Specifies how to access a resource used in a depth-stencil view.

+
+ +

This enumeration is used in to create a depth-stencil view.

+
+ + ff476115 + D3D11_DSV_DIMENSION + D3D11_DSV_DIMENSION +
+ + +

is not a valid value for and is not used.

+
+ + ff476115 + D3D11_DSV_DIMENSION_UNKNOWN + D3D11_DSV_DIMENSION_UNKNOWN +
+ + +

The resource will be accessed as a 1D texture.

+
+ + ff476115 + D3D11_DSV_DIMENSION_TEXTURE1D + D3D11_DSV_DIMENSION_TEXTURE1D +
+ + +

The resource will be accessed as an array of 1D textures.

+
+ + ff476115 + D3D11_DSV_DIMENSION_TEXTURE1DARRAY + D3D11_DSV_DIMENSION_TEXTURE1DARRAY +
+ + +

The resource will be accessed as a 2D texture.

+
+ + ff476115 + D3D11_DSV_DIMENSION_TEXTURE2D + D3D11_DSV_DIMENSION_TEXTURE2D +
+ + +

The resource will be accessed as an array of 2D textures.

+
+ + ff476115 + D3D11_DSV_DIMENSION_TEXTURE2DARRAY + D3D11_DSV_DIMENSION_TEXTURE2DARRAY +
+ + +

The resource will be accessed as a 2D texture with multisampling.

+
+ + ff476115 + D3D11_DSV_DIMENSION_TEXTURE2DMS + D3D11_DSV_DIMENSION_TEXTURE2DMS +
+ + +

The resource will be accessed as an array of 2D textures with multisampling.

+
+ + ff476115 + D3D11_DSV_DIMENSION_TEXTURE2DMSARRAY + D3D11_DSV_DIMENSION_TEXTURE2DMSARRAY +
+ + +

Depth-stencil view options.

+
+ +

This enumeration is used by .

Limiting a depth-stencil buffer to read-only access allows more than one depth-stencil view to be bound to the pipeline simultaneously, since it is not possible to have a read/write conflicts between separate views.

+
+ + ff476116 + D3D11_DSV_FLAG + D3D11_DSV_FLAG +
+ + +

Indicates that depth values are read only.

+
+ + ff476116 + D3D11_DSV_READ_ONLY_DEPTH + D3D11_DSV_READ_ONLY_DEPTH +
+ + +

Indicates that stencil values are read only.

+
+ + ff476116 + D3D11_DSV_READ_ONLY_STENCIL + D3D11_DSV_READ_ONLY_STENCIL +
+ + + None. + + + None + None + + + +

Identify the portion of a depth-stencil buffer for writing depth data.

+
+ + ff476113 + D3D11_DEPTH_WRITE_MASK + D3D11_DEPTH_WRITE_MASK +
+ + +

Turn off writes to the depth-stencil buffer.

+
+ + ff476113 + D3D11_DEPTH_WRITE_MASK_ZERO + D3D11_DEPTH_WRITE_MASK_ZERO +
+ + +

Turn on writes to the depth-stencil buffer.

+
+ + ff476113 + D3D11_DEPTH_WRITE_MASK_ALL + D3D11_DEPTH_WRITE_MASK_ALL +
+ + +

Device context options.

+
+ +

This enumeration is used by .

+
+ + ff476114 + D3D11_DEVICE_CONTEXT_TYPE + D3D11_DEVICE_CONTEXT_TYPE +
+ + +

The device context is an immediate context.

+
+ + ff476114 + D3D11_DEVICE_CONTEXT_IMMEDIATE + D3D11_DEVICE_CONTEXT_IMMEDIATE +
+ + +

The device context is a deferred context.

+
+ + ff476114 + D3D11_DEVICE_CONTEXT_DEFERRED + D3D11_DEVICE_CONTEXT_DEFERRED +
+ + +

Describes parameters that are used to create a device.

+
+ +

Device creation flags are used by and .

An application might dynamically create (and destroy) threads to improve performance especially on a machine with multiple CPU cores. There may be cases, however, when an application needs to prevent extra threads from being created. This can happen when you want to simplify debugging, profile code or develop a tool for instance. For these cases, use to request that the runtime and video driver not create any additional threads that might interfere with the application.

+
+ + ff476107 + D3D11_CREATE_DEVICE_FLAG + D3D11_CREATE_DEVICE_FLAG +
+ + +

You should use this flag if your application will only call methods of Direct3D?11 interfaces from a single thread. By default, the object is thread-safe. By using this flag, you can increase performance. However, if you use this flag and your application calls methods of Direct3D?11 interfaces from multiple threads, undefined behavior might result.

+
+ + ff476107 + D3D11_CREATE_DEVICE_SINGLETHREADED + D3D11_CREATE_DEVICE_SINGLETHREADED +
+ + +

Creates a device that supports the debug layer.

+
+ + ff476107 + D3D11_CREATE_DEVICE_DEBUG + D3D11_CREATE_DEVICE_DEBUG +
+ + +

Note??This flag is not supported in Direct3D?11.

+
+ + ff476107 + D3D11_CREATE_DEVICE_SWITCH_TO_REF + D3D11_CREATE_DEVICE_SWITCH_TO_REF +
+ + +

Prevents multiple threads from being created. When this flag is used with a Windows Advanced Rasterization Platform (WARP) device, no additional threads will be created by WARP and all rasterization will occur on the calling thread. This flag is not recommended for general use. See remarks.

+
+ + ff476107 + D3D11_CREATE_DEVICE_PREVENT_INTERNAL_THREADING_OPTIMIZATIONS + D3D11_CREATE_DEVICE_PREVENT_INTERNAL_THREADING_OPTIMIZATIONS +
+ + +

Required for Direct2D interoperability with Direct3D resources.

+
+ + ff476107 + D3D11_CREATE_DEVICE_BGRA_SUPPORT + D3D11_CREATE_DEVICE_BGRA_SUPPORT +
+ + + None. + + + None + None + + + +

FFT creation flags.

+
+ + ff476309 + D3DX11_FFT_CREATE_FLAG + D3DX11_FFT_CREATE_FLAG +
+ + +

Do not AddRef or Release temp and precompute buffers, caller is responsible for holding references to these buffers.

+
+ + ff476309 + D3DX11_FFT_CREATE_FLAG_NO_PRECOMPUTE_BUFFERS + D3DX11_FFT_CREATE_FLAG_NO_PRECOMPUTE_BUFFERS +
+ + + None. + + + None + None + + + +

FFT data types.

+
+ + ff476310 + D3DX11_FFT_DATA_TYPE + D3DX11_FFT_DATA_TYPE +
+ + +

Real numbers.

+
+ + ff476310 + D3DX11_FFT_DATA_TYPE_REAL + D3DX11_FFT_DATA_TYPE_REAL +
+ + +

Complex numbers.

+
+ + ff476310 + D3DX11_FFT_DATA_TYPE_COMPLEX + D3DX11_FFT_DATA_TYPE_COMPLEX +
+ + +

Number of dimensions for FFT data.

+
+ + ff476312 + D3DX11_FFT_DIM_MASK + D3DX11_FFT_DIM_MASK +
+ + +

One dimension.

+
+ + ff476312 + D3DX11_FFT_DIM_MASK_1D + D3DX11_FFT_DIM_MASK_1D +
+ + +

Two dimensions.

+
+ + ff476312 + D3DX11_FFT_DIM_MASK_2D + D3DX11_FFT_DIM_MASK_2D +
+ + +

Three dimensions.

+
+ + ff476312 + D3DX11_FFT_DIM_MASK_3D + D3DX11_FFT_DIM_MASK_3D +
+ + +

Direct3D 11 feature options.

+
+ +

This enumeration is used when querying a driver about support for these features by calling . Each value in this enumeration has a corresponding data structure that is required to be passed to the pFeatureSupportData parameter of .

The following table shows the structures associated with each enumerant.

EnumerantAssociated Structure
D3D11_FEATURE_D3D11_OPTIONS D3D11_FEATURE_DATA_D3D11_OPTIONS
D3D11_FEATURE_ARCHITECTURE_INFO D3D11_FEATURE_DATA_ARCHITECTURE_INFO
D3D11_FEATURE_D3D9_OPTIONS D3D11_FEATURE_DATA_D3D9_OPTIONS
D3D11_FEATURE_SHADER_MIN_PRECISION_SUPPORT D3D11_FEATURE_DATA_SHADER_MIN_PRECISION_SUPPORT

?

+
+ + ff476124 + D3D11_FEATURE + D3D11_FEATURE +
+ + +

The driver supports multithreading. To see an example of testing a driver for multithread support, see How To: Check for Driver Support.

+
+ + ff476124 + D3D11_FEATURE_THREADING + D3D11_FEATURE_THREADING +
+ + +

Supports the use of the double-precision shaders in HLSL.

+
+ + ff476124 + D3D11_FEATURE_DOUBLES + D3D11_FEATURE_DOUBLES +
+ + +

Supports the formats in .

+
+ + ff476124 + D3D11_FEATURE_FORMAT_SUPPORT + D3D11_FEATURE_FORMAT_SUPPORT +
+ + +

Supports the formats in .

+
+ + ff476124 + D3D11_FEATURE_FORMAT_SUPPORT2 + D3D11_FEATURE_FORMAT_SUPPORT2 +
+ + +

Supports compute shaders and raw and structured buffers.

+
+ + ff476124 + D3D11_FEATURE_D3D10_X_HARDWARE_OPTIONS + D3D11_FEATURE_D3D10_X_HARDWARE_OPTIONS +
+ + +

Determines the fill mode to use when rendering triangles.

+
+ +

This enumeration is part of a rasterizer-state object description (see ).

+
+ + ff476131 + D3D11_FILL_MODE + D3D11_FILL_MODE +
+ + +

Draw lines connecting the vertices. Adjacent vertices are not drawn.

+
+ + ff476131 + D3D11_FILL_WIREFRAME + D3D11_FILL_WIREFRAME +
+ + +

Fill the triangles formed by the vertices. Adjacent vertices are not drawn.

+
+ + ff476131 + D3D11_FILL_SOLID + D3D11_FILL_SOLID +
+ + +

Types of magnification or minification sampler filters.

+
+ + ff476133 + D3D11_FILTER + D3D11_FILTER +
+ + +

Point filtering used as a texture magnification or minification filter. The texel with coordinates nearest to the desired pixel value is used. The texture filter to be used between mipmap levels is nearest-point mipmap filtering. The rasterizer uses the color from the texel of the nearest mipmap texture.

+
+ + ff476133 + D3D11_FILTER_MIN_MAG_MIP_POINT + D3D11_FILTER_MIN_MAG_MIP_POINT +
+ + +

Bilinear interpolation filtering used as a texture magnification or minification filter. A weighted average of a 2 x 2 area of texels surrounding the desired pixel is used. The texture filter to use between mipmap levels is trilinear mipmap interpolation. The rasterizer linearly interpolates pixel color, using the texels of the two nearest mipmap textures.

+
+ + ff476133 + D3D11_FILTER_MIN_MAG_POINT_MIP_LINEAR + D3D11_FILTER_MIN_MAG_POINT_MIP_LINEAR +
+ + + No documentation. + + + D3D11_FILTER_MIN_POINT_MAG_LINEAR_MIP_POINT + D3D11_FILTER_MIN_POINT_MAG_LINEAR_MIP_POINT + + + + No documentation. + + + D3D11_FILTER_MIN_POINT_MAG_MIP_LINEAR + D3D11_FILTER_MIN_POINT_MAG_MIP_LINEAR + + + + No documentation. + + + D3D11_FILTER_MIN_LINEAR_MAG_MIP_POINT + D3D11_FILTER_MIN_LINEAR_MAG_MIP_POINT + + + + No documentation. + + + D3D11_FILTER_MIN_LINEAR_MAG_POINT_MIP_LINEAR + D3D11_FILTER_MIN_LINEAR_MAG_POINT_MIP_LINEAR + + + + No documentation. + + + D3D11_FILTER_MIN_MAG_LINEAR_MIP_POINT + D3D11_FILTER_MIN_MAG_LINEAR_MIP_POINT + + + + No documentation. + + + D3D11_FILTER_MIN_MAG_MIP_LINEAR + D3D11_FILTER_MIN_MAG_MIP_LINEAR + + + + No documentation. + + + D3D11_FILTER_ANISOTROPIC + D3D11_FILTER_ANISOTROPIC + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_MAG_MIP_POINT + D3D11_FILTER_COMPARISON_MIN_MAG_MIP_POINT + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_MAG_POINT_MIP_LINEAR + D3D11_FILTER_COMPARISON_MIN_MAG_POINT_MIP_LINEAR + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT + D3D11_FILTER_COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_POINT_MAG_MIP_LINEAR + D3D11_FILTER_COMPARISON_MIN_POINT_MAG_MIP_LINEAR + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_LINEAR_MAG_MIP_POINT + D3D11_FILTER_COMPARISON_MIN_LINEAR_MAG_MIP_POINT + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR + D3D11_FILTER_COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_MAG_LINEAR_MIP_POINT + D3D11_FILTER_COMPARISON_MIN_MAG_LINEAR_MIP_POINT + + + + No documentation. + + + D3D11_FILTER_COMPARISON_MIN_MAG_MIP_LINEAR + D3D11_FILTER_COMPARISON_MIN_MAG_MIP_LINEAR + + + + No documentation. + + + D3D11_FILTER_COMPARISON_ANISOTROPIC + D3D11_FILTER_COMPARISON_ANISOTROPIC + + + +

Texture filtering flags.

+
+ +

D3DX11 automatically performs gamma correction (to convert color data from RGB space to standard RGB space) when loading texture data. This is automatically done for instance when RGB data is loaded from a .png file into an sRGB texture. Use the SRGB filter flags to indicate if the data does not need to be converted into sRGB space.

+
+ + ff476313 + D3DX11_FILTER_FLAG + D3DX11_FILTER_FLAG +
+ + +

No scaling or filtering will take place. Pixels outside the bounds of the source image are assumed to be transparent black.

+
+ + ff476313 + D3DX11_FILTER_NONE + D3DX11_FILTER_NONE +
+ + +

Each destination pixel is computed by sampling the nearest pixel from the source image.

+
+ + ff476313 + D3DX11_FILTER_POINT + D3DX11_FILTER_POINT +
+ + +

Each destination pixel is computed by sampling the four nearest pixels from the source image. This filter works best when the scale on both axes is less than two.

+
+ + ff476313 + D3DX11_FILTER_LINEAR + D3DX11_FILTER_LINEAR +
+ + +

Every pixel in the source image contributes equally to the destination image. This is the slowest of the filters.

+
+ + ff476313 + D3DX11_FILTER_TRIANGLE + D3DX11_FILTER_TRIANGLE +
+ + +

Each pixel is computed by averaging a 2x2(x2) box of pixels from the source image. This filter works only when the dimensions of the destination are half those of the source, as is the case with mipmaps.

+
+ + ff476313 + D3DX11_FILTER_BOX + D3DX11_FILTER_BOX +
+ + +

Pixels off the edge of the texture on the u-axis should be mirrored, not wrapped.

+
+ + ff476313 + D3DX11_FILTER_MIRROR_U + D3DX11_FILTER_MIRROR_U +
+ + +

Pixels off the edge of the texture on the v-axis should be mirrored, not wrapped.

+
+ + ff476313 + D3DX11_FILTER_MIRROR_V + D3DX11_FILTER_MIRROR_V +
+ + +

Pixels off the edge of the texture on the w-axis should be mirrored, not wrapped.

+
+ + ff476313 + D3DX11_FILTER_MIRROR_W + D3DX11_FILTER_MIRROR_W +
+ + +

Specifying this flag is the same as specifying the , , and flags.

+
+ + ff476313 + D3DX11_FILTER_MIRROR + D3DX11_FILTER_MIRROR +
+ + +

The resulting image must be dithered using a 4x4 ordered dither algorithm. This happens when converting from one format to another.

+
+ + ff476313 + D3DX11_FILTER_DITHER + D3DX11_FILTER_DITHER +
+ + +

Do diffuse dithering on the image when changing from one format to another.

+
+ + ff476313 + D3DX11_FILTER_DITHER_DIFFUSION + D3DX11_FILTER_DITHER_DIFFUSION +
+ + +

Input data is in standard RGB (sRGB) color space. See remarks.

+
+ + ff476313 + D3DX11_FILTER_SRGB_IN + D3DX11_FILTER_SRGB_IN +
+ + +

Output data is in standard RGB (sRGB) color space. See remarks.

+
+ + ff476313 + D3DX11_FILTER_SRGB_OUT + D3DX11_FILTER_SRGB_OUT +
+ + +

Same as specifying | . See remarks.

+
+ + ff476313 + D3DX11_FILTER_SRGB + D3DX11_FILTER_SRGB +
+ + +

Types of magnification or minification sampler filters.

+
+ + ff476133 + D3D11_FILTER_TYPE + D3D11_FILTER_TYPE +
+ + +

Point filtering used as a texture magnification or minification filter. The texel with coordinates nearest to the desired pixel value is used. The texture filter to be used between mipmap levels is nearest-point mipmap filtering. The rasterizer uses the color from the texel of the nearest mipmap texture.

+
+ + ff476133 + D3D11_FILTER_TYPE_POINT + D3D11_FILTER_TYPE_POINT +
+ + +

Bilinear interpolation filtering used as a texture magnification or minification filter. A weighted average of a 2 x 2 area of texels surrounding the desired pixel is used. The texture filter to use between mipmap levels is trilinear mipmap interpolation. The rasterizer linearly interpolates pixel color, using the texels of the two nearest mipmap textures.

+
+ + ff476133 + D3D11_FILTER_TYPE_LINEAR + D3D11_FILTER_TYPE_LINEAR +
+ + +

Which resources are supported for a given format and given device (see and ).

+
+ + ff476134 + D3D11_FORMAT_SUPPORT + D3D11_FORMAT_SUPPORT +
+ + + No documentation. + + + D3D11_FORMAT_SUPPORT_BUFFER + D3D11_FORMAT_SUPPORT_BUFFER + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_IA_VERTEX_BUFFER + D3D11_FORMAT_SUPPORT_IA_VERTEX_BUFFER + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_IA_INDEX_BUFFER + D3D11_FORMAT_SUPPORT_IA_INDEX_BUFFER + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_SO_BUFFER + D3D11_FORMAT_SUPPORT_SO_BUFFER + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_TEXTURE1D + D3D11_FORMAT_SUPPORT_TEXTURE1D + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_TEXTURE2D + D3D11_FORMAT_SUPPORT_TEXTURE2D + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_TEXTURE3D + D3D11_FORMAT_SUPPORT_TEXTURE3D + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_TEXTURECUBE + D3D11_FORMAT_SUPPORT_TEXTURECUBE + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_SHADER_LOAD + D3D11_FORMAT_SUPPORT_SHADER_LOAD + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_SHADER_SAMPLE + D3D11_FORMAT_SUPPORT_SHADER_SAMPLE + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_SHADER_SAMPLE_COMPARISON + D3D11_FORMAT_SUPPORT_SHADER_SAMPLE_COMPARISON + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_SHADER_SAMPLE_MONO_TEXT + D3D11_FORMAT_SUPPORT_SHADER_SAMPLE_MONO_TEXT + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_MIP + D3D11_FORMAT_SUPPORT_MIP + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_MIP_AUTOGEN + D3D11_FORMAT_SUPPORT_MIP_AUTOGEN + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_RENDER_TARGET + D3D11_FORMAT_SUPPORT_RENDER_TARGET + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_BLENDABLE + D3D11_FORMAT_SUPPORT_BLENDABLE + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_DEPTH_STENCIL + D3D11_FORMAT_SUPPORT_DEPTH_STENCIL + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_CPU_LOCKABLE + D3D11_FORMAT_SUPPORT_CPU_LOCKABLE + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_MULTISAMPLE_RESOLVE + D3D11_FORMAT_SUPPORT_MULTISAMPLE_RESOLVE + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_DISPLAY + D3D11_FORMAT_SUPPORT_DISPLAY + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_CAST_WITHIN_BIT_LAYOUT + D3D11_FORMAT_SUPPORT_CAST_WITHIN_BIT_LAYOUT + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_MULTISAMPLE_RENDERTARGET + D3D11_FORMAT_SUPPORT_MULTISAMPLE_RENDERTARGET + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_MULTISAMPLE_LOAD + D3D11_FORMAT_SUPPORT_MULTISAMPLE_LOAD + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_SHADER_GATHER + D3D11_FORMAT_SUPPORT_SHADER_GATHER + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_BACK_BUFFER_CAST + D3D11_FORMAT_SUPPORT_BACK_BUFFER_CAST + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_TYPED_UNORDERED_ACCESS_VIEW + D3D11_FORMAT_SUPPORT_TYPED_UNORDERED_ACCESS_VIEW + + + + No documentation. + + + D3D11_FORMAT_SUPPORT_SHADER_GATHER_COMPARISON + D3D11_FORMAT_SUPPORT_SHADER_GATHER_COMPARISON + + + + None. + + + None + None + + + +

Image file formats supported by D3DX11Createxxx and D3DX11Savexxx functions.

+
+ +

See Types of Bitmaps (GDI+) for more information on some of these formats.

+
+ + ff476315 + D3DX11_IMAGE_FILE_FORMAT + D3DX11_IMAGE_FILE_FORMAT +
+ + +

Windows bitmap (BMP) file format. Contains a header that describes the resolution of the device on which the rectangle of pixels was created, the dimensions of the rectangle, the size of the array of bits, a logical palette, and an array of bits that defines the relationship between pixels in the bitmapped image and entries in the logical palette. The file extension for this format is .bmp.

+
+ + ff476315 + D3DX11_IFF_BMP + D3DX11_IFF_BMP +
+ + +

Joint Photographic Experts Group (JPEG) compressed file format. Specifies variable compression of 24-bit RGB color and 8-bit gray-scale Tagged Image File Format (TIFF) image document files. The file extension for this format is .jpg.

+
+ + ff476315 + D3DX11_IFF_JPG + D3DX11_IFF_JPG +
+ + +

Portable Network Graphics (PNG) file format. A non-proprietary bitmap format using lossless compression. The file extension for this format is .png.

+
+ + ff476315 + D3DX11_IFF_PNG + D3DX11_IFF_PNG +
+ + +

DirectDraw surface (DDS) file format. Stores textures, volume textures, and cubic environment maps, with or without mipmap levels, and with or without pixel compression. The file extension for this format is .dds.

+
+ + ff476315 + D3DX11_IFF_DDS + D3DX11_IFF_DDS +
+ + +

Tagged Image File Format (TIFF). The file extensions for this format are .tif and .tiff.

+
+ + ff476315 + D3DX11_IFF_TIFF + D3DX11_IFF_TIFF +
+ + +

Graphics Interchange Format (GIF). The file extension for this format is .gif.

+
+ + ff476315 + D3DX11_IFF_GIF + D3DX11_IFF_GIF +
+ + +

Windows Media Photo format (WMP). This format is also known as HD Photo and JPEG XR. The file extensions for this format are .hdp, .jxr, and .wdp.

To work properly, requires that you initialize COM. Therefore, call CoInitialize or CoInitializeEx in your application before you call D3DX.

+
+ + ff476315 + D3DX11_IFF_WMP + D3DX11_IFF_WMP +
+ + +

Type of data contained in an input slot.

+
+ +

Use these values to specify the type of data for a particular input element (see ) of an input-layout object.

+
+ + ff476179 + D3D11_INPUT_CLASSIFICATION + D3D11_INPUT_CLASSIFICATION +
+ + +

Input data is per-vertex data.

+
+ + ff476179 + D3D11_INPUT_PER_VERTEX_DATA + D3D11_INPUT_PER_VERTEX_DATA +
+ + +

Input data is per-instance data.

+
+ + ff476179 + D3D11_INPUT_PER_INSTANCE_DATA + D3D11_INPUT_PER_INSTANCE_DATA +
+ + +

Specifies how the CPU should respond when an application calls the method on a resource that is being used by the GPU.

+
+ +

This enumeration is used by .

cannot be used with or D3D11_MAP_WRITE_NOOVERWRITE.

+
+ + ff476183 + D3D11_MAP_FLAG + D3D11_MAP_FLAG +
+ + + No documentation. + + + D3D11_MAP_FLAG_DO_NOT_WAIT + D3D11_MAP_FLAG_DO_NOT_WAIT + + + + None. + + + None + None + + + +

Identifies a resource to be accessed for reading and writing by the CPU. Applications may combine one or more of these flags.

+
+ +

This enumeration is used in .

These remarks are divided into the following topics:

  • Meaning
  • Common
Meaning of

signifies that the application promises not to write to data that the input assembler (IA) stage is using. In exchange, the GPU allows the application to write to other parts of the same buffer. The application must ensure that it does not write over any data in use by the IA stage.

For example, consider the buffer illustrated in the following diagram. If a Draw call has been issued that uses vertices 4-6, then an application that calls Map on this buffer must ensure that it does not write to the vertices that the Draw call will access during rendering.

However, ensuring this can be difficult, because the GPU is often many frames behind the CPU in terms of which frame it is currently processing. Keeping track of which sections of a resource are being used because of calls made 2 to 5 frames ago is difficult and error-prone. Because of this, it is recommended that applications only write to the uninitialized portions of a resource when using .

Common Usage of with

and are normally used in conjunction with dynamic index/vertex buffers. can also be used with dynamic textures. However, cannot be used with dynamic textures.

A common use of these two flags involves filling dynamic index/vertex buffers with geometry that can be seen from the camera's current position. The first time that data is entered into the buffer on a given frame, Map is called with ; doing so invalidates the previous contents of the buffer. The buffer is then filled with all available data.

Subsequent writes to the buffer within the same frame should use . This will enable the CPU to access a resource that is potentially being used by the GPU as long as the restrictions described previously are respected.

+
+ + ff476181 + D3D11_MAP + D3D11_MAP +
+ + +

Resource is mapped for reading. The resource must have been created with read access (see ).

+
+ + ff476181 + D3D11_MAP_READ + D3D11_MAP_READ +
+ + +

Resource is mapped for writing. The resource must have been created with write access (see ).

+
+ + ff476181 + D3D11_MAP_WRITE + D3D11_MAP_WRITE +
+ + +

Resource is mapped for reading and writing. The resource must have been created with read and write access (see and ).

+
+ + ff476181 + D3D11_MAP_READ_WRITE + D3D11_MAP_READ_WRITE +
+ + +

Resource is mapped for writing; the previous contents of the resource will be undefined. The resource must have been created with write access and dynamic usage (See and ).

+
+ + ff476181 + D3D11_MAP_WRITE_DISCARD + D3D11_MAP_WRITE_DISCARD +
+ + +

Resource is mapped for writing; the existing contents of the resource cannot be overwritten (see Remarks). This flag is only valid on vertex and index buffers. The resource must have been created with write access (see ). Cannot be used on a resource created with the flag.

+
+ + ff476181 + D3D11_MAP_WRITE_NO_OVERWRITE + D3D11_MAP_WRITE_NO_OVERWRITE +
+ + +

Categories of debug messages. This will identify the category of a message when retrieving a message with and when adding a message with . When creating an info queue filter, these values can be used to allow or deny any categories of messages to pass through the storage and retrieval filters.

+
+ +

This is part of the Information Queue feature. See Interface.

+
+ + ff476185 + D3D11_MESSAGE_CATEGORY + D3D11_MESSAGE_CATEGORY +
+ + + No documentation. + + + D3D11_MESSAGE_CATEGORY_APPLICATION_DEFINED + D3D11_MESSAGE_CATEGORY_APPLICATION_DEFINED + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_MISCELLANEOUS + D3D11_MESSAGE_CATEGORY_MISCELLANEOUS + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_INITIALIZATION + D3D11_MESSAGE_CATEGORY_INITIALIZATION + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_CLEANUP + D3D11_MESSAGE_CATEGORY_CLEANUP + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_COMPILATION + D3D11_MESSAGE_CATEGORY_COMPILATION + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_STATE_CREATION + D3D11_MESSAGE_CATEGORY_STATE_CREATION + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_STATE_SETTING + D3D11_MESSAGE_CATEGORY_STATE_SETTING + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_STATE_GETTING + D3D11_MESSAGE_CATEGORY_STATE_GETTING + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_RESOURCE_MANIPULATION + D3D11_MESSAGE_CATEGORY_RESOURCE_MANIPULATION + + + + No documentation. + + + D3D11_MESSAGE_CATEGORY_EXECUTION + D3D11_MESSAGE_CATEGORY_EXECUTION + + + + No documentation. + + + D3D11_MESSAGE_ID + D3D11_MESSAGE_ID + + + + No documentation. + + + D3D11_MESSAGE_ID_UNKNOWN + D3D11_MESSAGE_ID_UNKNOWN + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_HAZARD + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_HAZARD + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSSETSHADERRESOURCES_HAZARD + D3D11_MESSAGE_ID_DEVICE_VSSETSHADERRESOURCES_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSSETCONSTANTBUFFERS_HAZARD + D3D11_MESSAGE_ID_DEVICE_VSSETCONSTANTBUFFERS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSSETSHADERRESOURCES_HAZARD + D3D11_MESSAGE_ID_DEVICE_GSSETSHADERRESOURCES_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSSETCONSTANTBUFFERS_HAZARD + D3D11_MESSAGE_ID_DEVICE_GSSETCONSTANTBUFFERS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSSETSHADERRESOURCES_HAZARD + D3D11_MESSAGE_ID_DEVICE_PSSETSHADERRESOURCES_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSSETCONSTANTBUFFERS_HAZARD + D3D11_MESSAGE_ID_DEVICE_PSSETCONSTANTBUFFERS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETS_HAZARD + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SOSETTARGETS_HAZARD + D3D11_MESSAGE_ID_DEVICE_SOSETTARGETS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_STRING_FROM_APPLICATION + D3D11_MESSAGE_ID_STRING_FROM_APPLICATION + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_THIS + D3D11_MESSAGE_ID_CORRUPTED_THIS + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER1 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER1 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER2 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER2 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER3 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER3 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER4 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER4 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER5 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER5 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER6 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER6 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER7 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER7 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER8 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER8 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER9 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER9 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER10 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER10 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER11 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER11 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER12 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER12 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER13 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER13 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER14 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER14 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER15 + D3D11_MESSAGE_ID_CORRUPTED_PARAMETER15 + + + + No documentation. + + + D3D11_MESSAGE_ID_CORRUPTED_MULTITHREADING + D3D11_MESSAGE_ID_CORRUPTED_MULTITHREADING + + + + No documentation. + + + D3D11_MESSAGE_ID_MESSAGE_REPORTING_OUTOFMEMORY + D3D11_MESSAGE_ID_MESSAGE_REPORTING_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_IASETINPUTLAYOUT_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_IASETINPUTLAYOUT_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_IASETVERTEXBUFFERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_IASETVERTEXBUFFERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_IASETINDEXBUFFER_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_IASETINDEXBUFFER_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSETSHADER_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_VSSETSHADER_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_VSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_VSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSETSAMPLERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_VSSETSAMPLERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_GSSETSHADER_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_GSSETSHADER_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_GSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_GSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_GSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_GSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_GSSETSAMPLERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_GSSETSAMPLERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_SOSETTARGETS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_SOSETTARGETS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_PSSETSHADER_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_PSSETSHADER_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_PSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_PSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_PSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_PSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_PSSETSAMPLERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_PSSETSAMPLERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_RSSETSTATE_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_RSSETSTATE_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETBLENDSTATE_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_OMSETBLENDSTATE_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETDEPTHSTENCILSTATE_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_OMSETDEPTHSTENCILSTATE_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_SETPREDICATION_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_SETPREDICATION_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_GETPRIVATEDATA_MOREDATA + D3D11_MESSAGE_ID_GETPRIVATEDATA_MOREDATA + + + + No documentation. + + + D3D11_MESSAGE_ID_SETPRIVATEDATA_INVALIDFREEDATA + D3D11_MESSAGE_ID_SETPRIVATEDATA_INVALIDFREEDATA + + + + No documentation. + + + D3D11_MESSAGE_ID_SETPRIVATEDATA_INVALIDIUNKNOWN + D3D11_MESSAGE_ID_SETPRIVATEDATA_INVALIDIUNKNOWN + + + + No documentation. + + + D3D11_MESSAGE_ID_SETPRIVATEDATA_INVALIDFLAGS + D3D11_MESSAGE_ID_SETPRIVATEDATA_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_SETPRIVATEDATA_CHANGINGPARAMS + D3D11_MESSAGE_ID_SETPRIVATEDATA_CHANGINGPARAMS + + + + No documentation. + + + D3D11_MESSAGE_ID_SETPRIVATEDATA_OUTOFMEMORY + D3D11_MESSAGE_ID_SETPRIVATEDATA_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDSAMPLES + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDSAMPLES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDUSAGE + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDUSAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDBINDFLAGS + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDMISCFLAGS + D3D11_MESSAGE_ID_CREATEBUFFER_UNRECOGNIZEDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDBINDFLAGS + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDINITIALDATA + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDINITIALDATA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDMIPLEVELS + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDMIPLEVELS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDMISCFLAGS + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATEBUFFER_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_NULLDESC + D3D11_MESSAGE_ID_CREATEBUFFER_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDCONSTANTBUFFERBINDINGS + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDCONSTANTBUFFERBINDINGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_LARGEALLOCATION + D3D11_MESSAGE_ID_CREATEBUFFER_LARGEALLOCATION + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNSUPPORTEDFORMAT + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNSUPPORTEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDSAMPLES + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDSAMPLES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDUSAGE + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDUSAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDBINDFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDMISCFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE1D_UNRECOGNIZEDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDBINDFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDINITIALDATA + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDINITIALDATA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDMIPLEVELS + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDMIPLEVELS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDMISCFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATETEXTURE1D_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATETEXTURE1D_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_NULLDESC + D3D11_MESSAGE_ID_CREATETEXTURE1D_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE1D_LARGEALLOCATION + D3D11_MESSAGE_ID_CREATETEXTURE1D_LARGEALLOCATION + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNSUPPORTEDFORMAT + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNSUPPORTEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDSAMPLES + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDSAMPLES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDUSAGE + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDUSAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDBINDFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDMISCFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE2D_UNRECOGNIZEDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDBINDFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDINITIALDATA + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDINITIALDATA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDMIPLEVELS + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDMIPLEVELS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDMISCFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATETEXTURE2D_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATETEXTURE2D_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_NULLDESC + D3D11_MESSAGE_ID_CREATETEXTURE2D_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE2D_LARGEALLOCATION + D3D11_MESSAGE_ID_CREATETEXTURE2D_LARGEALLOCATION + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNSUPPORTEDFORMAT + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNSUPPORTEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDSAMPLES + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDSAMPLES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDUSAGE + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDUSAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDBINDFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDMISCFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE3D_UNRECOGNIZEDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDCPUACCESSFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDCPUACCESSFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDBINDFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDBINDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDINITIALDATA + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDINITIALDATA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDMIPLEVELS + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDMIPLEVELS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDMISCFLAGS + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATETEXTURE3D_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATETEXTURE3D_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_NULLDESC + D3D11_MESSAGE_ID_CREATETEXTURE3D_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATETEXTURE3D_LARGEALLOCATION + D3D11_MESSAGE_ID_CREATETEXTURE3D_LARGEALLOCATION + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDDESC + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDFORMAT + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDRESOURCE + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_UNSUPPORTEDFORMAT + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_UNSUPPORTEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDDESC + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDFORMAT + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDRESOURCE + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATERENDERTARGETVIEW_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDDESC + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDFORMAT + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDRESOURCE + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_TOOMANYELEMENTS + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_TOOMANYELEMENTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDFORMAT + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INCOMPATIBLEFORMAT + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INCOMPATIBLEFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDSLOT + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDSLOT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDINPUTSLOTCLASS + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDINPUTSLOTCLASS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_STEPRATESLOTCLASSMISMATCH + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_STEPRATESLOTCLASSMISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDSLOTCLASSCHANGE + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDSLOTCLASSCHANGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDSTEPRATECHANGE + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDSTEPRATECHANGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDALIGNMENT + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_INVALIDALIGNMENT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_DUPLICATESEMANTIC + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_DUPLICATESEMANTIC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_UNPARSEABLEINPUTSIGNATURE + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_UNPARSEABLEINPUTSIGNATURE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_NULLSEMANTIC + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_NULLSEMANTIC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_MISSINGELEMENT + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_MISSINGELEMENT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_NULLDESC + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_INVALIDSHADERBYTECODE + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_INVALIDSHADERBYTECODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_INVALIDSHADERTYPE + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_INVALIDSHADERTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_INVALIDSHADERBYTECODE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_INVALIDSHADERBYTECODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_INVALIDSHADERTYPE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_INVALIDSHADERTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSHADERBYTECODE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSHADERBYTECODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSHADERTYPE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSHADERTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDNUMENTRIES + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDNUMENTRIES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_OUTPUTSTREAMSTRIDEUNUSED + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_OUTPUTSTREAMSTRIDEUNUSED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDDECL + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDDECL + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_EXPECTEDDECL + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_EXPECTEDDECL + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_OUTPUTSLOT0EXPECTED + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_OUTPUTSLOT0EXPECTED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDOUTPUTSLOT + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDOUTPUTSLOT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_ONLYONEELEMENTPERSLOT + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_ONLYONEELEMENTPERSLOT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDCOMPONENTCOUNT + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDCOMPONENTCOUNT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSTARTCOMPONENTANDCOMPONENTCOUNT + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSTARTCOMPONENTANDCOMPONENTCOUNT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDGAPDEFINITION + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDGAPDEFINITION + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_REPEATEDOUTPUT + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_REPEATEDOUTPUT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDOUTPUTSTREAMSTRIDE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDOUTPUTSTREAMSTRIDE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_MISSINGSEMANTIC + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_MISSINGSEMANTIC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_MASKMISMATCH + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_MASKMISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_CANTHAVEONLYGAPS + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_CANTHAVEONLYGAPS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_DECLTOOCOMPLEX + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_DECLTOOCOMPLEX + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_MISSINGOUTPUTSIGNATURE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_MISSINGOUTPUTSIGNATURE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEPIXELSHADER_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATEPIXELSHADER_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEPIXELSHADER_INVALIDSHADERBYTECODE + D3D11_MESSAGE_ID_CREATEPIXELSHADER_INVALIDSHADERBYTECODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEPIXELSHADER_INVALIDSHADERTYPE + D3D11_MESSAGE_ID_CREATEPIXELSHADER_INVALIDSHADERTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDFILLMODE + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDFILLMODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDCULLMODE + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDCULLMODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDDEPTHBIASCLAMP + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDDEPTHBIASCLAMP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDSLOPESCALEDDEPTHBIAS + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_INVALIDSLOPESCALEDDEPTHBIAS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_NULLDESC + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDDEPTHWRITEMASK + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDDEPTHWRITEMASK + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDDEPTHFUNC + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDDEPTHFUNC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILFAILOP + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILFAILOP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILZFAILOP + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILZFAILOP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILPASSOP + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILPASSOP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILFUNC + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDFRONTFACESTENCILFUNC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILFAILOP + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILFAILOP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILZFAILOP + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILZFAILOP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILPASSOP + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILPASSOP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILFUNC + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_INVALIDBACKFACESTENCILFUNC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_NULLDESC + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDSRCBLEND + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDSRCBLEND + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDDESTBLEND + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDDESTBLEND + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDBLENDOP + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDBLENDOP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDSRCBLENDALPHA + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDSRCBLENDALPHA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDDESTBLENDALPHA + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDDESTBLENDALPHA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDBLENDOPALPHA + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDBLENDOPALPHA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDRENDERTARGETWRITEMASK + D3D11_MESSAGE_ID_CREATEBLENDSTATE_INVALIDRENDERTARGETWRITEMASK + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATEBLENDSTATE_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NULLDESC + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDFILTER + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDFILTER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDADDRESSU + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDADDRESSU + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDADDRESSV + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDADDRESSV + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDADDRESSW + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDADDRESSW + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMIPLODBIAS + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMIPLODBIAS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMAXANISOTROPY + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMAXANISOTROPY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDCOMPARISONFUNC + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDCOMPARISONFUNC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMINLOD + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMINLOD + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMAXLOD + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_INVALIDMAXLOD + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_NULLDESC + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_INVALIDQUERY + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_INVALIDQUERY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_INVALIDMISCFLAGS + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_INVALIDMISCFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_UNEXPECTEDMISCFLAG + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_UNEXPECTEDMISCFLAG + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_NULLDESC + D3D11_MESSAGE_ID_CREATEQUERYORPREDICATE_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_TOPOLOGY_UNRECOGNIZED + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_TOPOLOGY_UNRECOGNIZED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_TOPOLOGY_UNDEFINED + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_TOPOLOGY_UNDEFINED + + + + No documentation. + + + D3D11_MESSAGE_ID_IASETVERTEXBUFFERS_INVALIDBUFFER + D3D11_MESSAGE_ID_IASETVERTEXBUFFERS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_OFFSET_TOO_LARGE + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_OFFSET_TOO_LARGE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_IASETINDEXBUFFER_INVALIDBUFFER + D3D11_MESSAGE_ID_IASETINDEXBUFFER_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_FORMAT_INVALID + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_FORMAT_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_OFFSET_TOO_LARGE + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_OFFSET_TOO_LARGE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_OFFSET_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_IASETINDEXBUFFER_OFFSET_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSSETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_VSSETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSETCONSTANTBUFFERS_INVALIDBUFFER + D3D11_MESSAGE_ID_VSSETCONSTANTBUFFERS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSSETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_VSSETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSSETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_VSSETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSSETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_GSSETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_GSSETCONSTANTBUFFERS_INVALIDBUFFER + D3D11_MESSAGE_ID_GSSETCONSTANTBUFFERS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSSETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_GSSETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSSETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_GSSETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_SOSETTARGETS_INVALIDBUFFER + D3D11_MESSAGE_ID_SOSETTARGETS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SOSETTARGETS_OFFSET_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_SOSETTARGETS_OFFSET_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSSETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_PSSETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_PSSETCONSTANTBUFFERS_INVALIDBUFFER + D3D11_MESSAGE_ID_PSSETCONSTANTBUFFERS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSSETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_PSSETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSSETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_PSSETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSSETVIEWPORTS_INVALIDVIEWPORT + D3D11_MESSAGE_ID_DEVICE_RSSETVIEWPORTS_INVALIDVIEWPORT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSSETSCISSORRECTS_INVALIDSCISSOR + D3D11_MESSAGE_ID_DEVICE_RSSETSCISSORRECTS_INVALIDSCISSOR + + + + No documentation. + + + D3D11_MESSAGE_ID_CLEARRENDERTARGETVIEW_DENORMFLUSH + D3D11_MESSAGE_ID_CLEARRENDERTARGETVIEW_DENORMFLUSH + + + + No documentation. + + + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_DENORMFLUSH + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_DENORMFLUSH + + + + No documentation. + + + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_INVALID + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IAGETVERTEXBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_IAGETVERTEXBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSGETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_VSGETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSGETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_VSGETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_VSGETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_VSGETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSGETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_GSGETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSGETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_GSGETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GSGETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_GSGETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SOGETTARGETS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_SOGETTARGETS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSGETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_PSGETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSGETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_PSGETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_PSGETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_PSGETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSGETVIEWPORTS_VIEWPORTS_EMPTY + D3D11_MESSAGE_ID_DEVICE_RSGETVIEWPORTS_VIEWPORTS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSGETSCISSORRECTS_RECTS_EMPTY + D3D11_MESSAGE_ID_DEVICE_RSGETSCISSORRECTS_RECTS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GENERATEMIPS_RESOURCE_INVALID + D3D11_MESSAGE_ID_DEVICE_GENERATEMIPS_RESOURCE_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDDESTINATIONSUBRESOURCE + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDDESTINATIONSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCESUBRESOURCE + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCESUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCEBOX + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCEBOX + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCE + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDDESTINATIONSTATE + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDDESTINATIONSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCESTATE + D3D11_MESSAGE_ID_COPYSUBRESOURCEREGION_INVALIDSOURCESTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYRESOURCE_INVALIDSOURCE + D3D11_MESSAGE_ID_COPYRESOURCE_INVALIDSOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYRESOURCE_INVALIDDESTINATIONSTATE + D3D11_MESSAGE_ID_COPYRESOURCE_INVALIDDESTINATIONSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYRESOURCE_INVALIDSOURCESTATE + D3D11_MESSAGE_ID_COPYRESOURCE_INVALIDSOURCESTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_UPDATESUBRESOURCE_INVALIDDESTINATIONSUBRESOURCE + D3D11_MESSAGE_ID_UPDATESUBRESOURCE_INVALIDDESTINATIONSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_UPDATESUBRESOURCE_INVALIDDESTINATIONBOX + D3D11_MESSAGE_ID_UPDATESUBRESOURCE_INVALIDDESTINATIONBOX + + + + No documentation. + + + D3D11_MESSAGE_ID_UPDATESUBRESOURCE_INVALIDDESTINATIONSTATE + D3D11_MESSAGE_ID_UPDATESUBRESOURCE_INVALIDDESTINATIONSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_DESTINATION_INVALID + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_DESTINATION_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_DESTINATION_SUBRESOURCE_INVALID + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_DESTINATION_SUBRESOURCE_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_SOURCE_INVALID + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_SOURCE_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_SOURCE_SUBRESOURCE_INVALID + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_SOURCE_SUBRESOURCE_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_FORMAT_INVALID + D3D11_MESSAGE_ID_DEVICE_RESOLVESUBRESOURCE_FORMAT_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_BUFFER_MAP_INVALIDMAPTYPE + D3D11_MESSAGE_ID_BUFFER_MAP_INVALIDMAPTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_BUFFER_MAP_INVALIDFLAGS + D3D11_MESSAGE_ID_BUFFER_MAP_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_BUFFER_MAP_ALREADYMAPPED + D3D11_MESSAGE_ID_BUFFER_MAP_ALREADYMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_BUFFER_MAP_DEVICEREMOVED_RETURN + D3D11_MESSAGE_ID_BUFFER_MAP_DEVICEREMOVED_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_BUFFER_UNMAP_NOTMAPPED + D3D11_MESSAGE_ID_BUFFER_UNMAP_NOTMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE1D_MAP_INVALIDMAPTYPE + D3D11_MESSAGE_ID_TEXTURE1D_MAP_INVALIDMAPTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE1D_MAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_TEXTURE1D_MAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE1D_MAP_INVALIDFLAGS + D3D11_MESSAGE_ID_TEXTURE1D_MAP_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE1D_MAP_ALREADYMAPPED + D3D11_MESSAGE_ID_TEXTURE1D_MAP_ALREADYMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE1D_MAP_DEVICEREMOVED_RETURN + D3D11_MESSAGE_ID_TEXTURE1D_MAP_DEVICEREMOVED_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE1D_UNMAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_TEXTURE1D_UNMAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE1D_UNMAP_NOTMAPPED + D3D11_MESSAGE_ID_TEXTURE1D_UNMAP_NOTMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE2D_MAP_INVALIDMAPTYPE + D3D11_MESSAGE_ID_TEXTURE2D_MAP_INVALIDMAPTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE2D_MAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_TEXTURE2D_MAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE2D_MAP_INVALIDFLAGS + D3D11_MESSAGE_ID_TEXTURE2D_MAP_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE2D_MAP_ALREADYMAPPED + D3D11_MESSAGE_ID_TEXTURE2D_MAP_ALREADYMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE2D_MAP_DEVICEREMOVED_RETURN + D3D11_MESSAGE_ID_TEXTURE2D_MAP_DEVICEREMOVED_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE2D_UNMAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_TEXTURE2D_UNMAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE2D_UNMAP_NOTMAPPED + D3D11_MESSAGE_ID_TEXTURE2D_UNMAP_NOTMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE3D_MAP_INVALIDMAPTYPE + D3D11_MESSAGE_ID_TEXTURE3D_MAP_INVALIDMAPTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE3D_MAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_TEXTURE3D_MAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE3D_MAP_INVALIDFLAGS + D3D11_MESSAGE_ID_TEXTURE3D_MAP_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE3D_MAP_ALREADYMAPPED + D3D11_MESSAGE_ID_TEXTURE3D_MAP_ALREADYMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE3D_MAP_DEVICEREMOVED_RETURN + D3D11_MESSAGE_ID_TEXTURE3D_MAP_DEVICEREMOVED_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE3D_UNMAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_TEXTURE3D_UNMAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXTURE3D_UNMAP_NOTMAPPED + D3D11_MESSAGE_ID_TEXTURE3D_UNMAP_NOTMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_CHECKFORMATSUPPORT_FORMAT_DEPRECATED + D3D11_MESSAGE_ID_CHECKFORMATSUPPORT_FORMAT_DEPRECATED + + + + No documentation. + + + D3D11_MESSAGE_ID_CHECKMULTISAMPLEQUALITYLEVELS_FORMAT_DEPRECATED + D3D11_MESSAGE_ID_CHECKMULTISAMPLEQUALITYLEVELS_FORMAT_DEPRECATED + + + + No documentation. + + + D3D11_MESSAGE_ID_SETEXCEPTIONMODE_UNRECOGNIZEDFLAGS + D3D11_MESSAGE_ID_SETEXCEPTIONMODE_UNRECOGNIZEDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_SETEXCEPTIONMODE_INVALIDARG_RETURN + D3D11_MESSAGE_ID_SETEXCEPTIONMODE_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_SETEXCEPTIONMODE_DEVICEREMOVED_RETURN + D3D11_MESSAGE_ID_SETEXCEPTIONMODE_DEVICEREMOVED_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_SIMULATING_INFINITELY_FAST_HARDWARE + D3D11_MESSAGE_ID_REF_SIMULATING_INFINITELY_FAST_HARDWARE + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_THREADING_MODE + D3D11_MESSAGE_ID_REF_THREADING_MODE + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_UMDRIVER_EXCEPTION + D3D11_MESSAGE_ID_REF_UMDRIVER_EXCEPTION + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_KMDRIVER_EXCEPTION + D3D11_MESSAGE_ID_REF_KMDRIVER_EXCEPTION + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_HARDWARE_EXCEPTION + D3D11_MESSAGE_ID_REF_HARDWARE_EXCEPTION + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_ACCESSING_INDEXABLE_TEMP_OUT_OF_RANGE + D3D11_MESSAGE_ID_REF_ACCESSING_INDEXABLE_TEMP_OUT_OF_RANGE + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_PROBLEM_PARSING_SHADER + D3D11_MESSAGE_ID_REF_PROBLEM_PARSING_SHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_OUT_OF_MEMORY + D3D11_MESSAGE_ID_REF_OUT_OF_MEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_INFO + D3D11_MESSAGE_ID_REF_INFO + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEXPOS_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEXPOS_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINDEXED_INDEXPOS_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DRAWINDEXED_INDEXPOS_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINSTANCED_VERTEXPOS_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DRAWINSTANCED_VERTEXPOS_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINSTANCED_INSTANCEPOS_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DRAWINSTANCED_INSTANCEPOS_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINDEXEDINSTANCED_INSTANCEPOS_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DRAWINDEXEDINSTANCED_INSTANCEPOS_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINDEXEDINSTANCED_INDEXPOS_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DRAWINDEXEDINSTANCED_INDEXPOS_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_SHADER_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_SHADER_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_SEMANTICNAME_NOT_FOUND + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_SEMANTICNAME_NOT_FOUND + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_REGISTERINDEX + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_REGISTERINDEX + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_COMPONENTTYPE + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_COMPONENTTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_REGISTERMASK + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_REGISTERMASK + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_SYSTEMVALUE + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_SYSTEMVALUE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_NEVERWRITTEN_ALWAYSREADS + D3D11_MESSAGE_ID_DEVICE_SHADER_LINKAGE_NEVERWRITTEN_ALWAYSREADS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_BUFFER_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_BUFFER_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_INPUTLAYOUT_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_INPUTLAYOUT_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_CONSTANT_BUFFER_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_CONSTANT_BUFFER_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_CONSTANT_BUFFER_TOO_SMALL + D3D11_MESSAGE_ID_DEVICE_DRAW_CONSTANT_BUFFER_TOO_SMALL + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_SAMPLER_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_SAMPLER_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_SHADERRESOURCEVIEW_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_SHADERRESOURCEVIEW_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VIEW_DIMENSION_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_VIEW_DIMENSION_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_BUFFER_STRIDE_TOO_SMALL + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_BUFFER_STRIDE_TOO_SMALL + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_BUFFER_TOO_SMALL + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_BUFFER_TOO_SMALL + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_BUFFER_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_BUFFER_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_BUFFER_FORMAT_INVALID + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_BUFFER_FORMAT_INVALID + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_BUFFER_TOO_SMALL + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_BUFFER_TOO_SMALL + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_GS_INPUT_PRIMITIVE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_GS_INPUT_PRIMITIVE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_RETURN_TYPE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_RETURN_TYPE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_POSITION_NOT_PRESENT + D3D11_MESSAGE_ID_DEVICE_DRAW_POSITION_NOT_PRESENT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_OUTPUT_STREAM_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_OUTPUT_STREAM_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_BOUND_RESOURCE_MAPPED + D3D11_MESSAGE_ID_DEVICE_DRAW_BOUND_RESOURCE_MAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_INVALID_PRIMITIVETOPOLOGY + D3D11_MESSAGE_ID_DEVICE_DRAW_INVALID_PRIMITIVETOPOLOGY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_OFFSET_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_OFFSET_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_STRIDE_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_DRAW_VERTEX_STRIDE_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_OFFSET_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_DRAW_INDEX_OFFSET_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_OUTPUT_STREAM_OFFSET_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_DRAW_OUTPUT_STREAM_OFFSET_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_LD_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_LD_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_SAMPLE_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_SAMPLE_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_SAMPLE_C_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_SAMPLE_C_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_MULTISAMPLE_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_MULTISAMPLE_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_SO_TARGETS_BOUND_WITHOUT_SOURCE + D3D11_MESSAGE_ID_DEVICE_DRAW_SO_TARGETS_BOUND_WITHOUT_SOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_SO_STRIDE_LARGER_THAN_BUFFER + D3D11_MESSAGE_ID_DEVICE_DRAW_SO_STRIDE_LARGER_THAN_BUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_OM_RENDER_TARGET_DOES_NOT_SUPPORT_BLENDING + D3D11_MESSAGE_ID_DEVICE_DRAW_OM_RENDER_TARGET_DOES_NOT_SUPPORT_BLENDING + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_OM_DUAL_SOURCE_BLENDING_CAN_ONLY_HAVE_RENDER_TARGET_0 + D3D11_MESSAGE_ID_DEVICE_DRAW_OM_DUAL_SOURCE_BLENDING_CAN_ONLY_HAVE_RENDER_TARGET_0 + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_REMOVAL_PROCESS_AT_FAULT + D3D11_MESSAGE_ID_DEVICE_REMOVAL_PROCESS_AT_FAULT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_REMOVAL_PROCESS_POSSIBLY_AT_FAULT + D3D11_MESSAGE_ID_DEVICE_REMOVAL_PROCESS_POSSIBLY_AT_FAULT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_REMOVAL_PROCESS_NOT_AT_FAULT + D3D11_MESSAGE_ID_DEVICE_REMOVAL_PROCESS_NOT_AT_FAULT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_OPEN_SHARED_RESOURCE_INVALIDARG_RETURN + D3D11_MESSAGE_ID_DEVICE_OPEN_SHARED_RESOURCE_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_OPEN_SHARED_RESOURCE_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_DEVICE_OPEN_SHARED_RESOURCE_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_OPEN_SHARED_RESOURCE_BADINTERFACE_RETURN + D3D11_MESSAGE_ID_DEVICE_OPEN_SHARED_RESOURCE_BADINTERFACE_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_VIEWPORT_NOT_SET + D3D11_MESSAGE_ID_DEVICE_DRAW_VIEWPORT_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_TRAILING_DIGIT_IN_SEMANTIC + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_TRAILING_DIGIT_IN_SEMANTIC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_TRAILING_DIGIT_IN_SEMANTIC + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_TRAILING_DIGIT_IN_SEMANTIC + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSSETVIEWPORTS_DENORMFLUSH + D3D11_MESSAGE_ID_DEVICE_RSSETVIEWPORTS_DENORMFLUSH + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_INVALIDVIEW + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_INVALIDVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETTEXTFILTERSIZE_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_DEVICE_SETTEXTFILTERSIZE_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_SAMPLER_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_SAMPLER_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_TYPE_MISMATCH + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_TYPE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_BLENDSTATE_GETDESC_LEGACY + D3D11_MESSAGE_ID_BLENDSTATE_GETDESC_LEGACY + + + + No documentation. + + + D3D11_MESSAGE_ID_SHADERRESOURCEVIEW_GETDESC_LEGACY + D3D11_MESSAGE_ID_SHADERRESOURCEVIEW_GETDESC_LEGACY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEQUERY_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATEQUERY_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEPREDICATE_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATEPREDICATE_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOUNTER_OUTOFRANGE_COUNTER + D3D11_MESSAGE_ID_CREATECOUNTER_OUTOFRANGE_COUNTER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOUNTER_SIMULTANEOUS_ACTIVE_COUNTERS_EXHAUSTED + D3D11_MESSAGE_ID_CREATECOUNTER_SIMULTANEOUS_ACTIVE_COUNTERS_EXHAUSTED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOUNTER_UNSUPPORTED_WELLKNOWN_COUNTER + D3D11_MESSAGE_ID_CREATECOUNTER_UNSUPPORTED_WELLKNOWN_COUNTER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOUNTER_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATECOUNTER_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOUNTER_NONEXCLUSIVE_RETURN + D3D11_MESSAGE_ID_CREATECOUNTER_NONEXCLUSIVE_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOUNTER_NULLDESC + D3D11_MESSAGE_ID_CREATECOUNTER_NULLDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CHECKCOUNTER_OUTOFRANGE_COUNTER + D3D11_MESSAGE_ID_CHECKCOUNTER_OUTOFRANGE_COUNTER + + + + No documentation. + + + D3D11_MESSAGE_ID_CHECKCOUNTER_UNSUPPORTED_WELLKNOWN_COUNTER + D3D11_MESSAGE_ID_CHECKCOUNTER_UNSUPPORTED_WELLKNOWN_COUNTER + + + + No documentation. + + + D3D11_MESSAGE_ID_SETPREDICATION_INVALID_PREDICATE_STATE + D3D11_MESSAGE_ID_SETPREDICATION_INVALID_PREDICATE_STATE + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_BEGIN_UNSUPPORTED + D3D11_MESSAGE_ID_QUERY_BEGIN_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_PREDICATE_BEGIN_DURING_PREDICATION + D3D11_MESSAGE_ID_PREDICATE_BEGIN_DURING_PREDICATION + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_BEGIN_DUPLICATE + D3D11_MESSAGE_ID_QUERY_BEGIN_DUPLICATE + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_BEGIN_ABANDONING_PREVIOUS_RESULTS + D3D11_MESSAGE_ID_QUERY_BEGIN_ABANDONING_PREVIOUS_RESULTS + + + + No documentation. + + + D3D11_MESSAGE_ID_PREDICATE_END_DURING_PREDICATION + D3D11_MESSAGE_ID_PREDICATE_END_DURING_PREDICATION + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_END_ABANDONING_PREVIOUS_RESULTS + D3D11_MESSAGE_ID_QUERY_END_ABANDONING_PREVIOUS_RESULTS + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_END_WITHOUT_BEGIN + D3D11_MESSAGE_ID_QUERY_END_WITHOUT_BEGIN + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_GETDATA_INVALID_DATASIZE + D3D11_MESSAGE_ID_QUERY_GETDATA_INVALID_DATASIZE + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_GETDATA_INVALID_FLAGS + D3D11_MESSAGE_ID_QUERY_GETDATA_INVALID_FLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_QUERY_GETDATA_INVALID_CALL + D3D11_MESSAGE_ID_QUERY_GETDATA_INVALID_CALL + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_PS_OUTPUT_TYPE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_PS_OUTPUT_TYPE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_GATHER_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_FORMAT_GATHER_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_INVALID_USE_OF_CENTER_MULTISAMPLE_PATTERN + D3D11_MESSAGE_ID_DEVICE_DRAW_INVALID_USE_OF_CENTER_MULTISAMPLE_PATTERN + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_STRIDE_TOO_LARGE + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_STRIDE_TOO_LARGE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_INVALIDRANGE + D3D11_MESSAGE_ID_DEVICE_IASETVERTEXBUFFERS_INVALIDRANGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_EMPTY_LAYOUT + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_EMPTY_LAYOUT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_SAMPLE_COUNT_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_RESOURCE_SAMPLE_COUNT_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_D3D10_MESSAGES_END + D3D11_MESSAGE_ID_D3D10_MESSAGES_END + + + + No documentation. + + + D3D11_MESSAGE_ID_D3D10L9_MESSAGES_START + D3D11_MESSAGE_ID_D3D10L9_MESSAGES_START + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_STENCIL_NO_TWO_SIDED + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILSTATE_STENCIL_NO_TWO_SIDED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_DepthBiasClamp_NOT_SUPPORTED + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_DepthBiasClamp_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_NO_COMPARISON_SUPPORT + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_NO_COMPARISON_SUPPORT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_EXCESSIVE_ANISOTROPY + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_EXCESSIVE_ANISOTROPY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_BORDER_OUT_OF_RANGE + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_BORDER_OUT_OF_RANGE + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSETSAMPLERS_NOT_SUPPORTED + D3D11_MESSAGE_ID_VSSETSAMPLERS_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSETSAMPLERS_TOO_MANY_SAMPLERS + D3D11_MESSAGE_ID_VSSETSAMPLERS_TOO_MANY_SAMPLERS + + + + No documentation. + + + D3D11_MESSAGE_ID_PSSETSAMPLERS_TOO_MANY_SAMPLERS + D3D11_MESSAGE_ID_PSSETSAMPLERS_TOO_MANY_SAMPLERS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NO_ARRAYS + D3D11_MESSAGE_ID_CREATERESOURCE_NO_ARRAYS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NO_VB_AND_IB_BIND + D3D11_MESSAGE_ID_CREATERESOURCE_NO_VB_AND_IB_BIND + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NO_TEXTURE_1D + D3D11_MESSAGE_ID_CREATERESOURCE_NO_TEXTURE_1D + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_DIMENSION_OUT_OF_RANGE + D3D11_MESSAGE_ID_CREATERESOURCE_DIMENSION_OUT_OF_RANGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NOT_BINDABLE_AS_SHADER_RESOURCE + D3D11_MESSAGE_ID_CREATERESOURCE_NOT_BINDABLE_AS_SHADER_RESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_TOO_MANY_RENDER_TARGETS + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_TOO_MANY_RENDER_TARGETS + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_NO_DIFFERING_BIT_DEPTHS + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_NO_DIFFERING_BIT_DEPTHS + + + + No documentation. + + + D3D11_MESSAGE_ID_IASETVERTEXBUFFERS_BAD_BUFFER_INDEX + D3D11_MESSAGE_ID_IASETVERTEXBUFFERS_BAD_BUFFER_INDEX + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSSETVIEWPORTS_TOO_MANY_VIEWPORTS + D3D11_MESSAGE_ID_DEVICE_RSSETVIEWPORTS_TOO_MANY_VIEWPORTS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_ADJACENCY_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_ADJACENCY_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSSETSCISSORRECTS_TOO_MANY_SCISSORS + D3D11_MESSAGE_ID_DEVICE_RSSETSCISSORRECTS_TOO_MANY_SCISSORS + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYRESOURCE_ONLY_TEXTURE_2D_WITHIN_GPU_MEMORY + D3D11_MESSAGE_ID_COPYRESOURCE_ONLY_TEXTURE_2D_WITHIN_GPU_MEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYRESOURCE_NO_TEXTURE_3D_READBACK + D3D11_MESSAGE_ID_COPYRESOURCE_NO_TEXTURE_3D_READBACK + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYRESOURCE_NO_TEXTURE_ONLY_READBACK + D3D11_MESSAGE_ID_COPYRESOURCE_NO_TEXTURE_ONLY_READBACK + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_UNSUPPORTED_FORMAT + D3D11_MESSAGE_ID_CREATEINPUTLAYOUT_UNSUPPORTED_FORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_ALPHA_TO_COVERAGE + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_ALPHA_TO_COVERAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_DepthClipEnable_MUST_BE_TRUE + D3D11_MESSAGE_ID_CREATERASTERIZERSTATE_DepthClipEnable_MUST_BE_TRUE + + + + No documentation. + + + D3D11_MESSAGE_ID_DRAWINDEXED_STARTINDEXLOCATION_MUST_BE_POSITIVE + D3D11_MESSAGE_ID_DRAWINDEXED_STARTINDEXLOCATION_MUST_BE_POSITIVE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_MUST_USE_LOWEST_LOD + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_MUST_USE_LOWEST_LOD + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_MINLOD_MUST_NOT_BE_FRACTIONAL + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_MINLOD_MUST_NOT_BE_FRACTIONAL + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_MAXLOD_MUST_BE_FLT_MAX + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_MAXLOD_MUST_BE_FLT_MAX + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_FIRSTARRAYSLICE_MUST_BE_ZERO + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_FIRSTARRAYSLICE_MUST_BE_ZERO + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_CUBES_MUST_HAVE_6_SIDES + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_CUBES_MUST_HAVE_6_SIDES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NOT_BINDABLE_AS_RENDER_TARGET + D3D11_MESSAGE_ID_CREATERESOURCE_NOT_BINDABLE_AS_RENDER_TARGET + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NO_DWORD_INDEX_BUFFER + D3D11_MESSAGE_ID_CREATERESOURCE_NO_DWORD_INDEX_BUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_MSAA_PRECLUDES_SHADER_RESOURCE + D3D11_MESSAGE_ID_CREATERESOURCE_MSAA_PRECLUDES_SHADER_RESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_PRESENTATION_PRECLUDES_SHADER_RESOURCE + D3D11_MESSAGE_ID_CREATERESOURCE_PRESENTATION_PRECLUDES_SHADER_RESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_INDEPENDENT_BLEND_ENABLE + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_INDEPENDENT_BLEND_ENABLE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_INDEPENDENT_WRITE_MASKS + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_INDEPENDENT_WRITE_MASKS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NO_STREAM_OUT + D3D11_MESSAGE_ID_CREATERESOURCE_NO_STREAM_OUT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_ONLY_VB_IB_FOR_BUFFERS + D3D11_MESSAGE_ID_CREATERESOURCE_ONLY_VB_IB_FOR_BUFFERS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NO_AUTOGEN_FOR_VOLUMES + D3D11_MESSAGE_ID_CREATERESOURCE_NO_AUTOGEN_FOR_VOLUMES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_DXGI_FORMAT_R8G8B8A8_CANNOT_BE_SHARED + D3D11_MESSAGE_ID_CREATERESOURCE_DXGI_FORMAT_R8G8B8A8_CANNOT_BE_SHARED + + + + No documentation. + + + D3D11_MESSAGE_ID_VSSHADERRESOURCES_NOT_SUPPORTED + D3D11_MESSAGE_ID_VSSHADERRESOURCES_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_GEOMETRY_SHADER_NOT_SUPPORTED + D3D11_MESSAGE_ID_GEOMETRY_SHADER_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_STREAM_OUT_NOT_SUPPORTED + D3D11_MESSAGE_ID_STREAM_OUT_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_TEXT_FILTER_NOT_SUPPORTED + D3D11_MESSAGE_ID_TEXT_FILTER_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_SEPARATE_ALPHA_BLEND + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_SEPARATE_ALPHA_BLEND + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_MRT_BLEND + D3D11_MESSAGE_ID_CREATEBLENDSTATE_NO_MRT_BLEND + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBLENDSTATE_OPERATION_NOT_SUPPORTED + D3D11_MESSAGE_ID_CREATEBLENDSTATE_OPERATION_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_NO_MIRRORONCE + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_NO_MIRRORONCE + + + + No documentation. + + + D3D11_MESSAGE_ID_DRAWINSTANCED_NOT_SUPPORTED + D3D11_MESSAGE_ID_DRAWINSTANCED_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DRAWINDEXEDINSTANCED_NOT_SUPPORTED_BELOW_9_3 + D3D11_MESSAGE_ID_DRAWINDEXEDINSTANCED_NOT_SUPPORTED_BELOW_9_3 + + + + No documentation. + + + D3D11_MESSAGE_ID_DRAWINDEXED_POINTLIST_UNSUPPORTED + D3D11_MESSAGE_ID_DRAWINDEXED_POINTLIST_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_SETBLENDSTATE_SAMPLE_MASK_CANNOT_BE_ZERO + D3D11_MESSAGE_ID_SETBLENDSTATE_SAMPLE_MASK_CANNOT_BE_ZERO + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_DIMENSION_EXCEEDS_FEATURE_LEVEL_DEFINITION + D3D11_MESSAGE_ID_CREATERESOURCE_DIMENSION_EXCEEDS_FEATURE_LEVEL_DEFINITION + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_ONLY_SINGLE_MIP_LEVEL_DEPTH_STENCIL_SUPPORTED + D3D11_MESSAGE_ID_CREATERESOURCE_ONLY_SINGLE_MIP_LEVEL_DEPTH_STENCIL_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_RSSETSCISSORRECTS_NEGATIVESCISSOR + D3D11_MESSAGE_ID_DEVICE_RSSETSCISSORRECTS_NEGATIVESCISSOR + + + + No documentation. + + + D3D11_MESSAGE_ID_SLOT_ZERO_MUST_BE_D3D10_INPUT_PER_VERTEX_DATA + D3D11_MESSAGE_ID_SLOT_ZERO_MUST_BE_D3D10_INPUT_PER_VERTEX_DATA + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATERESOURCE_NON_POW_2_MIPMAP + D3D11_MESSAGE_ID_CREATERESOURCE_NON_POW_2_MIPMAP + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_BORDER_NOT_SUPPORTED + D3D11_MESSAGE_ID_CREATESAMPLERSTATE_BORDER_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_NO_SRGB_MRT + D3D11_MESSAGE_ID_OMSETRENDERTARGETS_NO_SRGB_MRT + + + + No documentation. + + + D3D11_MESSAGE_ID_D3D10L9_MESSAGES_END + D3D11_MESSAGE_ID_D3D10L9_MESSAGES_END + + + + No documentation. + + + D3D11_MESSAGE_ID_D3D11_MESSAGES_START + D3D11_MESSAGE_ID_D3D11_MESSAGES_START + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDFLAGS + D3D11_MESSAGE_ID_CREATEDEPTHSTENCILVIEW_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_INVALIDCLASSLINKAGE + D3D11_MESSAGE_ID_CREATEVERTEXSHADER_INVALIDCLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_INVALIDCLASSLINKAGE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADER_INVALIDCLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDNUMSTREAMS + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDNUMSTREAMS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSTREAMTORASTERIZER + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSTREAMTORASTERIZER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDSTREAMS + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDSTREAMS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDCLASSLINKAGE + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDCLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEPIXELSHADER_INVALIDCLASSLINKAGE + D3D11_MESSAGE_ID_CREATEPIXELSHADER_INVALIDCLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_INVALID_COMMANDLISTFLAGS + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_INVALID_COMMANDLISTFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_SINGLETHREADED + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_SINGLETHREADED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_INVALID_CALL_RETURN + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_INVALID_CALL_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATEDEFERREDCONTEXT_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_FINISHDISPLAYLIST_ONIMMEDIATECONTEXT + D3D11_MESSAGE_ID_FINISHDISPLAYLIST_ONIMMEDIATECONTEXT + + + + No documentation. + + + D3D11_MESSAGE_ID_FINISHDISPLAYLIST_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_FINISHDISPLAYLIST_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_FINISHDISPLAYLIST_INVALID_CALL_RETURN + D3D11_MESSAGE_ID_FINISHDISPLAYLIST_INVALID_CALL_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSTREAM + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDSTREAM + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDENTRIES + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDENTRIES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDSTRIDES + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_UNEXPECTEDSTRIDES + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDNUMSTRIDES + D3D11_MESSAGE_ID_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_INVALIDNUMSTRIDES + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSSETSHADERRESOURCES_HAZARD + D3D11_MESSAGE_ID_DEVICE_HSSETSHADERRESOURCES_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSSETCONSTANTBUFFERS_HAZARD + D3D11_MESSAGE_ID_DEVICE_HSSETCONSTANTBUFFERS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_HSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_HSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_HSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_HSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDCALL + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDCALL + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEHULLSHADER_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATEHULLSHADER_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDSHADERBYTECODE + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDSHADERBYTECODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDSHADERTYPE + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDSHADERTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDCLASSLINKAGE + D3D11_MESSAGE_ID_CREATEHULLSHADER_INVALIDCLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSSETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_HSSETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_HSSETCONSTANTBUFFERS_INVALIDBUFFER + D3D11_MESSAGE_ID_HSSETCONSTANTBUFFERS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSSETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_HSSETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSSETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_HSSETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSGETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_HSGETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSGETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_HSGETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_HSGETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_HSGETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSSETSHADERRESOURCES_HAZARD + D3D11_MESSAGE_ID_DEVICE_DSSETSHADERRESOURCES_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSSETCONSTANTBUFFERS_HAZARD + D3D11_MESSAGE_ID_DEVICE_DSSETCONSTANTBUFFERS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_DSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_DSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_DSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDCALL + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDCALL + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDSHADERBYTECODE + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDSHADERBYTECODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDSHADERTYPE + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDSHADERTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDCLASSLINKAGE + D3D11_MESSAGE_ID_CREATEDOMAINSHADER_INVALIDCLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSSETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_DSSETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DSSETCONSTANTBUFFERS_INVALIDBUFFER + D3D11_MESSAGE_ID_DSSETCONSTANTBUFFERS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSSETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_DSSETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSSETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_DSSETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSGETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_DSGETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSGETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_DSGETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DSGETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_DSGETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_XOR_DS_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_XOR_DS_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEFERRED_CONTEXT_REMOVAL_PROCESS_AT_FAULT + D3D11_MESSAGE_ID_DEFERRED_CONTEXT_REMOVAL_PROCESS_AT_FAULT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINDIRECT_INVALID_ARG_BUFFER + D3D11_MESSAGE_ID_DEVICE_DRAWINDIRECT_INVALID_ARG_BUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINDIRECT_OFFSET_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_DRAWINDIRECT_OFFSET_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAWINDIRECT_OFFSET_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DRAWINDIRECT_OFFSET_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_MAP_INVALIDMAPTYPE + D3D11_MESSAGE_ID_RESOURCE_MAP_INVALIDMAPTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_MAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_RESOURCE_MAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_MAP_INVALIDFLAGS + D3D11_MESSAGE_ID_RESOURCE_MAP_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_MAP_ALREADYMAPPED + D3D11_MESSAGE_ID_RESOURCE_MAP_ALREADYMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_MAP_DEVICEREMOVED_RETURN + D3D11_MESSAGE_ID_RESOURCE_MAP_DEVICEREMOVED_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_MAP_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_RESOURCE_MAP_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_MAP_WITHOUT_INITIAL_DISCARD + D3D11_MESSAGE_ID_RESOURCE_MAP_WITHOUT_INITIAL_DISCARD + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_UNMAP_INVALIDSUBRESOURCE + D3D11_MESSAGE_ID_RESOURCE_UNMAP_INVALIDSUBRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_RESOURCE_UNMAP_NOTMAPPED + D3D11_MESSAGE_ID_RESOURCE_UNMAP_NOTMAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_RASTERIZING_CONTROL_POINTS + D3D11_MESSAGE_ID_DEVICE_DRAW_RASTERIZING_CONTROL_POINTS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_TOPOLOGY_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_IASETPRIMITIVETOPOLOGY_TOPOLOGY_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_DS_SIGNATURE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_DS_SIGNATURE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_HULL_SHADER_INPUT_TOPOLOGY_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_HULL_SHADER_INPUT_TOPOLOGY_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_DS_CONTROL_POINT_COUNT_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_DS_CONTROL_POINT_COUNT_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_DS_TESSELLATOR_DOMAIN_MISMATCH + D3D11_MESSAGE_ID_DEVICE_DRAW_HS_DS_TESSELLATOR_DOMAIN_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_CONTEXT + D3D11_MESSAGE_ID_CREATE_CONTEXT + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_CONTEXT + D3D11_MESSAGE_ID_LIVE_CONTEXT + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_CONTEXT + D3D11_MESSAGE_ID_DESTROY_CONTEXT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_BUFFER + D3D11_MESSAGE_ID_CREATE_BUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_BUFFER + D3D11_MESSAGE_ID_LIVE_BUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_BUFFER + D3D11_MESSAGE_ID_DESTROY_BUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_TEXTURE1D + D3D11_MESSAGE_ID_CREATE_TEXTURE1D + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_TEXTURE1D + D3D11_MESSAGE_ID_LIVE_TEXTURE1D + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_TEXTURE1D + D3D11_MESSAGE_ID_DESTROY_TEXTURE1D + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_TEXTURE2D + D3D11_MESSAGE_ID_CREATE_TEXTURE2D + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_TEXTURE2D + D3D11_MESSAGE_ID_LIVE_TEXTURE2D + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_TEXTURE2D + D3D11_MESSAGE_ID_DESTROY_TEXTURE2D + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_TEXTURE3D + D3D11_MESSAGE_ID_CREATE_TEXTURE3D + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_TEXTURE3D + D3D11_MESSAGE_ID_LIVE_TEXTURE3D + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_TEXTURE3D + D3D11_MESSAGE_ID_DESTROY_TEXTURE3D + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_SHADERRESOURCEVIEW + D3D11_MESSAGE_ID_CREATE_SHADERRESOURCEVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_SHADERRESOURCEVIEW + D3D11_MESSAGE_ID_LIVE_SHADERRESOURCEVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_SHADERRESOURCEVIEW + D3D11_MESSAGE_ID_DESTROY_SHADERRESOURCEVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_RENDERTARGETVIEW + D3D11_MESSAGE_ID_CREATE_RENDERTARGETVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_RENDERTARGETVIEW + D3D11_MESSAGE_ID_LIVE_RENDERTARGETVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_RENDERTARGETVIEW + D3D11_MESSAGE_ID_DESTROY_RENDERTARGETVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_DEPTHSTENCILVIEW + D3D11_MESSAGE_ID_CREATE_DEPTHSTENCILVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_DEPTHSTENCILVIEW + D3D11_MESSAGE_ID_LIVE_DEPTHSTENCILVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_DEPTHSTENCILVIEW + D3D11_MESSAGE_ID_DESTROY_DEPTHSTENCILVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_VERTEXSHADER + D3D11_MESSAGE_ID_CREATE_VERTEXSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_VERTEXSHADER + D3D11_MESSAGE_ID_LIVE_VERTEXSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_VERTEXSHADER + D3D11_MESSAGE_ID_DESTROY_VERTEXSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_HULLSHADER + D3D11_MESSAGE_ID_CREATE_HULLSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_HULLSHADER + D3D11_MESSAGE_ID_LIVE_HULLSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_HULLSHADER + D3D11_MESSAGE_ID_DESTROY_HULLSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_DOMAINSHADER + D3D11_MESSAGE_ID_CREATE_DOMAINSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_DOMAINSHADER + D3D11_MESSAGE_ID_LIVE_DOMAINSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_DOMAINSHADER + D3D11_MESSAGE_ID_DESTROY_DOMAINSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_GEOMETRYSHADER + D3D11_MESSAGE_ID_CREATE_GEOMETRYSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_GEOMETRYSHADER + D3D11_MESSAGE_ID_LIVE_GEOMETRYSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_GEOMETRYSHADER + D3D11_MESSAGE_ID_DESTROY_GEOMETRYSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_PIXELSHADER + D3D11_MESSAGE_ID_CREATE_PIXELSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_PIXELSHADER + D3D11_MESSAGE_ID_LIVE_PIXELSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_PIXELSHADER + D3D11_MESSAGE_ID_DESTROY_PIXELSHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_INPUTLAYOUT + D3D11_MESSAGE_ID_CREATE_INPUTLAYOUT + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_INPUTLAYOUT + D3D11_MESSAGE_ID_LIVE_INPUTLAYOUT + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_INPUTLAYOUT + D3D11_MESSAGE_ID_DESTROY_INPUTLAYOUT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_SAMPLER + D3D11_MESSAGE_ID_CREATE_SAMPLER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_SAMPLER + D3D11_MESSAGE_ID_LIVE_SAMPLER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_SAMPLER + D3D11_MESSAGE_ID_DESTROY_SAMPLER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_BLENDSTATE + D3D11_MESSAGE_ID_CREATE_BLENDSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_BLENDSTATE + D3D11_MESSAGE_ID_LIVE_BLENDSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_BLENDSTATE + D3D11_MESSAGE_ID_DESTROY_BLENDSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_DEPTHSTENCILSTATE + D3D11_MESSAGE_ID_CREATE_DEPTHSTENCILSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_DEPTHSTENCILSTATE + D3D11_MESSAGE_ID_LIVE_DEPTHSTENCILSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_DEPTHSTENCILSTATE + D3D11_MESSAGE_ID_DESTROY_DEPTHSTENCILSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_RASTERIZERSTATE + D3D11_MESSAGE_ID_CREATE_RASTERIZERSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_RASTERIZERSTATE + D3D11_MESSAGE_ID_LIVE_RASTERIZERSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_RASTERIZERSTATE + D3D11_MESSAGE_ID_DESTROY_RASTERIZERSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_QUERY + D3D11_MESSAGE_ID_CREATE_QUERY + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_QUERY + D3D11_MESSAGE_ID_LIVE_QUERY + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_QUERY + D3D11_MESSAGE_ID_DESTROY_QUERY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_PREDICATE + D3D11_MESSAGE_ID_CREATE_PREDICATE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_PREDICATE + D3D11_MESSAGE_ID_LIVE_PREDICATE + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_PREDICATE + D3D11_MESSAGE_ID_DESTROY_PREDICATE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_COUNTER + D3D11_MESSAGE_ID_CREATE_COUNTER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_COUNTER + D3D11_MESSAGE_ID_LIVE_COUNTER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_COUNTER + D3D11_MESSAGE_ID_DESTROY_COUNTER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_COMMANDLIST + D3D11_MESSAGE_ID_CREATE_COMMANDLIST + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_COMMANDLIST + D3D11_MESSAGE_ID_LIVE_COMMANDLIST + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_COMMANDLIST + D3D11_MESSAGE_ID_DESTROY_COMMANDLIST + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_CLASSINSTANCE + D3D11_MESSAGE_ID_CREATE_CLASSINSTANCE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_CLASSINSTANCE + D3D11_MESSAGE_ID_LIVE_CLASSINSTANCE + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_CLASSINSTANCE + D3D11_MESSAGE_ID_DESTROY_CLASSINSTANCE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_CLASSLINKAGE + D3D11_MESSAGE_ID_CREATE_CLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_CLASSLINKAGE + D3D11_MESSAGE_ID_LIVE_CLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_CLASSLINKAGE + D3D11_MESSAGE_ID_DESTROY_CLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_DEVICE + D3D11_MESSAGE_ID_LIVE_DEVICE + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_OBJECT_SUMMARY + D3D11_MESSAGE_ID_LIVE_OBJECT_SUMMARY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_COMPUTESHADER + D3D11_MESSAGE_ID_CREATE_COMPUTESHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_COMPUTESHADER + D3D11_MESSAGE_ID_LIVE_COMPUTESHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_COMPUTESHADER + D3D11_MESSAGE_ID_DESTROY_COMPUTESHADER + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATE_UNORDEREDACCESSVIEW + D3D11_MESSAGE_ID_CREATE_UNORDEREDACCESSVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_LIVE_UNORDEREDACCESSVIEW + D3D11_MESSAGE_ID_LIVE_UNORDEREDACCESSVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_DESTROY_UNORDEREDACCESSVIEW + D3D11_MESSAGE_ID_DESTROY_UNORDEREDACCESSVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INTERFACES_FEATURELEVEL + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INTERFACES_FEATURELEVEL + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INTERFACE_COUNT_MISMATCH + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INTERFACE_COUNT_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE_INDEX + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE_INDEX + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE_TYPE + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE_TYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE_DATA + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INVALID_INSTANCE_DATA + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_UNBOUND_INSTANCE_DATA + D3D11_MESSAGE_ID_DEVICE_SETSHADER_UNBOUND_INSTANCE_DATA + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INSTANCE_DATA_BINDINGS + D3D11_MESSAGE_ID_DEVICE_SETSHADER_INSTANCE_DATA_BINDINGS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATESHADER_CLASSLINKAGE_FULL + D3D11_MESSAGE_ID_DEVICE_CREATESHADER_CLASSLINKAGE_FULL + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CHECKFEATURESUPPORT_UNRECOGNIZED_FEATURE + D3D11_MESSAGE_ID_DEVICE_CHECKFEATURESUPPORT_UNRECOGNIZED_FEATURE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CHECKFEATURESUPPORT_MISMATCHED_DATA_SIZE + D3D11_MESSAGE_ID_DEVICE_CHECKFEATURESUPPORT_MISMATCHED_DATA_SIZE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CHECKFEATURESUPPORT_INVALIDARG_RETURN + D3D11_MESSAGE_ID_DEVICE_CHECKFEATURESUPPORT_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETSHADERRESOURCES_HAZARD + D3D11_MESSAGE_ID_DEVICE_CSSETSHADERRESOURCES_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETCONSTANTBUFFERS_HAZARD + D3D11_MESSAGE_ID_DEVICE_CSSETCONSTANTBUFFERS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_CSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_CSSETSHADERRESOURCES_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_CSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_CSSETCONSTANTBUFFERS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDCALL + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDCALL + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_OUTOFMEMORY + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_OUTOFMEMORY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDSHADERBYTECODE + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDSHADERBYTECODE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDSHADERTYPE + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDSHADERTYPE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDCLASSLINKAGE + D3D11_MESSAGE_ID_CREATECOMPUTESHADER_INVALIDCLASSLINKAGE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSSETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_CSSETCONSTANTBUFFERS_INVALIDBUFFER + D3D11_MESSAGE_ID_CSSETCONSTANTBUFFERS_INVALIDBUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSSETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSSETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSGETSHADERRESOURCES_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSGETSHADERRESOURCES_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSGETCONSTANTBUFFERS_BUFFERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSGETCONSTANTBUFFERS_BUFFERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSGETSAMPLERS_SAMPLERS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSGETSAMPLERS_SAMPLERS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATEVERTEXSHADER_DOUBLEFLOATOPSNOTSUPPORTED + D3D11_MESSAGE_ID_DEVICE_CREATEVERTEXSHADER_DOUBLEFLOATOPSNOTSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATEHULLSHADER_DOUBLEFLOATOPSNOTSUPPORTED + D3D11_MESSAGE_ID_DEVICE_CREATEHULLSHADER_DOUBLEFLOATOPSNOTSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATEDOMAINSHADER_DOUBLEFLOATOPSNOTSUPPORTED + D3D11_MESSAGE_ID_DEVICE_CREATEDOMAINSHADER_DOUBLEFLOATOPSNOTSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATEGEOMETRYSHADER_DOUBLEFLOATOPSNOTSUPPORTED + D3D11_MESSAGE_ID_DEVICE_CREATEGEOMETRYSHADER_DOUBLEFLOATOPSNOTSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_DOUBLEFLOATOPSNOTSUPPORTED + D3D11_MESSAGE_ID_DEVICE_CREATEGEOMETRYSHADERWITHSTREAMOUTPUT_DOUBLEFLOATOPSNOTSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATEPIXELSHADER_DOUBLEFLOATOPSNOTSUPPORTED + D3D11_MESSAGE_ID_DEVICE_CREATEPIXELSHADER_DOUBLEFLOATOPSNOTSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CREATECOMPUTESHADER_DOUBLEFLOATOPSNOTSUPPORTED + D3D11_MESSAGE_ID_DEVICE_CREATECOMPUTESHADER_DOUBLEFLOATOPSNOTSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDSTRUCTURESTRIDE + D3D11_MESSAGE_ID_CREATEBUFFER_INVALIDSTRUCTURESTRIDE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDFLAGS + D3D11_MESSAGE_ID_CREATESHADERRESOURCEVIEW_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDRESOURCE + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDDESC + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDDESC + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDFORMAT + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDDIMENSIONS + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDDIMENSIONS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_UNRECOGNIZEDFORMAT + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_UNRECOGNIZEDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETSANDUNORDEREDACCESSVIEWS_HAZARD + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETSANDUNORDEREDACCESSVIEWS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETSANDUNORDEREDACCESSVIEWS_OVERLAPPING_OLD_SLOTS + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETSANDUNORDEREDACCESSVIEWS_OVERLAPPING_OLD_SLOTS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETSANDUNORDEREDACCESSVIEWS_NO_OP + D3D11_MESSAGE_ID_DEVICE_OMSETRENDERTARGETSANDUNORDEREDACCESSVIEWS_NO_OP + + + + No documentation. + + + D3D11_MESSAGE_ID_CSSETUNORDEREDACCESSVIEWS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_CSSETUNORDEREDACCESSVIEWS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_PSSETUNORDEREDACCESSVIEWS_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_PSSETUNORDEREDACCESSVIEWS_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDARG_RETURN + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDARG_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_OUTOFMEMORY_RETURN + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_OUTOFMEMORY_RETURN + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_HAZARD + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_HAZARD + + + + No documentation. + + + D3D11_MESSAGE_ID_CLEARUNORDEREDACCESSVIEW_DENORMFLUSH + D3D11_MESSAGE_ID_CLEARUNORDEREDACCESSVIEW_DENORMFLUSH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSS_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSS_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSGETUNORDEREDACCESSS_VIEWS_EMPTY + D3D11_MESSAGE_ID_DEVICE_CSGETUNORDEREDACCESSS_VIEWS_EMPTY + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDFLAGS + D3D11_MESSAGE_ID_CREATEUNORDEREDACCESSVIEW_INVALIDFLAGS + + + + No documentation. + + + D3D11_MESSAGE_ID_CREATESHADERRESESOURCEVIEW_TOOMANYOBJECTS + D3D11_MESSAGE_ID_CREATESHADERRESESOURCEVIEW_TOOMANYOBJECTS + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_INVALID_ARG_BUFFER + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_INVALID_ARG_BUFFER + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_OFFSET_UNALIGNED + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_OFFSET_UNALIGNED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_OFFSET_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_OFFSET_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETRESOURCEMINLOD_INVALIDCONTEXT + D3D11_MESSAGE_ID_DEVICE_SETRESOURCEMINLOD_INVALIDCONTEXT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETRESOURCEMINLOD_INVALIDRESOURCE + D3D11_MESSAGE_ID_DEVICE_SETRESOURCEMINLOD_INVALIDRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SETRESOURCEMINLOD_INVALIDMINLOD + D3D11_MESSAGE_ID_DEVICE_SETRESOURCEMINLOD_INVALIDMINLOD + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GETRESOURCEMINLOD_INVALIDCONTEXT + D3D11_MESSAGE_ID_DEVICE_GETRESOURCEMINLOD_INVALIDCONTEXT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_GETRESOURCEMINLOD_INVALIDRESOURCE + D3D11_MESSAGE_ID_DEVICE_GETRESOURCEMINLOD_INVALIDRESOURCE + + + + No documentation. + + + D3D11_MESSAGE_ID_OMSETDEPTHSTENCIL_UNBINDDELETINGOBJECT + D3D11_MESSAGE_ID_OMSETDEPTHSTENCIL_UNBINDDELETINGOBJECT + + + + No documentation. + + + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_DEPTH_READONLY + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_DEPTH_READONLY + + + + No documentation. + + + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_STENCIL_READONLY + D3D11_MESSAGE_ID_CLEARDEPTHSTENCILVIEW_STENCIL_READONLY + + + + No documentation. + + + D3D11_MESSAGE_ID_CHECKFEATURESUPPORT_FORMAT_DEPRECATED + D3D11_MESSAGE_ID_CHECKFEATURESUPPORT_FORMAT_DEPRECATED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_RETURN_TYPE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_RETURN_TYPE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_NOT_SET + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_NOT_SET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DRAW_UNORDEREDACCESSVIEW_RENDERTARGETVIEW_OVERLAP + D3D11_MESSAGE_ID_DEVICE_DRAW_UNORDEREDACCESSVIEW_RENDERTARGETVIEW_OVERLAP + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_DIMENSION_MISMATCH + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_DIMENSION_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_APPEND_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_APPEND_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMICS_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMICS_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_STRUCTURE_STRIDE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_STRUCTURE_STRIDE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_BUFFER_TYPE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_BUFFER_TYPE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_RAW_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_RAW_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_FORMAT_LD_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_FORMAT_LD_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_FORMAT_STORE_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_FORMAT_STORE_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_ADD_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_ADD_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_BITWISE_OPS_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_BITWISE_OPS_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_CMPSTORE_CMPEXCHANGE_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_CMPSTORE_CMPEXCHANGE_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_EXCHANGE_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_EXCHANGE_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_SIGNED_MINMAX_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_SIGNED_MINMAX_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_UNSIGNED_MINMAX_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_ATOMIC_UNSIGNED_MINMAX_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCH_BOUND_RESOURCE_MAPPED + D3D11_MESSAGE_ID_DEVICE_DISPATCH_BOUND_RESOURCE_MAPPED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCH_THREADGROUPCOUNT_OVERFLOW + D3D11_MESSAGE_ID_DEVICE_DISPATCH_THREADGROUPCOUNT_OVERFLOW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCH_THREADGROUPCOUNT_ZERO + D3D11_MESSAGE_ID_DEVICE_DISPATCH_THREADGROUPCOUNT_ZERO + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADERRESOURCEVIEW_STRUCTURE_STRIDE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_SHADERRESOURCEVIEW_STRUCTURE_STRIDE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADERRESOURCEVIEW_BUFFER_TYPE_MISMATCH + D3D11_MESSAGE_ID_DEVICE_SHADERRESOURCEVIEW_BUFFER_TYPE_MISMATCH + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_SHADERRESOURCEVIEW_RAW_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_SHADERRESOURCEVIEW_RAW_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCH_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_DISPATCH_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_DISPATCHINDIRECT_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_INVALIDOFFSET + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_INVALIDOFFSET + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_LARGEOFFSET + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_LARGEOFFSET + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_INVALIDDESTINATIONSTATE + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_INVALIDDESTINATIONSTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_INVALIDSOURCESTATE + D3D11_MESSAGE_ID_COPYSTRUCTURECOUNT_INVALIDSOURCESTATE + + + + No documentation. + + + D3D11_MESSAGE_ID_CHECKFORMATSUPPORT_FORMAT_NOT_SUPPORTED + D3D11_MESSAGE_ID_CHECKFORMATSUPPORT_FORMAT_NOT_SUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_INVALIDVIEW + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_INVALIDVIEW + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_INVALIDOFFSET + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_INVALIDOFFSET + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_TOOMANYVIEWS + D3D11_MESSAGE_ID_DEVICE_CSSETUNORDEREDACCESSVIEWS_TOOMANYVIEWS + + + + No documentation. + + + D3D11_MESSAGE_ID_CLEARUNORDEREDACCESSVIEWFLOAT_INVALIDFORMAT + D3D11_MESSAGE_ID_CLEARUNORDEREDACCESSVIEWFLOAT_INVALIDFORMAT + + + + No documentation. + + + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_COUNTER_UNSUPPORTED + D3D11_MESSAGE_ID_DEVICE_UNORDEREDACCESSVIEW_COUNTER_UNSUPPORTED + + + + No documentation. + + + D3D11_MESSAGE_ID_REF_WARNING + D3D11_MESSAGE_ID_REF_WARNING + + + + No documentation. + + + D3D11_MESSAGE_ID_D3D11_MESSAGES_END + D3D11_MESSAGE_ID_D3D11_MESSAGES_END + + + +

Debug message severity levels for an information queue.

+
+ +

Use these values to allow or deny message categories to pass through the storage and retrieval filters for an information queue (see ). This API is used by .

+
+ + ff476187 + D3D11_MESSAGE_SEVERITY + D3D11_MESSAGE_SEVERITY +
+ + +

Defines some type of corruption which has occurred.

+
+ + ff476187 + D3D11_MESSAGE_SEVERITY_CORRUPTION + D3D11_MESSAGE_SEVERITY_CORRUPTION +
+ + +

Defines an error message.

+
+ + ff476187 + D3D11_MESSAGE_SEVERITY_ERROR + D3D11_MESSAGE_SEVERITY_ERROR +
+ + +

Defines a warning message.

+
+ + ff476187 + D3D11_MESSAGE_SEVERITY_WARNING + D3D11_MESSAGE_SEVERITY_WARNING +
+ + +

Defines an information message.

+
+ + ff476187 + D3D11_MESSAGE_SEVERITY_INFO + D3D11_MESSAGE_SEVERITY_INFO +
+ + +

Normal map options. Any number of these flags may be OR'd together in any combination.

+
+ +

These flags are used by .

+
+ + ff476318 + D3DX11_NORMALMAP_FLAG + D3DX11_NORMALMAP_FLAG +
+ + +

Indicates that pixels off the edge of the texture on the U-axis should be mirrored, not wraped.

+
+ + ff476318 + D3DX11_NORMALMAP_MIRROR_U + D3DX11_NORMALMAP_MIRROR_U +
+ + +

Indicates that pixels off the edge of the texture on the V-axis should be mirrored, not wraped.

+
+ + ff476318 + D3DX11_NORMALMAP_MIRROR_V + D3DX11_NORMALMAP_MIRROR_V +
+ + +

Same as | .

+
+ + ff476318 + D3DX11_NORMALMAP_MIRROR + D3DX11_NORMALMAP_MIRROR +
+ + +

Inverts the direction of each normal.

+
+ + ff476318 + D3DX11_NORMALMAP_INVERTSIGN + D3DX11_NORMALMAP_INVERTSIGN +
+ + +

Computes the per pixel occlusion term and encodes it into the alpha. An Alpha of 1 means that the pixel is not obscured in any way, and an alpha of 0 would mean that the pixel is completly obscured.

+
+ + ff476318 + D3DX11_NORMALMAP_COMPUTE_OCCLUSION + D3DX11_NORMALMAP_COMPUTE_OCCLUSION +
+ + + None. + + + None + None + + + +

Flags that describe miscellaneous query behavior.

+
+ +

This flag is part of a query description (see ).

+
+ + ff476196 + D3D11_QUERY_MISC_FLAG + D3D11_QUERY_MISC_FLAG +
+ + +

Tell the hardware that if it is not yet sure if something is hidden or not to draw it anyway. This is only used with an occlusion predicate. Predication data cannot be returned to your application via when using this flag.

+
+ + ff476196 + D3D11_QUERY_MISC_PREDICATEHINT + D3D11_QUERY_MISC_PREDICATEHINT +
+ + + None. + + + None + None + + + +

Query types.

+
+ +

Create a query with .

+
+ + ff476191 + D3D11_QUERY + D3D11_QUERY +
+ + +

Determines whether or not the GPU is finished processing commands. When the GPU is finished processing commands will return , and pData will point to a with a value of TRUE. When using this type of query, is disabled.

+
+ + ff476191 + D3D11_QUERY_EVENT + D3D11_QUERY_EVENT +
+ + +

Get the number of samples that passed the depth and stencil tests in between and . returns a UINT64. If a depth or stencil test is disabled, then each of those tests will be counted as a pass.

+
+ + ff476191 + D3D11_QUERY_OCCLUSION + D3D11_QUERY_OCCLUSION +
+ + +

Get a timestamp value where returns a UINT64. This kind of query is only useful if two timestamp queries are done in the middle of a query. The difference of two timestamps can be used to determine how many ticks have elapsed, and the query will determine if that difference is a reliable value and also has a value that shows how to convert the number of ticks into seconds. See . When using this type of query, is disabled.

+
+ + ff476191 + D3D11_QUERY_TIMESTAMP + D3D11_QUERY_TIMESTAMP +
+ + +

Determines whether or not a is returning reliable values, and also gives the frequency of the processor enabling you to convert the number of elapsed ticks into seconds. will return a . This type of query should only be invoked once per frame or less.

+
+ + ff476191 + D3D11_QUERY_TIMESTAMP_DISJOINT + D3D11_QUERY_TIMESTAMP_DISJOINT +
+ + +

Get pipeline statistics, such as the number of pixel shader invocations in between and . will return a .

+
+ + ff476191 + D3D11_QUERY_PIPELINE_STATISTICS + D3D11_QUERY_PIPELINE_STATISTICS +
+ + +

Similar to , except returns a indicating whether or not any samples passed the depth and stencil tests - TRUE meaning at least one passed, meaning none passed.

+
+ + ff476191 + D3D11_QUERY_OCCLUSION_PREDICATE + D3D11_QUERY_OCCLUSION_PREDICATE +
+ + +

Get streaming output statistics, such as the number of primitives streamed out in between and . will return a structure.

+
+ + ff476191 + D3D11_QUERY_SO_STATISTICS + D3D11_QUERY_SO_STATISTICS +
+ + +

Determines whether or not any of the streaming output buffers overflowed in between and . returns a - TRUE meaning there was an overflow, meaning there was not an overflow. If streaming output writes to multiple buffers, and one of the buffers overflows, then it will stop writing to all the output buffers. When an overflow is detected by Direct3D it is prevented from happening - no memory is corrupted. This predication may be used in conjunction with an SO_STATISTICS query so that when an overflow occurs the SO_STATISTIC query will let the application know how much memory was needed to prevent an overflow.

+
+ + ff476191 + D3D11_QUERY_SO_OVERFLOW_PREDICATE + D3D11_QUERY_SO_OVERFLOW_PREDICATE +
+ + +

Get streaming output statistics for stream 0, such as the number of primitives streamed out in between and . will return a structure.

+
+ + ff476191 + D3D11_QUERY_SO_STATISTICS_STREAM0 + D3D11_QUERY_SO_STATISTICS_STREAM0 +
+ + +

Determines whether or not the stream 0 output buffers overflowed in between and . returns a - TRUE meaning there was an overflow, meaning there was not an overflow. If streaming output writes to multiple buffers, and one of the buffers overflows, then it will stop writing to all the output buffers. When an overflow is detected by Direct3D it is prevented from happening - no memory is corrupted. This predication may be used in conjunction with an SO_STATISTICS query so that when an overflow occurs the SO_STATISTIC query will let the application know how much memory was needed to prevent an overflow.

+
+ + ff476191 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM0 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM0 +
+ + +

Get streaming output statistics for stream 1, such as the number of primitives streamed out in between and . will return a structure.

+
+ + ff476191 + D3D11_QUERY_SO_STATISTICS_STREAM1 + D3D11_QUERY_SO_STATISTICS_STREAM1 +
+ + +

Determines whether or not the stream 1 output buffers overflowed in between and . returns a - TRUE meaning there was an overflow, meaning there was not an overflow. If streaming output writes to multiple buffers, and one of the buffers overflows, then it will stop writing to all the output buffers. When an overflow is detected by Direct3D it is prevented from happening - no memory is corrupted. This predication may be used in conjunction with an SO_STATISTICS query so that when an overflow occurs the SO_STATISTIC query will let the application know how much memory was needed to prevent an overflow.

+
+ + ff476191 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM1 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM1 +
+ + +

Get streaming output statistics for stream 2, such as the number of primitives streamed out in between and . will return a structure.

+
+ + ff476191 + D3D11_QUERY_SO_STATISTICS_STREAM2 + D3D11_QUERY_SO_STATISTICS_STREAM2 +
+ + +

Determines whether or not the stream 2 output buffers overflowed in between and . returns a - TRUE meaning there was an overflow, meaning there was not an overflow. If streaming output writes to multiple buffers, and one of the buffers overflows, then it will stop writing to all the output buffers. When an overflow is detected by Direct3D it is prevented from happening - no memory is corrupted. This predication may be used in conjunction with an SO_STATISTICS query so that when an overflow occurs the SO_STATISTIC query will let the application know how much memory was needed to prevent an overflow.

+
+ + ff476191 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM2 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM2 +
+ + +

Get streaming output statistics for stream 3, such as the number of primitives streamed out in between and . will return a structure.

+
+ + ff476191 + D3D11_QUERY_SO_STATISTICS_STREAM3 + D3D11_QUERY_SO_STATISTICS_STREAM3 +
+ + +

Determines whether or not the stream 3 output buffers overflowed in between and . returns a - TRUE meaning there was an overflow, meaning there was not an overflow. If streaming output writes to multiple buffers, and one of the buffers overflows, then it will stop writing to all the output buffers. When an overflow is detected by Direct3D it is prevented from happening - no memory is corrupted. This predication may be used in conjunction with an SO_STATISTICS query so that when an overflow occurs the SO_STATISTIC query will let the application know how much memory was needed to prevent an overflow.

+
+ + ff476191 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM3 + D3D11_QUERY_SO_OVERFLOW_PREDICATE_STREAM3 +
+ + +

These flags identify the type of resource that will be viewed as a render target.

+
+ +

This enumeration is used in to create a render-target view.

+
+ + ff476206 + D3D11_RTV_DIMENSION + D3D11_RTV_DIMENSION +
+ + +

Do not use this value, as it will cause to fail.

+
+ + ff476206 + D3D11_RTV_DIMENSION_UNKNOWN + D3D11_RTV_DIMENSION_UNKNOWN +
+ + +

The resource will be accessed as a buffer.

+
+ + ff476206 + D3D11_RTV_DIMENSION_BUFFER + D3D11_RTV_DIMENSION_BUFFER +
+ + +

The resource will be accessed as a 1D texture.

+
+ + ff476206 + D3D11_RTV_DIMENSION_TEXTURE1D + D3D11_RTV_DIMENSION_TEXTURE1D +
+ + +

The resource will be accessed as an array of 1D textures.

+
+ + ff476206 + D3D11_RTV_DIMENSION_TEXTURE1DARRAY + D3D11_RTV_DIMENSION_TEXTURE1DARRAY +
+ + +

The resource will be accessed as a 2D texture.

+
+ + ff476206 + D3D11_RTV_DIMENSION_TEXTURE2D + D3D11_RTV_DIMENSION_TEXTURE2D +
+ + +

The resource will be accessed as an array of 2D textures.

+
+ + ff476206 + D3D11_RTV_DIMENSION_TEXTURE2DARRAY + D3D11_RTV_DIMENSION_TEXTURE2DARRAY +
+ + +

The resource will be accessed as a 2D texture with multisampling.

+
+ + ff476206 + D3D11_RTV_DIMENSION_TEXTURE2DMS + D3D11_RTV_DIMENSION_TEXTURE2DMS +
+ + +

The resource will be accessed as an array of 2D textures with multisampling.

+
+ + ff476206 + D3D11_RTV_DIMENSION_TEXTURE2DMSARRAY + D3D11_RTV_DIMENSION_TEXTURE2DMSARRAY +
+ + +

The resource will be accessed as a 3D texture.

+
+ + ff476206 + D3D11_RTV_DIMENSION_TEXTURE3D + D3D11_RTV_DIMENSION_TEXTURE3D +
+ + +

Options for the amount of information to report about a device object's lifetime.

+
+ +

This enumeration is used by .

Several inline functions exist to combine the options using operators, see the D3D11SDKLayers.h header file for details.

+
+ + ff476205 + D3D11_RLDO_FLAGS + D3D11_RLDO_FLAGS +
+ + +

Specifies to obtain a summary about a device object's lifetime.

+
+ + ff476205 + D3D11_RLDO_SUMMARY + D3D11_RLDO_SUMMARY +
+ + +

Specifies to obtain detailed information about a device object's lifetime.

+
+ + ff476205 + D3D11_RLDO_DETAIL + D3D11_RLDO_DETAIL +
+ + + None. + + + None + None + + + +

Identifies the type of resource being used.

+
+ +

This enumeration is used in .

+
+ + ff476202 + D3D11_RESOURCE_DIMENSION + D3D11_RESOURCE_DIMENSION +
+ + +

Resource is of unknown type.

+
+ + ff476202 + D3D11_RESOURCE_DIMENSION_UNKNOWN + D3D11_RESOURCE_DIMENSION_UNKNOWN +
+ + +

Resource is a buffer.

+
+ + ff476202 + D3D11_RESOURCE_DIMENSION_BUFFER + D3D11_RESOURCE_DIMENSION_BUFFER +
+ + +

Resource is a 1D texture.

+
+ + ff476202 + D3D11_RESOURCE_DIMENSION_TEXTURE1D + D3D11_RESOURCE_DIMENSION_TEXTURE1D +
+ + +

Resource is a 2D texture.

+
+ + ff476202 + D3D11_RESOURCE_DIMENSION_TEXTURE2D + D3D11_RESOURCE_DIMENSION_TEXTURE2D +
+ + +

Resource is a 3D texture.

+
+ + ff476202 + D3D11_RESOURCE_DIMENSION_TEXTURE3D + D3D11_RESOURCE_DIMENSION_TEXTURE3D +
+ + +

Identifies options for resources.

+
+ +

This enumeration is used in , , , .

These flags can be combined by bitwise OR.

+
+ + ff476203 + D3D11_RESOURCE_MISC_FLAG + D3D11_RESOURCE_MISC_FLAG +
+ + +

Enables MIP map generation by using on a texture resource. The resource must be created with the bind flags that specify that the resource is a render target and a shader resource.

+
+ + ff476203 + D3D11_RESOURCE_MISC_GENERATE_MIPS + D3D11_RESOURCE_MISC_GENERATE_MIPS +
+ + +

Enables resource data sharing between two or more Direct3D devices. The only resources that can be shared are 2D non-mipmapped textures.

and are mutually exclusive.

WARP and REF devices do not support shared resources. If you try to create a resource with this flag on either a WARP or REF device, the create method will return an E_OUTOFMEMORY error code.

+
+ + ff476203 + D3D11_RESOURCE_MISC_SHARED + D3D11_RESOURCE_MISC_SHARED +
+ + +

Sets a resource to be a cube texture created from a Texture2DArray that contains 6 textures.

+
+ + ff476203 + D3D11_RESOURCE_MISC_TEXTURECUBE + D3D11_RESOURCE_MISC_TEXTURECUBE +
+ + +

Enables instancing of GPU-generated content.

+
+ + ff476203 + D3D11_RESOURCE_MISC_DRAWINDIRECT_ARGS + D3D11_RESOURCE_MISC_DRAWINDIRECT_ARGS +
+ + +

Enables a resource as a byte address buffer.

+
+ + ff476203 + D3D11_RESOURCE_MISC_BUFFER_ALLOW_RAW_VIEWS + D3D11_RESOURCE_MISC_BUFFER_ALLOW_RAW_VIEWS +
+ + +

Enables a resource as a structured buffer.

+
+ + ff476203 + D3D11_RESOURCE_MISC_BUFFER_STRUCTURED + D3D11_RESOURCE_MISC_BUFFER_STRUCTURED +
+ + +

Enables a resource with MIP map clamping for use with .

+
+ + ff476203 + D3D11_RESOURCE_MISC_RESOURCE_CLAMP + D3D11_RESOURCE_MISC_RESOURCE_CLAMP +
+ + +

Enables the resource to be synchronized by using the and APIs. The following Direct3D?11 resource creation APIs, that take parameters, have been extended to support the new flag.

If you call any of these methods with the flag set, the interface returned will support the interface. You can retrieve a reference to the interface from the resource by using IUnknown::QueryInterface. The interface implements the and APIs to synchronize access to the surface. The device that creates the surface, and any other device that opens the surface by using OpenSharedResource, must call before they issue any rendering commands to the surface. When those devices finish rendering, they must call .

and are mutually exclusive.

WARP and REF devices do not support shared resources. If you try to create a resource with this flag on either a WARP or REF device, the create method will return an E_OUTOFMEMORY error code.

+
+ + ff476203 + D3D11_RESOURCE_MISC_SHARED_KEYEDMUTEX + D3D11_RESOURCE_MISC_SHARED_KEYEDMUTEX +
+ + +

Enables a resource compatible with GDI. You must set the flag on surfaces that you use with GDI. Setting the flag allows GDI rendering on the surface via . +

Consider the following programming tips for using when you create a texture or use that texture in a swap chain:

  • and are mutually exclusive. Therefore, do not use them together.
  • and are mutually exclusive. Therefore, do not use them together.
  • You must bind the texture as a render target for the output-merger stage. For example, set the flag in the BindFlags member of the structure.
  • You must set the maximum number of MIP map levels to 1. For example, set the MipLevels member of the structure to 1.
  • You must specify that the texture requires read and write access by the GPU. For example, set the Usage member of the structure to .
  • You must set the texture format to one of the following types.

    • +
    • +
    For example, set the Format member of the structure to one of these types.
  • You cannot use with multisampling. Therefore, set the Count member of the structure to 1. Then, set the SampleDesc member of the structure to this structure.
+
+ + ff476203 + D3D11_RESOURCE_MISC_GDI_COMPATIBLE + D3D11_RESOURCE_MISC_GDI_COMPATIBLE +
+ + + None. + + + None + None + + + +

Identifies expected resource use during rendering. The usage directly reflects whether a resource is accessible by the CPU and/or the graphics processing unit (GPU).

+
+ +

An application identifies the way a resource is intended to be used (its usage) in a resource description. There are several structures for creating resources including: , , , .

Differences between Direct3D 9 and Direct3D 10/11:

In Direct3D 9, you specify the type of memory a resource should be created in at resource creation time (using ). It was an application's job to decide what memory pool would provide the best combination of functionality and performance.

In Direct3D 10/11, an application no longer specifies what type of memory (the pool) to create a resource in. Instead, you specify the intended usage of the resource, and let the runtime (in concert with the driver and a memory manager) choose the type of memory that will achieve the best performance.

?

Resource Usage Restrictions

Each usage dictates a tradeoff between accessibility for the CPU and accessibility for the GPU. In general, higher-performance access for one of these two processors means lower-performance access for the other. At either extreme are the and usages. restricts access almost entirely to the GPU. restricts access almost entirely to the CPU and allows only a data transfer (copy) of a resource between the GPU and the CPU. You can perform these copy operations via the and methods. You can also use these copy methods to copy data between two resources of the same usage. You can also use the method to copy memory directly from a CPU-supplied reference to any resource, most usefully a resource with .

usage is a special case that optimizes the flow of data from CPU to GPU when the CPU generates that data on-the-fly and sends that data with high frequency. is typically used on resources with vertex data and on constant buffers. Use the and methods to write data to these resources. To achieve the highest performance for data consumed serially, like vertex data, use the and sequence. For more info about this sequence, see Common Usage of with . +

usage is another special case that causes the GPU to generate data just once when you create a resource. is well-suited to data such as textures because such data is typically read into memory from some file format. Therefore, when you create a texture with , the GPU directly reads that texture into memory. +

Use the following table to choose the usage that best describes how the resource will need to be accessed by the CPU and/or the GPU. Of course, there will be performance tradeoffs.

Resource UsageDefaultDynamicImmutableStaging
GPU-Readyesyesyesyes1
GPU-Writeyesyes1
CPU-Readyes1
CPU-Writeyesyes1

?

1 - GPU read or write of a resource with the usage is restricted to copy operations. You use and for these copy operations. Also, because depth-stencil formats and multisample layouts are implementation details of a particular GPU design, the operating system can?t expose these formats and layouts to the CPU in general. Therefore, staging resources can't be a depth-stencil buffer or a multisampled render target.

Note??You can technically use to copy to a resource with any usage except . However, we recommend to use to update only a resource with . We recommend to use and to update resources with because that is the specific purpose of resources, and is therefore the most optimized path.

Note?? resources consume specific hardware capabilities. Therefore, use them sparingly. The display driver typically allocates memory for resources with a caching algorithm that favors CPU writes and hinders CPU reads. Furthermore, the memory behind resources might not even be the same for successive calls to . Therefore, do not expect high performance or even consistent CPU reads from resources.

Note?? is a special case of GPU-to-CPU copy. Use only with unordered access views (UAVs) of buffers.

Resource Bind Options

To maximize performance, not all resource usage options can be used as input or output resources to the pipeline. This table identifies these limitations.

Resource Can Be Bound AsDefaultDynamicImmutableStaging
Input to a Stageyes2yes3yes
Output from a Stageyes2

?

  • 2 - If bound as an input and an output using different views, each view must use different subresources.
  • 3 - The resource can only be created with a single subresource. The resource cannot be a texture array. The resource cannot be a mipmap chain.
+
+ + ff476259 + D3D11_USAGE + D3D11_USAGE +
+ + +

A resource that requires read and write access by the GPU. This is likely to be the most common usage choice.

+
+ + ff476259 + D3D11_USAGE_DEFAULT + D3D11_USAGE_DEFAULT +
+ + +

A resource that can only be read by the GPU. It cannot be written by the GPU, and cannot be accessed at all by the CPU. This type of resource must be initialized when it is created, since it cannot be changed after creation.

+
+ + ff476259 + D3D11_USAGE_IMMUTABLE + D3D11_USAGE_IMMUTABLE +
+ + +

A resource that is accessible by both the GPU (read only) and the CPU (write only). A dynamic resource is a good choice for a resource that will be updated by the CPU at least once per frame. To update a dynamic resource, use a Map method.

+
+ + ff476259 + D3D11_USAGE_DYNAMIC + D3D11_USAGE_DYNAMIC +
+ + +

A resource that supports data transfer (copy) from the GPU to the CPU.

+
+ + ff476259 + D3D11_USAGE_STAGING + D3D11_USAGE_STAGING +
+ + +

Type for scan data.

+
+ + ff476322 + D3DX11_SCAN_DATA_TYPE + D3DX11_SCAN_DATA_TYPE +
+ + +

FLOAT data.

+
+ + ff476322 + D3DX11_SCAN_DATA_TYPE_FLOAT + D3DX11_SCAN_DATA_TYPE_FLOAT +
+ + +

INT data.

+
+ + ff476322 + D3DX11_SCAN_DATA_TYPE_INT + D3DX11_SCAN_DATA_TYPE_INT +
+ + +

UINT data.

+
+ + ff476322 + D3DX11_SCAN_DATA_TYPE_UINT + D3DX11_SCAN_DATA_TYPE_UINT +
+ + +

Direction to perform scan in.

+
+ + ff476323 + D3DX11_SCAN_DIRECTION + D3DX11_SCAN_DIRECTION +
+ + +

Scan forward.

+
+ + ff476323 + D3DX11_SCAN_DIRECTION_FORWARD + D3DX11_SCAN_DIRECTION_FORWARD +
+ + +

Scan backward.

+
+ + ff476323 + D3DX11_SCAN_DIRECTION_BACKWARD + D3DX11_SCAN_DIRECTION_BACKWARD +
+ + +

Scan opcodes.

+
+ + ff476324 + D3DX11_SCAN_OPCODE + D3DX11_SCAN_OPCODE +
+ + +

Add values.

+
+ + ff476324 + D3DX11_SCAN_OPCODE_ADD + D3DX11_SCAN_OPCODE_ADD +
+ + +

Take the minimum value.

+
+ + ff476324 + D3DX11_SCAN_OPCODE_MIN + D3DX11_SCAN_OPCODE_MIN +
+ + +

Take the maximum value.

+
+ + ff476324 + D3DX11_SCAN_OPCODE_MAX + D3DX11_SCAN_OPCODE_MAX +
+ + +

Multiply the values.

+
+ + ff476324 + D3DX11_SCAN_OPCODE_MUL + D3DX11_SCAN_OPCODE_MUL +
+ + +

Perform a logical AND on the values.

+
+ + ff476324 + D3DX11_SCAN_OPCODE_AND + D3DX11_SCAN_OPCODE_AND +
+ + +

Perform a logical OR on the values.

+
+ + ff476324 + D3DX11_SCAN_OPCODE_OR + D3DX11_SCAN_OPCODE_OR +
+ + +

Perform a logical XOR on the values.

+
+ + ff476324 + D3DX11_SCAN_OPCODE_XOR + D3DX11_SCAN_OPCODE_XOR +
+ + +

Identifies how to bind a raw-buffer resource to the pipeline.

+
+ +

This enumeration is used by

+
+ + ff476091 + D3D11_BUFFEREX_SRV_FLAG + D3D11_BUFFEREX_SRV_FLAG +
+ + +

Bind a raw buffer to the input-assembler stage.

+
+ + ff476091 + D3D11_BUFFEREX_SRV_FLAG_RAW + D3D11_BUFFEREX_SRV_FLAG_RAW +
+ + + None. + + + None + None + + + +

Specifies a multi-sample pattern type.

+
+ + ff476218 + D3D11_STANDARD_MULTISAMPLE_QUALITY_LEVELS + D3D11_STANDARD_MULTISAMPLE_QUALITY_LEVELS +
+ + +

Pre-defined multi-sample patterns required for DX11 and DX10.1 hardware.

+
+ + ff476218 + D3D11_STANDARD_MULTISAMPLE_PATTERN + D3D11_STANDARD_MULTISAMPLE_PATTERN +
+ + +

Pattern where all of the samples are located at the pixel center.

+
+ + ff476218 + D3D11_CENTER_MULTISAMPLE_PATTERN + D3D11_CENTER_MULTISAMPLE_PATTERN +
+ + +

The stencil operations that can be performed during depth-stencil testing.

+
+ + ff476219 + D3D11_STENCIL_OP + D3D11_STENCIL_OP +
+ + +

Keep the existing stencil data.

+
+ + ff476219 + D3D11_STENCIL_OP_KEEP + D3D11_STENCIL_OP_KEEP +
+ + +

Set the stencil data to 0.

+
+ + ff476219 + D3D11_STENCIL_OP_ZERO + D3D11_STENCIL_OP_ZERO +
+ + +

Set the stencil data to the reference value set by calling .

+
+ + ff476219 + D3D11_STENCIL_OP_REPLACE + D3D11_STENCIL_OP_REPLACE +
+ + +

Increment the stencil value by 1, and clamp the result.

+
+ + ff476219 + D3D11_STENCIL_OP_INCR_SAT + D3D11_STENCIL_OP_INCR_SAT +
+ + +

Decrement the stencil value by 1, and clamp the result.

+
+ + ff476219 + D3D11_STENCIL_OP_DECR_SAT + D3D11_STENCIL_OP_DECR_SAT +
+ + +

Invert the stencil data.

+
+ + ff476219 + D3D11_STENCIL_OP_INVERT + D3D11_STENCIL_OP_INVERT +
+ + +

Increment the stencil value by 1, and wrap the result if necessary.

+
+ + ff476219 + D3D11_STENCIL_OP_INCR + D3D11_STENCIL_OP_INCR +
+ + +

Increment the stencil value by 1, and wrap the result if necessary.

+
+ + ff476219 + D3D11_STENCIL_OP_DECR + D3D11_STENCIL_OP_DECR +
+ + +

Identify a technique for resolving texture coordinates that are outside of the boundaries of a texture.

+
+ + ff476256 + D3D11_TEXTURE_ADDRESS_MODE + D3D11_TEXTURE_ADDRESS_MODE +
+ + +

Tile the texture at every (u,v) integer junction. For example, for u values between 0 and 3, the texture is repeated three times.

+
+ + ff476256 + D3D11_TEXTURE_ADDRESS_WRAP + D3D11_TEXTURE_ADDRESS_WRAP +
+ + +

Flip the texture at every (u,v) integer junction. For u values between 0 and 1, for example, the texture is addressed normally; between 1 and 2, the texture is flipped (mirrored); between 2 and 3, the texture is normal again; and so on.

+
+ + ff476256 + D3D11_TEXTURE_ADDRESS_MIRROR + D3D11_TEXTURE_ADDRESS_MIRROR +
+ + +

Texture coordinates outside the range [0.0, 1.0] are set to the texture color at 0.0 or 1.0, respectively.

+
+ + ff476256 + D3D11_TEXTURE_ADDRESS_CLAMP + D3D11_TEXTURE_ADDRESS_CLAMP +
+ + +

Texture coordinates outside the range [0.0, 1.0] are set to the border color specified in or HLSL code.

+
+ + ff476256 + D3D11_TEXTURE_ADDRESS_BORDER + D3D11_TEXTURE_ADDRESS_BORDER +
+ + +

Similar to and . Takes the absolute value of the texture coordinate (thus, mirroring around 0), and then clamps to the maximum value.

+
+ + ff476256 + D3D11_TEXTURE_ADDRESS_MIRROR_ONCE + D3D11_TEXTURE_ADDRESS_MIRROR_ONCE +
+ + +

The different faces of a cube texture.

+
+ + ff476255 + D3D11_TEXTURECUBE_FACE + D3D11_TEXTURECUBE_FACE +
+ + +

Positive X face.

+
+ + ff476255 + D3D11_TEXTURECUBE_FACE_POSITIVE_X + D3D11_TEXTURECUBE_FACE_POSITIVE_X +
+ + +

Negative X face.

+
+ + ff476255 + D3D11_TEXTURECUBE_FACE_NEGATIVE_X + D3D11_TEXTURECUBE_FACE_NEGATIVE_X +
+ + +

Positive Y face.

+
+ + ff476255 + D3D11_TEXTURECUBE_FACE_POSITIVE_Y + D3D11_TEXTURECUBE_FACE_POSITIVE_Y +
+ + +

Negative Y face.

+
+ + ff476255 + D3D11_TEXTURECUBE_FACE_NEGATIVE_Y + D3D11_TEXTURECUBE_FACE_NEGATIVE_Y +
+ + +

Positive Z face.

+
+ + ff476255 + D3D11_TEXTURECUBE_FACE_POSITIVE_Z + D3D11_TEXTURECUBE_FACE_POSITIVE_Z +
+ + +

Negative Z face.

+
+ + ff476255 + D3D11_TEXTURECUBE_FACE_NEGATIVE_Z + D3D11_TEXTURECUBE_FACE_NEGATIVE_Z +
+ + +

Unordered-access-view buffer options.

+
+ + ff476096 + D3D11_BUFFER_UAV_FLAG + D3D11_BUFFER_UAV_FLAG +
+ + +

Resource contains raw, unstructured data. Requires the UAV format to be .

+
+ + ff476096 + D3D11_BUFFER_UAV_FLAG_RAW + D3D11_BUFFER_UAV_FLAG_RAW +
+ + +

Allow data to be appended to the end of the buffer. flag must also be used for any view that will be used as a AppendStructuredBuffer or a ConsumeStructuredBuffer. Requires the UAV format to be .

+
+ + ff476096 + D3D11_BUFFER_UAV_FLAG_APPEND + D3D11_BUFFER_UAV_FLAG_APPEND +
+ + +

Adds a counter to the unordered-access-view buffer. can only be used on a UAV that is a RWStructuredBuffer and it enables the functionality needed for the IncrementCounter and DecrementCounter methods in HLSL. Requires the UAV format to be .

+
+ + ff476096 + D3D11_BUFFER_UAV_FLAG_COUNTER + D3D11_BUFFER_UAV_FLAG_COUNTER +
+ + + None. + + + None + None + + + +

Unordered-access view options.

+
+ +

This enumeration is used by a unordered access-view description (see ).

+
+ + ff476257 + D3D11_UAV_DIMENSION + D3D11_UAV_DIMENSION +
+ + +

The view type is unknown.

+
+ + ff476257 + D3D11_UAV_DIMENSION_UNKNOWN + D3D11_UAV_DIMENSION_UNKNOWN +
+ + +

View the resource as a buffer.

+
+ + ff476257 + D3D11_UAV_DIMENSION_BUFFER + D3D11_UAV_DIMENSION_BUFFER +
+ + +

View the resource as a 1D texture.

+
+ + ff476257 + D3D11_UAV_DIMENSION_TEXTURE1D + D3D11_UAV_DIMENSION_TEXTURE1D +
+ + +

View the resource as a 1D texture array.

+
+ + ff476257 + D3D11_UAV_DIMENSION_TEXTURE1DARRAY + D3D11_UAV_DIMENSION_TEXTURE1DARRAY +
+ + +

View the resource as a 2D texture.

+
+ + ff476257 + D3D11_UAV_DIMENSION_TEXTURE2D + D3D11_UAV_DIMENSION_TEXTURE2D +
+ + +

View the resource as a 2D texture array.

+
+ + ff476257 + D3D11_UAV_DIMENSION_TEXTURE2DARRAY + D3D11_UAV_DIMENSION_TEXTURE2DARRAY +
+ + +

View the resource as a 3D texture array.

+
+ + ff476257 + D3D11_UAV_DIMENSION_TEXTURE3D + D3D11_UAV_DIMENSION_TEXTURE3D +
+ + + Functions + + + + + Constant SdkVersion. + D3D11_SDK_VERSION + + + +

Creates a device that represents the display adapter.

+
+

A reference to the video adapter to use when creating a device. Pass null to use the default adapter, which is the first adapter that is enumerated by IDXGIFactory1::EnumAdapters.

Note??Do not mix the use of DXGI 1.0 () and DXGI 1.1 () in an application. Use or , but not both in an application.

+

The , which represents the driver type to create.

+

A handle to a DLL that implements a software rasterizer. If DriverType is , Software must not be null. Get the handle by calling LoadLibrary, LoadLibraryEx , or GetModuleHandle.

+

The runtime layers to enable (see ); values can be bitwise OR'd together.

+

A reference to an array of s, which determine the order of feature levels to attempt to create. Use default parameters to get the greatest feature level available. If pFeatureLevels is set to null, the following array of feature levels will be used:

 { , , , , , ,}; 
+

The number of elements in pFeatureLevels.

+

The SDK version; use .

+

Returns the address of a reference to an object that represents the device created.

+

If successful, returns the first from the pFeatureLevels array which succeeded. Otherwise, returns 0.

+

Returns the address of a reference to an object that represents the device context.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

This entry-point is supported by the Direct3D 11 runtime, which is available on Windows 7, Windows Server 2008 R2, and as an update to Windows Vista (KB971644).

Set ppDevice and ppImmediateContext to null to determine which feature level is supported by looking at pFeatureLevel without creating a device.

For an example, see How To: Create a Device and Immediate Context; to create a device and a swap chain at the same time, use .

If you set the pAdapter parameter to a non-null value, you must also set the DriverType parameter to the value. If you set the pAdapter parameter to a non-null value and the DriverType parameter to the value, returns an of E_INVALIDARG.

Differences between Direct3D 10 and Direct3D 11:

In Direct3D 10, the presence of pAdapter dictated which adapter to use and the DriverType could mismatch what the adapter was.

In Direct3D 11, if you are trying to create a hardware or a software device, set pAdapter != null which constrains the other inputs to be:

  • DriverType must be
  • Software must be null.

On the other hand, if pAdapter == null, the DriverType cannot be set to ; it can be set to either:

  • If DriverType == , Software cannot be null.
  • If DriverType == , the adapter used will be the default adapter, which is the first adapter that is enumerated by IDXGIFactory1::EnumAdapters

?

+
+ + ff476082 + HRESULT D3D11CreateDevice([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[Out, Fast] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDevice +
+ + +

Creates a device that represents the display adapter and a swap chain used for rendering.

+
+

A reference to the video adapter to use when creating a device. Pass null to use the default adapter, which is the first adapter enumerated by IDXGIFactory1::EnumAdapters.

Note??Do not mix the use of DXGI 1.0 () and DXGI 1.1 () in an application. Use or , but not both in an application.

+

The , which represents the driver type to create.

+

A handle to a DLL that implements a software rasterizer. If DriverType is , Software must not be null. Get the handle by calling LoadLibrary, LoadLibraryEx , or GetModuleHandle. The value should be non-null when is and null otherwise.

+

The runtime layers to enable (see ); values can be bitwise OR'd together.

+

A reference to an array of s, which determine the order of feature levels to attempt to create. Use default parameters to get the greatest feature level available. If pFeatureLevels is set to null, the following array of feature levels will be used:

 { , , , , , ,};
+

The number of elements in pFeatureLevels.

+

The SDK version; use .

+

A reference to a swap chain description (see ) that contains initialization parameters for the swap chain.

+

Returns the address of a reference to the object that represents the swap chain used for rendering.

+

Returns the address of a reference to an object that represents the device created. Supply null as an input to return the highest supported feature level in pFeatureLevel.

+

Returns a reference to a , which represents the first element in an array of feature levels supported by the device.

+

Returns the address of a reference to an object that represents the device context.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

This entry-point is supported by the Direct3D 11 runtime, which is available on Windows 7, Windows Server 2008 R2, and as an update to Windows Vista (KB971644).

Also, see the remarks section in for details about input parameter dependencies. To create a device without creating a swap chain, use the function.

If you set the pAdapter parameter to a non-null value, you must also set the DriverType parameter to the value. If you set the pAdapter parameter to a non-null value and the DriverType parameter to the value, returns an of E_INVALIDARG.

Notes for Metro style apps

The function does not exist for Metro style apps. Instead, Metro style apps use the function and then use the IDXGIFactory2::CreateSwapChainForImmersiveWindow method.

+
+ + ff476083 + HRESULT D3D11CreateDeviceAndSwapChain([In, Optional] IDXGIAdapter* pAdapter,[In] D3D_DRIVER_TYPE DriverType,[In] HINSTANCE Software,[In] D3D11_CREATE_DEVICE_FLAG Flags,[In, Buffer, Optional] const D3D_FEATURE_LEVEL* pFeatureLevels,[In] unsigned int FeatureLevels,[In] unsigned int SDKVersion,[In] const DXGI_SWAP_CHAIN_DESC* pSwapChainDesc,[Out, Optional] IDXGISwapChain** ppSwapChain,[Out, Optional] ID3D11Device** ppDevice,[Out, Optional] D3D_FEATURE_LEVEL* pFeatureLevel,[Out, Optional] ID3D11DeviceContext** ppImmediateContext) + D3D11CreateDeviceAndSwapChain +
+ + + Functions + + + + + +

Creates an COM interface object.

+
+

Pointer to the interface to use for the FFT.

+

Length of the first dimension of the FFT.

+

Length of the second dimension of the FFT.

+

Flag affecting the behavior of the FFT, can be 0 or a combination of flags from .

+

Pointer to a struct that will be filled out with buffer requirements for the FFT.

+

Pointer to an Interface interface reference that will be set the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476277 + HRESULT D3DX11CreateFFT2DComplex([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int X,[In] unsigned int Y,[In] unsigned int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + D3DX11CreateFFT2DComplex +
+ + +

Creates an COM interface object.

+
+

Pointer to the interface to use for the FFT.

+

Length of the first dimension of the FFT.

+

Flag affecting the behavior of the FFT, can be 0 or a combination of flags from .

+

Pointer to a struct that will be filled out with buffer requirements for the FFT.

+

Pointer to an Interface interface reference that will be set the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476276 + HRESULT D3DX11CreateFFT1DReal([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int X,[In] unsigned int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + D3DX11CreateFFT1DReal +
+ + +

Creates an COM interface object.

+
+

Pointer to the interface to use for the FFT.

+

Pointer to a structure that describes the shape of the FFT data as well as the scaling factors that should be used for forward and inverse transforms.

+

Flag affecting the behavior of the FFT, can be 0 or a combination of flags from .

+

Pointer to a struct that will be filled out with buffer requirements for the FFT.

+

Pointer to an Interface interface reference that will be set the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476274 + HRESULT D3DX11CreateFFT([In] ID3D11DeviceContext* pDeviceContext,[In] const D3DX11_FFT_DESC* pDesc,[In] unsigned int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out, Fast] ID3DX11FFT** ppFFT) + D3DX11CreateFFT +
+ + +

Creates an COM interface object.

+
+

Pointer to the interface to use for the FFT.

+

Length of the first dimension of the FFT.

+

Length of the second dimension of the FFT.

+

Flag affecting the behavior of the FFT, can be 0 or a combination of flags from .

+

Pointer to a struct that will be filled out with buffer requirements for the FFT.

+

Pointer to an Interface interface reference that will be set the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476278 + HRESULT D3DX11CreateFFT2DReal([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int X,[In] unsigned int Y,[In] unsigned int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + D3DX11CreateFFT2DReal +
+ + +

Creates a scan context.

+
+

The the scan is associated with.

+

Maximum single scan size, in elements (FLOAT, UINT, or INT)

+

Maximum number of scans in multiscan.

+

Pointer to a Interface reference that will be set to the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476281 + HRESULT D3DX11CreateScan([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int MaxElementScanSize,[In] unsigned int MaxScanCount,[Out, Fast] ID3DX11Scan** ppScan) + D3DX11CreateScan +
+ + +

Creates an COM interface object.

+
+

Pointer to the interface to use for the FFT.

+

Length of the first dimension of the FFT.

+

Length of the second dimension of the FFT.

+

Length of the third dimension of the FFT.

+

Flag affecting the behavior of the FFT, can be 0 or a combination of flags from .

+

Pointer to a struct that will be filled out with buffer requirements for the FFT.

+

Pointer to an Interface interface reference that will be set the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476279 + HRESULT D3DX11CreateFFT3DComplex([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int X,[In] unsigned int Y,[In] unsigned int Z,[In] unsigned int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + D3DX11CreateFFT3DComplex +
+ + +

Creates an COM interface object.

+
+

Pointer to the interface to use for the FFT.

+

Length of the first dimension of the FFT.

+

Flag affecting the behavior of the FFT, can be 0 or a combination of flags from .

+

Pointer to a struct that will be filled out with buffer requirements for the FFT.

+

Pointer to an Interface interface reference that will be set the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476275 + HRESULT D3DX11CreateFFT1DComplex([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int X,[In] unsigned int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + D3DX11CreateFFT1DComplex +
+ + +

Creates a segmented scan context.

+
+

Pointer to an interface.

+

Maximum single scan size, in elements (FLOAT, UINT, or INT).

+

Pointer to a Interface reference that will be set to the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476282 + HRESULT D3DX11CreateSegmentedScan([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int MaxElementScanSize,[Out, Fast] ID3DX11SegmentedScan** ppScan) + D3DX11CreateSegmentedScan +
+ + +

Creates an COM interface object.

+
+

Pointer to the interface to use for the FFT.

+

Length of the first dimension of the FFT.

+

Length of the second dimension of the FFT.

+

Length of the third dimension of the FFT.

+

Flag affecting the behavior of the FFT, can be 0 or a combination of flags from .

+

Pointer to a struct that will be filled out with buffer requirements for the FFT.

+

Pointer to an Interface interface reference that will be set the created interface object.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476280 + HRESULT D3DX11CreateFFT3DReal([In] ID3D11DeviceContext* pDeviceContext,[In] unsigned int X,[In] unsigned int Y,[In] unsigned int Z,[In] unsigned int Flags,[Out] D3DX11_FFT_BUFFER_INFO* pBufferInfo,[Out] ID3DX11FFT** ppFFT) + D3DX11CreateFFT3DReal +
+ + + Functions + + + + + + No documentation. + + No documentation. + No documentation. + No documentation. + + HRESULT D3DX11CheckVersion([In] unsigned int D3DSdkVersion,[In] unsigned int D3DX11SdkVersion) + D3DX11CheckVersion + + + +

Create a shader-resource view from a file in memory.

+
+

A reference to the device (see ) that will use the resource.

+

Pointer to the file in memory that contains the shader-resource view.

+

Size of the file in memory.

+

Optional. Identifies the characteristics of a texture (see ) when the data processor is created; set this to null to read the characteristics of a texture when the texture is loaded.

+

A reference to a thread pump interface (see Interface). If null is specified, this function will behave synchronously and will not return until it is finished.

+

Address of a reference to the newly created shader resource view. See .

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476284 + HRESULT D3DX11CreateShaderResourceViewFromMemory([In] ID3D11Device* pDevice,[In] const void* pSrcData,[In] SIZE_T SrcDataSize,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[In] ID3DX11ThreadPump* pPump,[In] ID3D11ShaderResourceView** ppShaderResourceView,[Out] HRESULT* pHResult) + D3DX11CreateShaderResourceViewFromMemory +
+ + +

Projects a function represented in a cube map into spherical harmonics.

+
+

A reference to an object.

+

Order of the SH evaluation, generates Order^2 coefficients whose degree is Order-1. Valid range is between 2 and 6.

+

A reference to an that represents a cubemap that is going to be projected into spherical harmonics.

+

Output SH vector for red.

+

Output SH vector for green.

+

Output SH vector for blue.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476300 + HRESULT D3DX11SHProjectCubeMap([In] ID3D11DeviceContext* pContext,[In] unsigned int Order,[In] ID3D11Texture2D* pCubeMap,[Out, Buffer] float* pROut,[Out, Buffer, Optional] float* pGOut,[Out, Buffer, Optional] float* pBOut) + D3DX11SHProjectCubeMap +
+ + +

Create a texture from another resource.

+
+

A reference to the device (see ) that will use the resource.

+

A handle to the source resource. HMODULE can be obtained with GetModuleHandle Function.

+

A string that contains the name of the source resource. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR.

+

Optional. Identifies the characteristics of a texture (see ) when the data processor is created; set this to null to read the characteristics of a texture when the texture is loaded.

+

A reference to a thread pump interface (see Interface). If null is specified, this function will behave synchronously and will not return until it is finished.

+

The address of a reference to the texture resource (see ).

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476288 + HRESULT D3DX11CreateTextureFromResourceW([In] ID3D11Device* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[In] ID3DX11ThreadPump* pPump,[Out] void** ppTexture,[Out] HRESULT* pHResult) + D3DX11CreateTextureFromResourceW +
+ + +

Save a texture to memory.

+
+

A reference to an object.

+

Pointer to the texture to be saved. See .

+

The format the texture will be saved as. See .

+

Address of a reference to the memory containing the saved texture.

+

Optional.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476299 + HRESULT D3DX11SaveTextureToMemory([In] ID3D11DeviceContext* pContext,[In] ID3D11Resource* pSrcTexture,[In] D3DX11_IMAGE_FILE_FORMAT DestFormat,[Out] ID3D10Blob** ppDestBuf,[In] unsigned int Flags) + D3DX11SaveTextureToMemory +
+ + +

Converts a height map into a normal map. The (x,y,z) components of each normal are mapped to the (r,g,b) channels of the output texture.

+
+

Pointer to an interface, representing the source height-map texture.

+

Pointer to an interface, representing the source height-map texture.

+

One or more flags that control generation of normal maps.

+

One flag specifying the source of height information.

+

Constant value multiplier that increases (or decreases) the values in the normal map. Higher values usually make bumps more visible, lower values usually make bumps less visible.

+

Pointer to an interface, representing the destination texture.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following value: .

+ +

This method computes the normal by using the central difference with a kernel size of 3x3. RGB channels in the destination contain biased (x,y,z) components of the normal. The central differencing denominator is hardcoded to 2.0.

+
+ + ff476264 + HRESULT D3DX11ComputeNormalMap([In] ID3D11DeviceContext* pContext,[In] ID3D11Texture2D* pSrcTexture,[In] D3DX11_NORMALMAP_FLAG Flags,[In] D3DX11_CHANNEL_FLAG Channel,[In] float Amplitude,[In] ID3D11Texture2D* pDestTexture) + D3DX11ComputeNormalMap +
+ + +

Retrieves information about a given image in a resource.

+
+

Module where the resource is loaded. Set this parameter to null to specify the module associated with the image that the operating system used to create the current process.

+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR. See Remarks.

+

Optional thread pump that can be used to load the info asynchronously. Can be null. See Interface.

+

Pointer to a structure to be filled with the description of the data in the source file.

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following:

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DX11GetImageInfoFromResourceA because ANSI strings are being used.

+
+ + ff476293 + HRESULT D3DX11GetImageInfoFromResourceW([In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] ID3DX11ThreadPump* pPump,[In] D3DX11_IMAGE_INFO* pSrcInfo,[Out] HRESULT* pHResult) + D3DX11GetImageInfoFromResourceW +
+ + +

Create a shader-resource view from a file.

+
+

A reference to the device (see ) that will use the resource.

+

Name of the file that contains the shader-resource view. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR.

+

Optional. Identifies the characteristics of a texture (see ) when the data processor is created; set this to null to read the characteristics of a texture when the texture is loaded.

+

Pointer to a thread-pump interface (see Interface). If null is specified, this function will behave synchronously and will not return until it is finished.

+

Address of a reference to the shader-resource view (see ).

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476283 + HRESULT D3DX11CreateShaderResourceViewFromFileW([In] ID3D11Device* pDevice,[In] const wchar_t* pSrcFile,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[In] ID3DX11ThreadPump* pPump,[In] ID3D11ShaderResourceView** ppShaderResourceView,[Out] HRESULT* pHResult) + D3DX11CreateShaderResourceViewFromFileW +
+ + +

Create a texture resource from a file.

+
+

A reference to the device (see ) that will use the resource.

+

The name of the file containing the resource. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR.

+

Optional. Identifies the characteristics of a texture (see ) when the data processor is created; set this to null to read the characteristics of a texture when the texture is loaded.

+

A reference to a thread pump interface (see Interface). If null is specified, this function will behave synchronously and will not return until it is finished.

+

The address of a reference to the texture resource (see ).

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476286 + HRESULT D3DX11CreateTextureFromFileW([In] ID3D11Device* pDevice,[In] const wchar_t* pSrcFile,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[In] ID3DX11ThreadPump* pPump,[Out] void** ppTexture,[Out] HRESULT* pHResult) + D3DX11CreateTextureFromFileW +
+ + +

Generates mipmap chain using a particular texture filter.

+
+

A reference to an object.

+

The texture object to be filtered. See .

+

The mipmap level whose data is used to generate the rest of the mipmap chain.

+

Flags controlling how each miplevel is filtered (or D3DX11_DEFAULT for ). See .

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476290 + HRESULT D3DX11FilterTexture([In] ID3D11DeviceContext* pContext,[In] ID3D11Resource* pTexture,[In] unsigned int SrcLevel,[In] unsigned int MipFilter) + D3DX11FilterTexture +
+ + +

Retrieves information about a given image file.

+
+

File name of image to retrieve information about. If UNICODE or _UNICODE are defined, this parameter type is LPCWSTR, otherwise, the type is LPCSTR.

+

Optional thread pump that can be used to load the info asynchronously. Can be null. See Interface.

+

Pointer to a to be filled with the description of the data in the source file.

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following:

+ +

This function supports both Unicode and ANSI strings.

+
+ + ff476291 + HRESULT D3DX11GetImageInfoFromFileW([In] const wchar_t* pSrcFile,[In] ID3DX11ThreadPump* pPump,[In] D3DX11_IMAGE_INFO* pSrcInfo,[Out] HRESULT* pHResult) + D3DX11GetImageInfoFromFileW +
+ + +

Create a shader-resource view from a resource.

+
+

A reference to the device (see ) that will use the resource.

+

Handle to the resource module containing the shader-resource view. HMODULE can be obtained with GetModuleHandle Function.

+

Name of the shader resource view in hSrcModule. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR.

+

Optional. Identifies the characteristics of a texture (see ) when the data processor is created; set this to null to read the characteristics of a texture when the texture is loaded.

+

A reference to a thread pump interface (see Interface). If null is specified, this function will behave synchronously and will not return until it is finished.

+

Address of a reference to the shader-resource view (see ).

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476285 + HRESULT D3DX11CreateShaderResourceViewFromResourceW([In] ID3D11Device* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[In] ID3DX11ThreadPump* pPump,[In] ID3D11ShaderResourceView** ppShaderResourceView,[Out] HRESULT* pHResult) + D3DX11CreateShaderResourceViewFromResourceW +
+ + +

Load a texture from a texture.

+
+

A reference to an object.

+

Pointer to the source texture. See .

+

Pointer to texture loading parameters. See .

+

Pointer to the destination texture. See .

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476294 + HRESULT D3DX11LoadTextureFromTexture([In] ID3D11DeviceContext* pContext,[In] ID3D11Resource* pSrcTexture,[In] D3DX11_TEXTURE_LOAD_INFO* pLoadInfo,[In] ID3D11Resource* pDstTexture) + D3DX11LoadTextureFromTexture +
+ + +

Get information about an image already loaded into memory.

+
+

Pointer to the image in memory.

+

Size of the image in memory, in bytes.

+

Optional thread pump that can be used to load the info asynchronously. Can be null. See Interface.

+

Information about the image in memory.

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476292 + HRESULT D3DX11GetImageInfoFromMemory([In] const void* pSrcData,[In] SIZE_T SrcDataSize,[In] ID3DX11ThreadPump* pPump,[In] D3DX11_IMAGE_INFO* pSrcInfo,[Out] HRESULT* pHResult) + D3DX11GetImageInfoFromMemory +
+ + +

Create a texture resource from a file residing in system memory.

+
+

A reference to the device (see ) that will use the resource.

+

Pointer to the resource in system memory.

+

Size of the resource in system memory.

+

Optional. Identifies the characteristics of a texture (see ) when the data processor is created; set this to null to read the characteristics of a texture when the texture is loaded.

+

A reference to a thread pump interface (see Interface). If null is specified, this function will behave synchronously and will not return until it is finished.

+

Address of a reference to the created resource. See .

+

A reference to the return value. May be null. If pPump is not null, then pHResult must be a valid memory location until the asynchronous execution completes.

+

The return value is one of the values listed in Direct3D 11 Return Codes.

+ + ff476287 + HRESULT D3DX11CreateTextureFromMemory([In] ID3D11Device* pDevice,[In] const void* pSrcData,[In] SIZE_T SrcDataSize,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[In] ID3DX11ThreadPump* pPump,[Out] void** ppTexture,[Out] HRESULT* pHResult) + D3DX11CreateTextureFromMemory +
+ + +

Save a texture to a file.

+
+

A reference to an object.

+

Pointer to the texture to be saved. See .

+

The format the texture will be saved as (see ). is the preferred format since it is the only option that supports all the formats in .

+

Name of the destination output file where the texture will be saved. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR.

+

The return value is one of the values listed in Direct3D 11 Return Codes; use the return value to see if the DestFormat is supported.

+ +

writes out the extra DDS_HEADER_DXT10 structure for the input texture only if necessary (for example, because the input texture is in standard RGB (sRGB) format). If writes out the DDS_HEADER_DXT10 structure, it sets the dwFourCC member of the DDS_PIXELFORMAT structure for the texture to DX10 to indicate the prescense of the DDS_HEADER_DXT10 extended header.

+
+ + ff476298 + HRESULT D3DX11SaveTextureToFileW([In] ID3D11DeviceContext* pContext,[In] ID3D11Resource* pSrcTexture,[In] D3DX11_IMAGE_FILE_FORMAT DestFormat,[In] const wchar_t* pDestFile) + D3DX11SaveTextureToFileW +
+ + + Functions + + + + + Constant TooManyUniqueViewObjects. + D3D11_ERROR_TOO_MANY_UNIQUE_VIEW_OBJECTS + + + Constant DeferredContextMapWithoutInitialDiscard. + D3D11_ERROR_DEFERRED_CONTEXT_MAP_WITHOUT_INITIAL_DISCARD + + + Constant TooManyUniqueStateObjects. + D3D11_ERROR_TOO_MANY_UNIQUE_STATE_OBJECTS + + + Constant FileNotFound. + D3D11_ERROR_FILE_NOT_FOUND + + + Constant CannotModifyIndexBuffer. + D3DX11_ERR_CANNOT_MODIFY_INDEX_BUFFER + + + Constant CannotAttrSort. + D3DX11_ERR_CANNOT_ATTR_SORT + + + Constant LoadedMeshHasNoData. + D3DX11_ERR_LOADED_MESH_HAS_NO_DATA + + + Constant CannotRemoveLastItem. + D3DX11_ERR_CANNOT_REMOVE_LAST_ITEM + + + Constant DuplicateNamedFragment. + D3DX11_ERR_DUPLICATE_NAMED_FRAGMENT + + + Constant InvalidMesh. + D3DX11_ERR_INVALID_MESH + + + Constant InvalidData. + D3DX11_ERR_INVALID_DATA + + + Constant SkinningNotSupported. + D3DX11_ERR_SKINNING_NOT_SUPPORTED + + + Constant TooManyInfluences. + D3DX11_ERR_TOO_MANY_INFLUENCES + + + +

The interface encapsulates a list of graphics commands for play back.

+
+ +

There is no explicit creation method, simply declare an interface, then call to record commands or to play back commands.

+
+ + ff476361 + ID3D11CommandList + ID3D11CommandList +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the initialization flags associated with the deferred context that created the command list.

+
+

The context flag is reserved for future use and is always 0.

+ +

The GetContextFlags method gets the flags that were supplied to the ContextFlags parameter of ; however, the context flag is reserved for future use.

+
+ + ff476362 + unsigned int ID3D11CommandList::GetContextFlags() + ID3D11CommandList::GetContextFlags +
+ + +

Gets the initialization flags associated with the deferred context that created the command list.

+
+ +

The GetContextFlags method gets the flags that were supplied to the ContextFlags parameter of ; however, the context flag is reserved for future use.

+
+ + ff476362 + GetContextFlags + GetContextFlags + unsigned int ID3D11CommandList::GetContextFlags() +
+ + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Bind an array of shader resources to the domain-shader stage.

+
+

Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to - 1).

+

Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources(ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to set to the device.

+ +

If an overlapping resource view is already bound to an output slot, such as a render target, then the method will fill the destination shader resource slot with null.

For information about creating shader-resource views, see .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476421 + void ID3D11DeviceContext::DSSetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[In, Buffer] const void** ppShaderResourceViews) + ID3D11DeviceContext::DSSetShaderResources +
+ + +

Set a domain shader to the device.

+
+

Pointer to a domain shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476420 + void ID3D11DeviceContext::DSSetShader([In, Optional] ID3D11DomainShader* pDomainShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::DSSetShader +
+ + +

Set a domain shader to the device.

+
+

Pointer to a domain shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476420 + void ID3D11DeviceContext::DSSetShader([In, Optional] ID3D11DomainShader* pDomainShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::DSSetShader +
+ + +

Set an array of sampler states to the domain-shader stage.

+
+

Index into the device's zero-based array to begin setting samplers to (ranges from 0 to - 1).

+

Number of samplers in the array. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ). See Remarks.

+ +

Any sampler may be set to null; this invokes the default state, which is defined to be the following.

 //Default sampler state:	
+             SamplerDesc;	
+            SamplerDesc.Filter = ;	
+            SamplerDesc.AddressU = ;	
+            SamplerDesc.AddressV = ;	
+            SamplerDesc.AddressW = ;	
+            SamplerDesc.MipLODBias = 0;	
+            SamplerDesc.MaxAnisotropy = 1;	
+            SamplerDesc.ComparisonFunc = ;	
+            SamplerDesc.BorderColor[0] = 1.0f;	
+            SamplerDesc.BorderColor[1] = 1.0f;	
+            SamplerDesc.BorderColor[2] = 1.0f;	
+            SamplerDesc.BorderColor[3] = 1.0f;	
+            SamplerDesc.MinLOD = -FLT_MAX;	
+            SamplerDesc.MaxLOD = FLT_MAX; 

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476419 + void ID3D11DeviceContext::DSSetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[In, Buffer] const void** ppSamplers) + ID3D11DeviceContext::DSSetSamplers +
+ + +

Sets the constant buffers used by the domain-shader stage.

+
+

Index into the zero-based array to begin setting constant buffers to (ranges from 0 to - 1).

+

Number of buffers to set (ranges from 0 to - StartSlot).

+

Array of constant buffers (see ) being given to the device.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, can bind a larger number of resources to the shader than the maximum constant buffer size that is supported by shaders (4096 constants ? 4*32-bit components each). When you bind such a large buffer, the shader can access only the first 4096 4*32-bit component constants in the buffer, as if 4096 constants is the full size of the buffer.

If the application wants the shader to access other parts of the buffer, it must call the DSSetConstantBuffers1 method instead.

+
+ + ff476418 + void ID3D11DeviceContext::DSSetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void** ppConstantBuffers) + ID3D11DeviceContext::DSSetConstantBuffers +
+ + +

Get the domain-shader resources.

+
+

Index into the device's zero-based array to begin getting shader resources from (ranges from 0 to - 1).

+

The number of resources to get from the device. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476417 + void ID3D11DeviceContext::DSGetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[Out, Buffer] ID3D11ShaderResourceView** ppShaderResourceViews) + ID3D11DeviceContext::DSGetShaderResources +
+ + +

Get the domain shader currently set on the device.

+
+

Address of a reference to a domain shader (see ) to be returned by the method.

+

Pointer to an array of class instance interfaces (see ).

+

The number of class-instance elements in the array.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476416 + void ID3D11DeviceContext::DSGetShader([Out] ID3D11DomainShader** ppDomainShader,[Out, Buffer, Optional] ID3D11ClassInstance** ppClassInstances,[InOut] unsigned int* pNumClassInstances) + ID3D11DeviceContext::DSGetShader +
+ + +

Get an array of sampler state interfaces from the domain-shader stage.

+
+

Index into a zero-based array to begin getting samplers from (ranges from 0 to - 1).

+

Number of samplers to get from a device context. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ).

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476415 + void ID3D11DeviceContext::DSGetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[Out, Buffer] ID3D11SamplerState** ppSamplers) + ID3D11DeviceContext::DSGetSamplers +
+ + +

Get the constant buffers used by the domain-shader stage.

+
+

Index into the device's zero-based array to begin retrieving constant buffers from (ranges from 0 to - 1).

+

Number of buffers to retrieve (ranges from 0 to - StartSlot).

+

Array of constant buffer interface references (see ) to be returned by the method.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476414 + void ID3D11DeviceContext::DSGetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[Out, Buffer] ID3D11Buffer** ppConstantBuffers) + ID3D11DeviceContext::DSGetConstantBuffers +
+ + +

A geometry-shader interface manages an executable program (a geometry shader) that controls the geometry-shader stage.

+
+ +

The geometry-shader interface has no methods; use HLSL to implement your shader functionality. All shaders are implemented from a common set of features referred to as the common-shader core..

To create a geometry shader interface, call either or . Before using a geometry shader you must bind it to the device by calling .

This interface is defined in D3D11.h.

+
+ + ff476536 + ID3D11GeometryShader + ID3D11GeometryShader +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + Initializes a new instance of the class. + + The device used to create the shader. + The compiled shader bytecode. + A dynamic class linkage interface. + + + + Initializes a new instance of the class. + + The device used to create the shader. + The compiled shader bytecode. + An array of instances describing the layout of the output buffers. + An array of buffer strides; each stride is the size of an element for that buffer. + The index number of the stream to be sent to the rasterizer stage. Set to NoRasterizedStream if no stream is to be rasterized. + A dynamic class linkage interface. + + + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets the constant buffers used by the geometry shader pipeline stage.

+
+

Index into the device's zero-based array to begin setting constant buffers to (ranges from 0 to - 1).

+

Number of buffers to set (ranges from 0 to - StartSlot).

+

Array of constant buffers (see ) being given to the device.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

You can't use the interface to get information about what is currently bound to the pipeline in the device context. But you can use to get information from a compiled shader. For example, you can use and to determine the slot in which a geometry shader expects a constant buffer. You can then pass this slot number to GSSetConstantBuffers to set the constant buffer. You can call the D3D11Reflect function to retrieve the address of a reference to the interface and then call to get a reference to .

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, can bind a larger number of resources to the shader than the maximum constant buffer size that is supported by shaders (4096 constants ? 4*32-bit components each). When you bind such a large buffer, the shader can access only the first 4096 4*32-bit component constants in the buffer, as if 4096 constants is the full size of the buffer.

If the application wants the shader to access other parts of the buffer, it must call the GSSetConstantBuffers1 method instead.

+
+ + ff476436 + void ID3D11DeviceContext::GSSetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void** ppConstantBuffers) + ID3D11DeviceContext::GSSetConstantBuffers +
+ + +

Set a geometry shader to the device.

+
+

Pointer to a geometry shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476438 + void ID3D11DeviceContext::GSSetShader([In, Optional] ID3D11GeometryShader* pShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::GSSetShader +
+ + +

Set a geometry shader to the device.

+
+

Pointer to a geometry shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476438 + void ID3D11DeviceContext::GSSetShader([In, Optional] ID3D11GeometryShader* pShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::GSSetShader +
+ + +

Bind an array of shader resources to the geometry shader stage.

+
+

Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to - 1).

+

Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources(ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to set to the device.

+ +

If an overlapping resource view is already bound to an output slot, such as a render target, then the method will fill the destination shader resource slot with null.

For information about creating shader-resource views, see .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476439 + void ID3D11DeviceContext::GSSetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[In, Buffer] const void** ppShaderResourceViews) + ID3D11DeviceContext::GSSetShaderResources +
+ + +

Set an array of sampler states to the geometry shader pipeline stage.

+
+

Index into the device's zero-based array to begin setting samplers to (ranges from 0 to - 1).

+

Number of samplers in the array. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ). See Remarks.

+ +

Any sampler may be set to null; this invokes the default state, which is defined to be the following.

 //Default sampler state:	
+             SamplerDesc;	
+            SamplerDesc.Filter = ;	
+            SamplerDesc.AddressU = ;	
+            SamplerDesc.AddressV = ;	
+            SamplerDesc.AddressW = ;	
+            SamplerDesc.MipLODBias = 0;	
+            SamplerDesc.MaxAnisotropy = 1;	
+            SamplerDesc.ComparisonFunc = ;	
+            SamplerDesc.BorderColor[0] = 1.0f;	
+            SamplerDesc.BorderColor[1] = 1.0f;	
+            SamplerDesc.BorderColor[2] = 1.0f;	
+            SamplerDesc.BorderColor[3] = 1.0f;	
+            SamplerDesc.MinLOD = -FLT_MAX;	
+            SamplerDesc.MaxLOD = FLT_MAX; 

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476437 + void ID3D11DeviceContext::GSSetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[In, Buffer] const void** ppSamplers) + ID3D11DeviceContext::GSSetSamplers +
+ + +

Get the constant buffers used by the geometry shader pipeline stage.

+
+

Index into the device's zero-based array to begin retrieving constant buffers from (ranges from 0 to - 1).

+

Number of buffers to retrieve (ranges from 0 to - StartSlot).

+

Array of constant buffer interface references (see ) to be returned by the method.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476432 + void ID3D11DeviceContext::GSGetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[Out, Buffer] ID3D11Buffer** ppConstantBuffers) + ID3D11DeviceContext::GSGetConstantBuffers +
+ + +

Get the geometry shader currently set on the device.

+
+

Address of a reference to a geometry shader (see ) to be returned by the method.

+

Pointer to an array of class instance interfaces (see ).

+

The number of class-instance elements in the array.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476434 + void ID3D11DeviceContext::GSGetShader([Out] ID3D11GeometryShader** ppGeometryShader,[Out, Buffer, Optional] ID3D11ClassInstance** ppClassInstances,[InOut] unsigned int* pNumClassInstances) + ID3D11DeviceContext::GSGetShader +
+ + +

Get the geometry shader resources.

+
+

Index into the device's zero-based array to begin getting shader resources from (ranges from 0 to - 1).

+

The number of resources to get from the device. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476435 + void ID3D11DeviceContext::GSGetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[Out, Buffer] ID3D11ShaderResourceView** ppShaderResourceViews) + ID3D11DeviceContext::GSGetShaderResources +
+ + +

Get an array of sampler state interfaces from the geometry shader pipeline stage.

+
+

Index into a zero-based array to begin getting samplers from (ranges from 0 to - 1).

+

Number of samplers to get from a device context. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ).

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476433 + void ID3D11DeviceContext::GSGetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[Out, Buffer] ID3D11SamplerState** ppSamplers) + ID3D11DeviceContext::GSGetSamplers +
+ + +

A hull-shader interface manages an executable program (a hull shader) that controls the hull-shader stage.

+
+ +

The hull-shader interface has no methods; use HLSL to implement your shader functionality. All shaders are implemented from a common set of features referred to as the common-shader core..

To create a hull-shader interface, call . Before using a hull shader you must bind it to the device by calling .

This interface is defined in D3D11.h.

+
+ + ff476537 + ID3D11HullShader + ID3D11HullShader +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + Initializes a new instance of the class. + + The device used to create the shader. + The compiled shader bytecode. + A dynamic class linkage interface. + + + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Bind an array of shader resources to the hull-shader stage.

+
+ No documentation. + No documentation. + No documentation. + +

If an overlapping resource view is already bound to an output slot, such as a render target, then the method will fill the destination shader resource slot with null.

For information about creating shader-resource views, see .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476448 + void ID3D11DeviceContext::HSSetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[In, Buffer] const void** ppShaderResourceViews) + ID3D11DeviceContext::HSSetShaderResources +
+ + +

Set a hull shader to the device.

+
+

Pointer to a hull shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476447 + void ID3D11DeviceContext::HSSetShader([In, Optional] ID3D11HullShader* pHullShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::HSSetShader +
+ + +

Set a hull shader to the device.

+
+

Pointer to a hull shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476447 + void ID3D11DeviceContext::HSSetShader([In, Optional] ID3D11HullShader* pHullShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::HSSetShader +
+ + +

Set an array of sampler states to the hull-shader stage.

+
+ No documentation. + No documentation. + No documentation. + +

Any sampler may be set to null; this invokes the default state, which is defined to be the following.

 //Default sampler state:	
+             SamplerDesc;	
+            SamplerDesc.Filter = ;	
+            SamplerDesc.AddressU = ;	
+            SamplerDesc.AddressV = ;	
+            SamplerDesc.AddressW = ;	
+            SamplerDesc.MipLODBias = 0;	
+            SamplerDesc.MaxAnisotropy = 1;	
+            SamplerDesc.ComparisonFunc = ;	
+            SamplerDesc.BorderColor[0] = 1.0f;	
+            SamplerDesc.BorderColor[1] = 1.0f;	
+            SamplerDesc.BorderColor[2] = 1.0f;	
+            SamplerDesc.BorderColor[3] = 1.0f;	
+            SamplerDesc.MinLOD = -FLT_MAX;	
+            SamplerDesc.MaxLOD = FLT_MAX; 

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476446 + void ID3D11DeviceContext::HSSetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[In, Buffer] const void** ppSamplers) + ID3D11DeviceContext::HSSetSamplers +
+ + +

Set the constant buffers used by the hull-shader stage.

+
+ No documentation. + No documentation. + No documentation. + +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, can bind a larger number of resources to the shader than the maximum constant buffer size that is supported by shaders (4096 constants ? 4*32-bit components each). When you bind such a large buffer, the shader can access only the first 4096 4*32-bit component constants in the buffer, as if 4096 constants is the full size of the buffer.

If the application wants the shader to access other parts of the buffer, it must call the HSSetConstantBuffers1 method instead.

+
+ + ff476445 + void ID3D11DeviceContext::HSSetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void** ppConstantBuffers) + ID3D11DeviceContext::HSSetConstantBuffers +
+ + +

Get the hull-shader resources.

+
+

Index into the device's zero-based array to begin getting shader resources from (ranges from 0 to - 1).

+

The number of resources to get from the device. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476443 + void ID3D11DeviceContext::HSGetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[Out, Buffer] ID3D11ShaderResourceView** ppShaderResourceViews) + ID3D11DeviceContext::HSGetShaderResources +
+ + +

Get the hull shader currently set on the device.

+
+

Address of a reference to a hull shader (see ) to be returned by the method.

+

Pointer to an array of class instance interfaces (see ).

+

The number of class-instance elements in the array.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476442 + void ID3D11DeviceContext::HSGetShader([Out] ID3D11HullShader** ppHullShader,[Out, Buffer, Optional] ID3D11ClassInstance** ppClassInstances,[InOut] unsigned int* pNumClassInstances) + ID3D11DeviceContext::HSGetShader +
+ + +

Get an array of sampler state interfaces from the hull-shader stage.

+
+ No documentation. + No documentation. + No documentation. + +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476441 + void ID3D11DeviceContext::HSGetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[Out, Buffer] ID3D11SamplerState** ppSamplers) + ID3D11DeviceContext::HSGetSamplers +
+ + +

Get the constant buffers used by the hull-shader stage.

+
+ No documentation. + No documentation. + No documentation. + +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476440 + void ID3D11DeviceContext::HSGetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[Out, Buffer] ID3D11Buffer** ppConstantBuffers) + ID3D11DeviceContext::HSGetConstantBuffers +
+ + +

An information-queue interface stores, retrieves, and filters debug messages. The queue consists of a message queue, an optional storage filter stack, and a optional retrieval filter stack.

+
+ +

To get this interface, turn on debug layer and use IUnknown::QueryInterface from the .

+
+ + ff476538 + ID3D11InfoQueue + ID3D11InfoQueue +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Set the maximum number of messages that can be added to the message queue.

+
+

Maximum number of messages that can be added to the message queue. -1 means no limit.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

When the number of messages in the message queue has reached the maximum limit, new messages coming in will push old messages out.

+
+ + ff476573 + HRESULT ID3D11InfoQueue::SetMessageCountLimit([In] unsigned longlong MessageCountLimit) + ID3D11InfoQueue::SetMessageCountLimit +
+ + +

Clear all messages from the message queue.

+
+ + ff476545 + void ID3D11InfoQueue::ClearStoredMessages() + ID3D11InfoQueue::ClearStoredMessages +
+ + +

Get a message from the message queue.

+
+

Index into message queue after an optional retrieval filter has been applied. This can be between 0 and the number of messages in the message queue that pass through the retrieval filter (which can be obtained with ). 0 is the message at the front of the message queue.

+

Returned message (see ).

+

Size of pMessage in bytes, including the size of the message string that the pMessage points to.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

This method does not remove any messages from the message queue.

This method gets messages from the message queue after an optional retrieval filter has been applied.

Applications should call this method twice to retrieve a message - first to obtain the size of the message and second to get the message. Here is a typical example:

 // Get the size of the message	
+             messageLength = 0;	
+             hr = pInfoQueue->GetMessage(0, null, &messageLength); // Allocate space and get the message	
+             * pMessage = (*)malloc(messageLength);	
+            hr = pInfoQueue->GetMessage(0, pMessage, &messageLength);	
+            

For an overview see Information Queue Overview.

+
+ + ff476549 + HRESULT ID3D11InfoQueue::GetMessageW([In] unsigned longlong MessageIndex,[In] void* pMessage,[InOut] SIZE_T* pMessageByteLength) + ID3D11InfoQueue::GetMessageW +
+ + +

Get the number of messages that were allowed to pass through a storage filter.

+
+

Number of messages allowed by a storage filter.

+ + ff476552 + unsigned longlong ID3D11InfoQueue::GetNumMessagesAllowedByStorageFilter() + ID3D11InfoQueue::GetNumMessagesAllowedByStorageFilter +
+ + +

Get the number of messages that were denied passage through a storage filter.

+
+

Number of messages denied by a storage filter.

+ + ff476553 + unsigned longlong ID3D11InfoQueue::GetNumMessagesDeniedByStorageFilter() + ID3D11InfoQueue::GetNumMessagesDeniedByStorageFilter +
+ + +

Get the number of messages currently stored in the message queue.

+
+

Number of messages currently stored in the message queue.

+ + ff476556 + unsigned longlong ID3D11InfoQueue::GetNumStoredMessages() + ID3D11InfoQueue::GetNumStoredMessages +
+ + +

Get the number of messages that are able to pass through a retrieval filter.

+
+

Number of messages allowed by a retrieval filter.

+ + ff476557 + unsigned longlong ID3D11InfoQueue::GetNumStoredMessagesAllowedByRetrievalFilter() + ID3D11InfoQueue::GetNumStoredMessagesAllowedByRetrievalFilter +
+ + +

Get the number of messages that were discarded due to the message count limit.

+
+

Number of messages discarded.

+ +

Get and set the message count limit with and , respectively.

+
+ + ff476554 + unsigned longlong ID3D11InfoQueue::GetNumMessagesDiscardedByMessageCountLimit() + ID3D11InfoQueue::GetNumMessagesDiscardedByMessageCountLimit +
+ + +

Get the maximum number of messages that can be added to the message queue.

+
+

Maximum number of messages that can be added to the queue. -1 means no limit.

+ +

When the number of messages in the message queue has reached the maximum limit, new messages coming in will push old messages out.

+
+ + ff476550 + unsigned longlong ID3D11InfoQueue::GetMessageCountLimit() + ID3D11InfoQueue::GetMessageCountLimit +
+ + +

Add storage filters to the top of the storage-filter stack.

+
+

Array of storage filters (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476542 + HRESULT ID3D11InfoQueue::AddStorageFilterEntries([In] D3D11_INFO_QUEUE_FILTER* pFilter) + ID3D11InfoQueue::AddStorageFilterEntries +
+ + +

Get the storage filter at the top of the storage-filter stack.

+
+

Storage filter at the top of the storage-filter stack.

+

Size of the storage filter in bytes. If pFilter is null, the size of the storage filter will be output to this parameter.

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476560 + HRESULT ID3D11InfoQueue::GetStorageFilter([In] void* pFilter,[InOut] SIZE_T* pFilterByteLength) + ID3D11InfoQueue::GetStorageFilter +
+ + +

Remove a storage filter from the top of the storage-filter stack.

+
+ + ff476544 + void ID3D11InfoQueue::ClearStorageFilter() + ID3D11InfoQueue::ClearStorageFilter +
+ + +

Push an empty storage filter onto the storage-filter stack.

+
+

This method returns one of the following Direct3D 11 Return Codes.

+ +

An empty storage filter allows all messages to pass through.

+
+ + ff476567 + HRESULT ID3D11InfoQueue::PushEmptyStorageFilter() + ID3D11InfoQueue::PushEmptyStorageFilter +
+ + +

Push a copy of storage filter currently on the top of the storage-filter stack onto the storage-filter stack.

+
+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476565 + HRESULT ID3D11InfoQueue::PushCopyOfStorageFilter() + ID3D11InfoQueue::PushCopyOfStorageFilter +
+ + +

Push a storage filter onto the storage-filter stack.

+
+

Pointer to a storage filter (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476569 + HRESULT ID3D11InfoQueue::PushStorageFilter([In] D3D11_INFO_QUEUE_FILTER* pFilter) + ID3D11InfoQueue::PushStorageFilter +
+ + +

Pop a storage filter from the top of the storage-filter stack.

+
+ + ff476563 + void ID3D11InfoQueue::PopStorageFilter() + ID3D11InfoQueue::PopStorageFilter +
+ + +

Get the size of the storage-filter stack in bytes.

+
+

Size of the storage-filter stack in bytes.

+ + ff476561 + unsigned int ID3D11InfoQueue::GetStorageFilterStackSize() + ID3D11InfoQueue::GetStorageFilterStackSize +
+ + +

Add storage filters to the top of the retrieval-filter stack.

+
+

Array of retrieval filters (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

The following code example shows how to use :

  cats[] = { ..., ..., ... };	
+             sevs[] = { ..., ..., ... };	
+            UINT ids[] = { ..., ..., ... };  filter;	
+            memset( &filter, 0, sizeof(filter) ); // To set the type of messages to allow, 	
+            // set filter.AllowList as follows:	
+            filter.AllowList.NumCategories = sizeof(cats / sizeof()); 	
+            filter.AllowList.pCategoryList = cats;	
+            filter.AllowList.NumSeverities = sizeof(sevs / sizeof()); 	
+            filter.AllowList.pSeverityList = sevs;	
+            filter.AllowList.NumIDs = sizeof(ids) / sizeof(UINT);	
+            filter.AllowList.pIDList = ids; // To set the type of messages to deny, set filter.DenyList 	
+            // similarly to the preceding filter.AllowList. // The following single call sets all of the preceding information.	
+            hr = infoQueue->AddRetrievalFilterEntries( &filter );	
+            
+
+ + ff476541 + HRESULT ID3D11InfoQueue::AddRetrievalFilterEntries([In] D3D11_INFO_QUEUE_FILTER* pFilter) + ID3D11InfoQueue::AddRetrievalFilterEntries +
+ + +

Get the retrieval filter at the top of the retrieval-filter stack.

+
+

Retrieval filter at the top of the retrieval-filter stack.

+

Size of the retrieval filter in bytes. If pFilter is null, the size of the retrieval filter will be output to this parameter.

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476558 + HRESULT ID3D11InfoQueue::GetRetrievalFilter([In] void* pFilter,[InOut] SIZE_T* pFilterByteLength) + ID3D11InfoQueue::GetRetrievalFilter +
+ + +

Remove a retrieval filter from the top of the retrieval-filter stack.

+
+ + ff476543 + void ID3D11InfoQueue::ClearRetrievalFilter() + ID3D11InfoQueue::ClearRetrievalFilter +
+ + +

Push an empty retrieval filter onto the retrieval-filter stack.

+
+

This method returns one of the following Direct3D 11 Return Codes.

+ +

An empty retrieval filter allows all messages to pass through.

+
+ + ff476566 + HRESULT ID3D11InfoQueue::PushEmptyRetrievalFilter() + ID3D11InfoQueue::PushEmptyRetrievalFilter +
+ + +

Push a copy of retrieval filter currently on the top of the retrieval-filter stack onto the retrieval-filter stack.

+
+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476564 + HRESULT ID3D11InfoQueue::PushCopyOfRetrievalFilter() + ID3D11InfoQueue::PushCopyOfRetrievalFilter +
+ + +

Push a retrieval filter onto the retrieval-filter stack.

+
+

Pointer to a retrieval filter (see ).

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476568 + HRESULT ID3D11InfoQueue::PushRetrievalFilter([In] D3D11_INFO_QUEUE_FILTER* pFilter) + ID3D11InfoQueue::PushRetrievalFilter +
+ + +

Pop a retrieval filter from the top of the retrieval-filter stack.

+
+ + ff476562 + void ID3D11InfoQueue::PopRetrievalFilter() + ID3D11InfoQueue::PopRetrievalFilter +
+ + +

Get the size of the retrieval-filter stack in bytes.

+
+

Size of the retrieval-filter stack in bytes.

+ + ff476559 + unsigned int ID3D11InfoQueue::GetRetrievalFilterStackSize() + ID3D11InfoQueue::GetRetrievalFilterStackSize +
+ + +

Add a debug message to the message queue and send that message to debug output.

+
+

Category of a message (see ).

+

Severity of a message (see ).

+

Unique identifier of a message (see ).

+

User-defined message.

+

This method returns one of the following Direct3D 11 Return Codes.

+ +

This method is used by the runtime's internal mechanisms to add debug messages to the message queue and send them to debug output. For applications to add their own custom messages to the message queue and send them to debug output, call .

+
+ + ff476540 + HRESULT ID3D11InfoQueue::AddMessage([In] D3D11_MESSAGE_CATEGORY Category,[In] D3D11_MESSAGE_SEVERITY Severity,[In] D3D11_MESSAGE_ID ID,[In] const char* pDescription) + ID3D11InfoQueue::AddMessage +
+ + +

Add a user-defined message to the message queue and send that message to debug output.

+
+

Severity of a message (see ).

+

Message string.

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476539 + HRESULT ID3D11InfoQueue::AddApplicationMessage([In] D3D11_MESSAGE_SEVERITY Severity,[In] const char* pDescription) + ID3D11InfoQueue::AddApplicationMessage +
+ + +

Set a message category to break on when a message with that category passes through the storage filter.

+
+

Message category to break on (see ).

+

Turns this breaking condition on or off (true for on, false for off).

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476570 + HRESULT ID3D11InfoQueue::SetBreakOnCategory([In] D3D11_MESSAGE_CATEGORY Category,[In] BOOL bEnable) + ID3D11InfoQueue::SetBreakOnCategory +
+ + +

Set a message severity level to break on when a message with that severity level passes through the storage filter.

+
+

A , which represents a message severity level to break on.

+

Turns this breaking condition on or off (true for on, false for off).

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476572 + HRESULT ID3D11InfoQueue::SetBreakOnSeverity([In] D3D11_MESSAGE_SEVERITY Severity,[In] BOOL bEnable) + ID3D11InfoQueue::SetBreakOnSeverity +
+ + +

Set a message identifier to break on when a message with that identifier passes through the storage filter.

+
+

Message identifier to break on (see ).

+

Turns this breaking condition on or off (true for on, false for off).

+

This method returns one of the following Direct3D 11 Return Codes.

+ + ff476571 + HRESULT ID3D11InfoQueue::SetBreakOnID([In] D3D11_MESSAGE_ID ID,[In] BOOL bEnable) + ID3D11InfoQueue::SetBreakOnID +
+ + +

Get a message category to break on when a message with that category passes through the storage filter.

+
+

Message category to break on (see ).

+

Whether this breaking condition is turned on or off (true for on, false for off).

+ + ff476546 + BOOL ID3D11InfoQueue::GetBreakOnCategory([In] D3D11_MESSAGE_CATEGORY Category) + ID3D11InfoQueue::GetBreakOnCategory +
+ + +

Get a message severity level to break on when a message with that severity level passes through the storage filter.

+
+

Message severity level to break on (see ).

+

Whether this breaking condition is turned on or off (true for on, false for off).

+ + ff476548 + BOOL ID3D11InfoQueue::GetBreakOnSeverity([In] D3D11_MESSAGE_SEVERITY Severity) + ID3D11InfoQueue::GetBreakOnSeverity +
+ + +

Get a message identifier to break on when a message with that identifier passes through the storage filter.

+
+

Message identifier to break on (see ).

+

Whether this breaking condition is turned on or off (true for on, false for off).

+ + ff476547 + BOOL ID3D11InfoQueue::GetBreakOnID([In] D3D11_MESSAGE_ID ID) + ID3D11InfoQueue::GetBreakOnID +
+ + +

Set a boolean that turns the debug output on or off.

+
+

Disable/Enable the debug output (TRUE to disable or mute the output, to enable the output).

+ +

This will stop messages that pass the storage filter from being printed out in the debug output, however those messages will still be added to the message queue.

+
+ + ff476574 + void ID3D11InfoQueue::SetMuteDebugOutput([In] BOOL bMute) + ID3D11InfoQueue::SetMuteDebugOutput +
+ + +

Get a boolean that turns the debug output on or off.

+
+

Whether the debug output is on or off (true for on, false for off).

+ + ff476551 + BOOL ID3D11InfoQueue::GetMuteDebugOutput() + ID3D11InfoQueue::GetMuteDebugOutput +
+ + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3D11InfoQueue::GetMessageW([In] unsigned longlong MessageIndex,[Out, Buffer, Optional] D3D11_MESSAGE* pMessage,[InOut] SIZE_T* pMessageByteLength) + + + + No documentation. + + No documentation. + + HRESULT ID3D11InfoQueue::GetStorageFilter([Out, Buffer, Optional] D3D11_INFO_QUEUE_FILTER* pFilter,[InOut] SIZE_T* pFilterByteLength) + + + + No documentation. + + No documentation. + + HRESULT ID3D11InfoQueue::GetRetrievalFilter([Out, Buffer, Optional] D3D11_INFO_QUEUE_FILTER* pFilter,[InOut] SIZE_T* pFilterByteLength) + + + +

Get or sets the maximum number of messages that can be added to the message queue.

+
+ +

When the number of messages in the message queue has reached the maximum limit, new messages coming in will push old messages out.

+
+ + ff476550 + GetMessageCountLimit / SetMessageCountLimit + GetMessageCountLimit + unsigned longlong ID3D11InfoQueue::GetMessageCountLimit() +
+ + +

Get the number of messages that were allowed to pass through a storage filter.

+
+ + ff476552 + GetNumMessagesAllowedByStorageFilter + GetNumMessagesAllowedByStorageFilter + unsigned longlong ID3D11InfoQueue::GetNumMessagesAllowedByStorageFilter() +
+ + +

Get the number of messages that were denied passage through a storage filter.

+
+ + ff476553 + GetNumMessagesDeniedByStorageFilter + GetNumMessagesDeniedByStorageFilter + unsigned longlong ID3D11InfoQueue::GetNumMessagesDeniedByStorageFilter() +
+ + +

Get the number of messages currently stored in the message queue.

+
+ + ff476556 + GetNumStoredMessages + GetNumStoredMessages + unsigned longlong ID3D11InfoQueue::GetNumStoredMessages() +
+ + +

Get the number of messages that are able to pass through a retrieval filter.

+
+ + ff476557 + GetNumStoredMessagesAllowedByRetrievalFilter + GetNumStoredMessagesAllowedByRetrievalFilter + unsigned longlong ID3D11InfoQueue::GetNumStoredMessagesAllowedByRetrievalFilter() +
+ + +

Get the number of messages that were discarded due to the message count limit.

+
+ +

Get and set the message count limit with and , respectively.

+
+ + ff476554 + GetNumMessagesDiscardedByMessageCountLimit + GetNumMessagesDiscardedByMessageCountLimit + unsigned longlong ID3D11InfoQueue::GetNumMessagesDiscardedByMessageCountLimit() +
+ + +

Get the size of the storage-filter stack in bytes.

+
+ + ff476561 + GetStorageFilterStackSize + GetStorageFilterStackSize + unsigned int ID3D11InfoQueue::GetStorageFilterStackSize() +
+ + +

Get the size of the retrieval-filter stack in bytes.

+
+ + ff476559 + GetRetrievalFilterStackSize + GetRetrievalFilterStackSize + unsigned int ID3D11InfoQueue::GetRetrievalFilterStackSize() +
+ + +

Get or sets a boolean that turns the debug output on or off.

+
+ + ff476551 + GetMuteDebugOutput / SetMuteDebugOutput + GetMuteDebugOutput + BOOL ID3D11InfoQueue::GetMuteDebugOutput() +
+ + +

An input-layout interface holds a definition of how to feed vertex data that is laid out in memory into the input-assembler stage of the graphics pipeline.

+
+ +

To create an input-layout object, call . To bind the input-layout object to the input-assembler stage, call .

+
+ + ff476575 + ID3D11InputLayout + ID3D11InputLayout +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + Initializes a new instance of the object to describe the + input-buffer data for the input-assembler stage. + + ID3D11Device::CreateInputLayout + The device used to create the layout. + An array of input elements describing the layout of the input data. + The compiled shader used to validate the input elements. + + + +

A pixel-shader interface manages an executable program (a pixel shader) that controls the pixel-shader stage.

+
+ +

The pixel-shader interface has no methods; use HLSL to implement your shader functionality. All shaders in are implemented from a common set of features referred to as the common-shader core..

To create a pixel shader interface, call . Before using a pixel shader you must bind it to the device by calling .

This interface is defined in D3D11.h.

+
+ + ff476576 + ID3D11PixelShader + ID3D11PixelShader +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + Initializes a new instance of the class. + + The device used to create the shader. + The compiled shader bytecode. + A dynamic class linkage interface. + + + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + Constant InputRegisterComponentBitCount. + D3D11_PS_INPUT_REGISTER_COMPONENT_BIT_COUNT + + + Constant OutputRegisterComponentBitCount. + D3D11_PS_OUTPUT_REGISTER_COMPONENT_BIT_COUNT + + + Constant PixelCenterFractionalComponent. + D3D11_PS_PIXEL_CENTER_FRACTIONAL_COMPONENT + + + Constant OutputRegisterComponents. + D3D11_PS_OUTPUT_REGISTER_COMPONENTS + + + Constant OutputMaskRegisterComponents. + D3D11_PS_OUTPUT_MASK_REGISTER_COMPONENTS + + + Constant InputRegisterComponents. + D3D11_PS_INPUT_REGISTER_COMPONENTS + + + Constant LegacyPixelCenterFractionalComponent. + D3D11_PS_LEGACY_PIXEL_CENTER_FRACTIONAL_COMPONENT + + + Constant OutputMaskRegisterComponentBitCount. + D3D11_PS_OUTPUT_MASK_REGISTER_COMPONENT_BIT_COUNT + + + Constant OutputMaskRegisterCount. + D3D11_PS_OUTPUT_MASK_REGISTER_COUNT + + + Constant FrontfacingTrueValue. + D3D11_PS_FRONTFACING_TRUE_VALUE + + + Constant OutputDepthRegisterCount. + D3D11_PS_OUTPUT_DEPTH_REGISTER_COUNT + + + Constant OutputDepthRegisterComponents. + D3D11_PS_OUTPUT_DEPTH_REGISTER_COMPONENTS + + + Constant InputRegisterReadsPerInst. + D3D11_PS_INPUT_REGISTER_READS_PER_INST + + + Constant OutputRegisterCount. + D3D11_PS_OUTPUT_REGISTER_COUNT + + + Constant OutputDepthRegisterComponentBitCount. + D3D11_PS_OUTPUT_DEPTH_REGISTER_COMPONENT_BIT_COUNT + + + Constant FrontfacingDefaultValue. + D3D11_PS_FRONTFACING_DEFAULT_VALUE + + + Constant FrontfacingFalseValue. + D3D11_PS_FRONTFACING_FALSE_VALUE + + + Constant InputRegisterCount. + D3D11_PS_INPUT_REGISTER_COUNT + + + Constant InputRegisterReadPorts. + D3D11_PS_INPUT_REGISTER_READ_PORTS + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Bind an array of shader resources to the pixel shader stage.

+
+

Index into the device's zero-based array to begin setting shader resources to (ranges from 0 to - 1).

+

Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to set to the device.

+ +

If an overlapping resource view is already bound to an output slot, such as a rendertarget, then this API will fill the destination shader resource slot with null.

For information about creating shader-resource views, see .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476473 + void ID3D11DeviceContext::PSSetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[In, Buffer] const void** ppShaderResourceViews) + ID3D11DeviceContext::PSSetShaderResources +
+ + +

Sets a pixel shader to the device.

+
+

Pointer to a pixel shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

Set ppClassInstances to null if no interfaces are used in the shader. If it is not null, the number of class instances must match the number of interfaces used in the shader. Furthermore, each interface reference must have a corresponding class instance or the assigned shader will be disabled.

+
+ + ff476472 + void ID3D11DeviceContext::PSSetShader([In, Optional] ID3D11PixelShader* pPixelShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::PSSetShader +
+ + +

Sets a pixel shader to the device.

+
+

Pointer to a pixel shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

Set ppClassInstances to null if no interfaces are used in the shader. If it is not null, the number of class instances must match the number of interfaces used in the shader. Furthermore, each interface reference must have a corresponding class instance or the assigned shader will be disabled.

+
+ + ff476472 + void ID3D11DeviceContext::PSSetShader([In, Optional] ID3D11PixelShader* pPixelShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::PSSetShader +
+ + +

Set an array of sampler states to the pixel shader pipeline stage.

+
+

Index into the device's zero-based array to begin setting samplers to (ranges from 0 to - 1).

+

Number of samplers in the array. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ). See Remarks.

+ +

Any sampler may be set to null; this invokes the default state, which is defined to be the following.

StateDefault Value
Filter
AddressU
AddressV
AddressW
MipLODBias0
MaxAnisotropy1
ComparisonFunc
BorderColor[0]1.0f
BorderColor[1]1.0f
BorderColor[2]1.0f
BorderColor[3]1.0f
MinLOD-FLT_MAX
MaxLODFLT_MAX

?

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476471 + void ID3D11DeviceContext::PSSetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[In, Buffer] const void** ppSamplers) + ID3D11DeviceContext::PSSetSamplers +
+ + +

Sets the constant buffers used by the pixel shader pipeline stage.

+
+

Index into the device's zero-based array to begin setting constant buffers to (ranges from 0 to - 1).

+

Number of buffers to set (ranges from 0 to - StartSlot).

+

Array of constant buffers (see ) being given to the device.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The Direct3D 11.1 runtime, which is available on Windows Developer Preview and later operating systems, can bind a larger number of resources to the shader than the maximum constant buffer size that is supported by shaders (4096 constants ? 4*32-bit components each). When you bind such a large buffer, the shader can access only the first 4096 4*32-bit component constants in the buffer, as if 4096 constants is the full size of the buffer.

If the application wants the shader to access other parts of the buffer, it must call the PSSetConstantBuffers1 method instead.

+
+ + ff476470 + void ID3D11DeviceContext::PSSetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void** ppConstantBuffers) + ID3D11DeviceContext::PSSetConstantBuffers +
+ + +

Get the pixel shader resources.

+
+

Index into the device's zero-based array to begin getting shader resources from (ranges from 0 to - 1).

+

The number of resources to get from the device. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476469 + void ID3D11DeviceContext::PSGetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[Out, Buffer] ID3D11ShaderResourceView** ppShaderResourceViews) + ID3D11DeviceContext::PSGetShaderResources +
+ + +

Get the pixel shader currently set on the device.

+
+

Address of a reference to a pixel shader (see ) to be returned by the method.

+

Pointer to an array of class instance interfaces (see ).

+

The number of class-instance elements in the array.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476468 + void ID3D11DeviceContext::PSGetShader([Out] ID3D11PixelShader** ppPixelShader,[Out, Buffer, Optional] ID3D11ClassInstance** ppClassInstances,[InOut] unsigned int* pNumClassInstances) + ID3D11DeviceContext::PSGetShader +
+ + +

Get an array of sampler states from the pixel shader pipeline stage.

+
+

Index into a zero-based array to begin getting samplers from (ranges from 0 to - 1).

+

Number of samplers to get from a device context. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Arry of sampler-state interface references (see ) to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476467 + void ID3D11DeviceContext::PSGetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[Out, Buffer] ID3D11SamplerState** ppSamplers) + ID3D11DeviceContext::PSGetSamplers +
+ + +

Get the constant buffers used by the pixel shader pipeline stage.

+
+

Index into the device's zero-based array to begin retrieving constant buffers from (ranges from 0 to - 1).

+

Number of buffers to retrieve (ranges from 0 to - StartSlot).

+

Array of constant buffer interface references (see ) to be returned by the method.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476466 + void ID3D11DeviceContext::PSGetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[Out, Buffer] ID3D11Buffer** ppConstantBuffers) + ID3D11DeviceContext::PSGetConstantBuffers +
+ + +

A predicate interface determines whether geometry should be processed depending on the results of a previous draw call.

+
+ +

To create a predicate object, call . To set the predicate object, call .

There are two types of predicates: stream-output-overflow predicates and occlusion predicates. Stream-output-overflow predicates cause any geometry residing in stream-output buffers that were overflowed to not be processed. Occlusion predicates cause any geometry that did not have a single sample pass the depth/stencil tests to not be processed.

+
+ + ff476577 + ID3D11Predicate + ID3D11Predicate +
+ + +

A query interface queries information from the GPU.

+
+ +

A query can be created with .

Query data is typically gathered by issuing an command, issuing some graphics commands, issuing an command, and then calling to get data about what happened in between the Begin and End calls. The data returned by GetData will be different depending on the type of query.

There are, however, some queries that do not require calls to Begin. For a list of possible queries see .

A query is typically executed as shown in the following code:

  queryDesc;	
+            ... // Fill out queryDesc structure	
+             * pQuery;	
+            pDevice->CreateQuery(&queryDesc, &pQuery);	
+            pDeviceContext->Begin(pQuery); ... // Issue graphics commands pDeviceContext->End(pQuery);	
+            UINT64 queryData; // This data type is different depending on the query type while(  != pDeviceContext->GetData(pQuery, &queryData, sizeof(UINT64), 0) )	
+            {	
+            }	
+            

When using a query that does not require a call to Begin, it still requires a call to End. The call to End causes the data returned by GetData to be accurate up until the last call to End.

+
+ + ff476578 + ID3D11Query + ID3D11Query +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a query description.

+
+

Pointer to a query description (see ).

+ + ff476579 + void ID3D11Query::GetDesc([Out] D3D11_QUERY_DESC* pDesc) + ID3D11Query::GetDesc +
+ + + Constructs a new based on the specified description. + + The device with which to associate the state object. + The query description. + The newly created object. + + + +

Get a query description.

+
+ + ff476579 + GetDesc + GetDesc + void ID3D11Query::GetDesc([Out] D3D11_QUERY_DESC* pDesc) +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + Constructs a new based on the specified description. + + The device with which to associate the state object. + The query description. + The newly created object. + + + +

The rasterizer-state interface holds a description for rasterizer state that you can bind to the rasterizer stage.

+
+ +

To create a rasterizer-state object, call . To bind the rasterizer-state object to the rasterizer stage, call .

+
+ + ff476580 + ID3D11RasterizerState + ID3D11RasterizerState +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the description for rasterizer state that you used to create the rasterizer-state object.

+
+

A reference to a structure that receives a description of the rasterizer state.

+ +

You use the description for rasterizer state in a call to the method to create the rasterizer-state object.

+
+ + ff476581 + void ID3D11RasterizerState::GetDesc([Out] D3D11_RASTERIZER_DESC* pDesc) + ID3D11RasterizerState::GetDesc +
+ + +

Create a rasterizer state object that tells the rasterizer stage how to behave.

+
+ The device with which to associate the state object. + A rasterizer state description + +

4096 unique rasterizer state objects can be created on a device at a time.

If an application attempts to create a rasterizer-state interface with the same state as an existing interface, the same interface will be returned and the total number of unique rasterizer state objects will stay the same.

+
+ ff476516 + HRESULT ID3D11Device::CreateRasterizerState([In] const D3D11_RASTERIZER_DESC* pRasterizerDesc,[Out, Fast] ID3D11RasterizerState** ppRasterizerState) + ID3D11Device::CreateRasterizerState +
+ + +

Gets the description for rasterizer state that you used to create the rasterizer-state object.

+
+ +

You use the description for rasterizer state in a call to the method to create the rasterizer-state object.

+
+ + ff476581 + GetDesc + GetDesc + void ID3D11RasterizerState::GetDesc([Out] D3D11_RASTERIZER_DESC* pDesc) +
+ + +

A render-target-view interface identifies the render-target subresources that can be accessed during rendering.

+
+ +

To create a render-target view, call . To bind a render-target view to the pipeline, call .

A rendertarget is a resource that can be written by the output-merger stage at the end of a render pass. Each render-target should also have a corresponding depth-stencil view.

+
+ + ff476582 + ID3D11RenderTargetView + ID3D11RenderTargetView +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the properties of a render target view.

+
+

Pointer to the description of a render target view (see ).

+ + ff476583 + void ID3D11RenderTargetView::GetDesc([Out] D3D11_RENDER_TARGET_VIEW_DESC* pDesc) + ID3D11RenderTargetView::GetDesc +
+ + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the RenderTarget flag. + ID3D11Device::CreateRenderTargetView + + + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the RenderTarget flag. + A structure describing the to be created. + ID3D11Device::CreateRenderTargetView + + + +

Get the properties of a render target view.

+
+ + ff476583 + GetDesc + GetDesc + void ID3D11RenderTargetView::GetDesc([Out] D3D11_RENDER_TARGET_VIEW_DESC* pDesc) +
+ + +

The sampler-state interface holds a description for sampler state that you can bind to any shader stage of the pipeline for reference by texture sample operations.

+
+ +

To create a sampler-state object, call .

To bind a sampler-state object to any pipeline shader stage, call the following methods:

  • ID3D11DeviceContext::HSSetSampler

You can bind the same sampler-state object to multiple shader stages simultaneously.

+
+ + ff476588 + ID3D11SamplerState + ID3D11SamplerState +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the description for sampler state that you used to create the sampler-state object.

+
+

A reference to a structure that receives a description of the sampler state.

+ +

You use the description for sampler state in a call to the method to create the sampler-state object.

+
+ + ff476589 + void ID3D11SamplerState::GetDesc([Out] D3D11_SAMPLER_DESC* pDesc) + ID3D11SamplerState::GetDesc +
+ + + Constructs a new based on the specified description. + + The device with which to associate the state object. + The state description. + The newly created object. + ff476518 + HRESULT ID3D11Device::CreateSamplerState([In] const D3D11_SAMPLER_DESC* pSamplerDesc,[Out, Fast] ID3D11SamplerState** ppSamplerState) + ID3D11Device::CreateSamplerState + + + + Constructs a new based on the specified description. + + The device with which to associate the state object. + The state description. + The newly created object. + ff476518 + HRESULT ID3D11Device::CreateSamplerState([In] const D3D11_SAMPLER_DESC* pSamplerDesc,[Out, Fast] ID3D11SamplerState** ppSamplerState) + ID3D11Device::CreateSamplerState + + + +

Gets the description for sampler state that you used to create the sampler-state object.

+
+ +

You use the description for sampler state in a call to the method to create the sampler-state object.

+
+ + ff476589 + GetDesc + GetDesc + void ID3D11SamplerState::GetDesc([Out] D3D11_SAMPLER_DESC* pDesc) +
+ + +

Sets which direction to perform scans in.

+
+ +

SetScanDirection sets the direction and will performed scans in.

+
+ + ff476857 + ID3DX11Scan + ID3DX11Scan +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets which direction to perform scans in.

+
+

Direction to perform scans in. See .

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

SetScanDirection sets the direction and will performed scans in.

+
+ + ff476857 + HRESULT ID3DX11Scan::SetScanDirection([In] D3DX11_SCAN_DIRECTION Direction) + ID3DX11Scan::SetScanDirection +
+ + +

Performs an unsegmented scan of a sequence.

+
+

The type of element in the sequence. See for more information.

+

The binary operation to perform. See for more information.

+

Size of scan in elements.

+

Input sequence on the device. Set pSrc and pDst to the same value for in-place scans.

+

Output sequence on the device.

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

You must point the parameters pSrc and pDst to typed buffers (and not to raw or structured buffers). For information about buffer types, see Types of Resources. The format of these typed buffers must be , , or DXGI_FORMAT_R32_INT. In addition, the format of these typed buffers must match the scan data type that you specify in the ElementType parameter. For example, if the scan data type is , the buffer formats must be .

+
+ + ff476856 + HRESULT ID3DX11Scan::Scan([In] D3DX11_SCAN_DATA_TYPE ElementType,[In] D3DX11_SCAN_OPCODE OpCode,[In] unsigned int ElementScanSize,[In] ID3D11UnorderedAccessView* pSrc,[In] ID3D11UnorderedAccessView* pDst) + ID3DX11Scan::Scan +
+ + +

Performs a multiscan of a sequence.

+
+

The type of element in the sequence. See for more information.

+

The binary operation to perform. See for more information.

+

Size of scan in elements.

+

Pitch of the next scan in elements.

+

Number of scans in the multiscan.

+

Input sequence on the device. Set pSrc and pDst to the same value for in-place scans.

+

Output sequence on the device.

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

You must point the parameters pSrc and pDst to typed buffers (and not to raw or structured buffers). For information about buffer types, see Types of Resources. The format of these typed buffers must be , , or DXGI_FORMAT_R32_INT. In addition, the format of these typed buffers must match the scan data type that you specify in the ElementType parameter. For example, if the scan data type is , the buffer formats must be .

+
+ + ff476855 + HRESULT ID3DX11Scan::Multiscan([In] D3DX11_SCAN_DATA_TYPE ElementType,[In] D3DX11_SCAN_OPCODE OpCode,[In] unsigned int ElementScanSize,[In] unsigned int ElementScanPitch,[In] unsigned int ScanCount,[In] ID3D11UnorderedAccessView* pSrc,[In] ID3D11UnorderedAccessView* pDst) + ID3DX11Scan::Multiscan +
+ + + Creates a scan context. + + The the scan is associated with. + Maximum single scan size, in elements (FLOAT, UINT, or INT) + Maximum number of scans in multiscan. + HRESULT D3DX11CreateScan([In] ID3D11DeviceContext* pDeviceContext,[None] int MaxElementScanSize,[None] int MaxScanCount,[Out] ID3DX11Scan** ppScan) + + + +

Segmented scan context.

+
+ + ff476858 + ID3DX11SegmentedScan + ID3DX11SegmentedScan +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets which direction to perform scans in.

+
+

Direction to perform scans in. See .

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

SetScanDirection sets the direction will performed scans in.

+
+ + ff476860 + HRESULT ID3DX11SegmentedScan::SetScanDirection([In] D3DX11_SCAN_DIRECTION Direction) + ID3DX11SegmentedScan::SetScanDirection +
+ + +

Performs a segmented scan of a sequence.

+
+

The type of element in the sequence. See for more information.

+

The binary operation to perform. See for more information.

+

Size of scan in elements.

+

Input sequence on the device. Set pSrc and pDst to the same value for in-place scans.

+

Compact array of bits with one bit per element of pSrc. A set value indicates the start of a new segment.

+

Output sequence on the device.

+

Returns one of the return codes described in the topic Direct3D 11 Return Codes.

+ +

You must point the parameters pSrc and pDst to typed buffers (and not to raw or structured buffers). For information about buffer types, see Types of Resources. The format of these typed buffers must be , , or DXGI_FORMAT_R32_INT. In addition, the format of these typed buffers must match the scan data type that you specify in the ElementType parameter. For example, if the scan data type is , the buffer formats must be .

The format of the resource view to which the pSrcElementFlags parameter points must be .

+
+ + ff476859 + HRESULT ID3DX11SegmentedScan::SegScan([In] D3DX11_SCAN_DATA_TYPE ElementType,[In] D3DX11_SCAN_OPCODE OpCode,[In] unsigned int ElementScanSize,[In, Optional] ID3D11UnorderedAccessView* pSrc,[In] ID3D11UnorderedAccessView* pSrcElementFlags,[In] ID3D11UnorderedAccessView* pDst) + ID3DX11SegmentedScan::SegScan +
+ + + Creates a segmented scan context. + + Pointer to an interface. + Maximum single scan size, in elements (FLOAT, UINT, or INT). + HRESULT D3DX11CreateSegmentedScan([In] ID3D11DeviceContext* pDeviceContext,[None] int MaxElementScanSize,[Out] ID3DX11SegmentedScan** ppScan) + + + +

A shader-resource-view interface specifies the subresources a shader can access during rendering. Examples of shader resources include a constant buffer, a texture buffer, a texture or a sampler.

+
+ +

To create a shader-resource view, call .

A shader-resource view is required when binding a resource to a shader stage; the binding occurs by calling , or .

+
+ + ff476628 + ID3D11ShaderResourceView + ID3D11ShaderResourceView +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the shader resource view's description.

+
+

A reference to a structure to be filled with data about the shader resource view.

+ + ff476629 + void ID3D11ShaderResourceView::GetDesc([Out] D3D11_SHADER_RESOURCE_VIEW_DESC* pDesc) + ID3D11ShaderResourceView::GetDesc +
+ + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the ShaderResource flag. + ff476519 + HRESULT ID3D11Device::CreateShaderResourceView([In] ID3D11Resource* pResource,[In, Optional] const D3D11_SHADER_RESOURCE_VIEW_DESC* pDesc,[Out, Fast] ID3D11ShaderResourceView** ppSRView) + ID3D11Device::CreateShaderResourceView + + + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the ShaderResource flag. + A structure describing the to be created. + ff476519 + HRESULT ID3D11Device::CreateShaderResourceView([In] ID3D11Resource* pResource,[In, Optional] const D3D11_SHADER_RESOURCE_VIEW_DESC* pDesc,[Out, Fast] ID3D11ShaderResourceView** ppSRView) + ID3D11Device::CreateShaderResourceView + + + + Create a shader-resource view from a file. Read the characteristics of a texture when the texture is loaded. + + A reference to the device (see ) that will use the resource. + Name of the file that contains the shader-resource view. + Returns a reference to the shader-resource view (see ). + HRESULT D3DX11CreateShaderResourceViewFromFileW([None] ID3D10Device* pDevice,[None] const wchar_t* pSrcFile,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[None] ID3DX11ThreadPump* pPump,[None] ID3D10ShaderResourceView** ppShaderResourceView,[None] HRESULT* pHResult) + + + + Create a shader-resource view from a file. + + A reference to the device (see ) that will use the resource. + Name of the file that contains the shader-resource view. + Identifies the characteristics of a texture (see ) when the data processor is created. + Returns a reference to the shader-resource view (see ). + HRESULT D3DX11CreateShaderResourceViewFromFileW([None] ID3D10Device* pDevice,[None] const wchar_t* pSrcFile,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[None] ID3DX11ThreadPump* pPump,[None] ID3D10ShaderResourceView** ppShaderResourceView,[None] HRESULT* pHResult) + + + + Create a shader-resource view from a file in memory. + + A reference to the device (see ) that will use the resource. + Pointer to a memory location that contains the shader-resource view. + Returns a reference to the shader-resource view (see ). + HRESULT D3DX11CreateShaderResourceViewFromMemory([None] ID3D10Device* pDevice,[None] const void* pSrcData,[None] SIZE_T SrcDataSize,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[None] ID3DX11ThreadPump* pPump,[None] ID3D10ShaderResourceView** ppShaderResourceView,[None] HRESULT* pHResult) + + + + Create a shader-resource view from a file in memory. + + A reference to the device (see ) that will use the resource. + Pointer to a memory location that contains the shader-resource view. + Identifies the characteristics of a texture (see ) when the data processor is created. + Returns a reference to the shader-resource view (see ). + HRESULT D3DX11CreateShaderResourceViewFromMemory([None] ID3D10Device* pDevice,[None] const void* pSrcData,[None] SIZE_T SrcDataSize,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[None] ID3DX11ThreadPump* pPump,[None] ID3D10ShaderResourceView** ppShaderResourceView,[None] HRESULT* pHResult) + + + + Create a shader-resource view from a file in a stream.. + + A reference to the device (see ) that will use the resource. + Pointer to the file in memory that contains the shader-resource view. + Size of the file to read from the stream + Returns a reference to the shader-resource view (see ). + HRESULT D3DX11CreateShaderResourceViewFromMemory([None] ID3D10Device* pDevice,[None] const void* pSrcData,[None] SIZE_T SrcDataSize,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[None] ID3DX11ThreadPump* pPump,[None] ID3D10ShaderResourceView** ppShaderResourceView,[None] HRESULT* pHResult) + + + + Create a shader-resource view from a file in a stream.. + + A reference to the device (see ) that will use the resource. + Pointer to the file in memory that contains the shader-resource view. + Size of the file to read from the stream + Identifies the characteristics of a texture (see ) when the data processor is created. + Returns a reference to the shader-resource view (see ). + HRESULT D3DX11CreateShaderResourceViewFromMemory([None] ID3D10Device* pDevice,[None] const void* pSrcData,[None] SIZE_T SrcDataSize,[In, Optional] D3DX11_IMAGE_LOAD_INFO* pLoadInfo,[None] ID3DX11ThreadPump* pPump,[None] ID3D10ShaderResourceView** ppShaderResourceView,[None] HRESULT* pHResult) + + + +

Get the shader resource view's description.

+
+ + ff476629 + GetDesc + GetDesc + void ID3D11ShaderResourceView::GetDesc([Out] D3D11_SHADER_RESOURCE_VIEW_DESC* pDesc) +
+ + +

Note??The interface and its methods are not supported in Direct3D 11.

+
+ + ff476630 + ID3D11SwitchToRef + ID3D11SwitchToRef +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Note??The interface and its methods are not supported in Direct3D 11.

+
+ No documentation. +

Reserved.

+ + ff476632 + BOOL ID3D11SwitchToRef::SetUseRef([In] BOOL UseRef) + ID3D11SwitchToRef::SetUseRef +
+ + +

Note??The interface and its methods are not supported in Direct3D 11.

+
+

Reserved.

+ + ff476631 + BOOL ID3D11SwitchToRef::GetUseRef() + ID3D11SwitchToRef::GetUseRef +
+ + +

Note??The interface and its methods are not supported in Direct3D 11.

+
+ + ff476631 + GetUseRef + GetUseRef + BOOL ID3D11SwitchToRef::GetUseRef() +
+ + +

A 1D texture interface accesses texel data, which is structured memory.

+
+ +

To create an empty 1D texture, call . For more details on creating and loading textures, see Creating Texture Resources.

Textures cannot be bound directly to the pipeline; instead, a view must be created and bound. Using a view, texture data can be interpreted at run time within certain restrictions. To use the texture as a render target or depth-stencil resource, call , and , respectively. To use the texture as an input to a shader, create a by calling .

+
+ + ff476633 + ID3D11Texture1D + ID3D11Texture1D +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the properties of the texture resource.

+
+

Pointer to a resource description (see ).

+ + ff476634 + void ID3D11Texture1D::GetDesc([Out] D3D11_TEXTURE1D_DESC* pDesc) + ID3D11Texture1D::GetDesc +
+ + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + ff476520 + HRESULT ID3D11Device::CreateTexture1D([In] const D3D11_TEXTURE1D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture1D** ppTexture1D) + ID3D11Device::CreateTexture1D + + + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + An array of initial texture data for each subresource. + ff476520 + HRESULT ID3D11Device::CreateTexture1D([In] const D3D11_TEXTURE1D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture1D** ppTexture1D) + ID3D11Device::CreateTexture1D + + + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + An array of initial texture data for each subresource. + ff476520 + HRESULT ID3D11Device::CreateTexture1D([In] const D3D11_TEXTURE1D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture1D** ppTexture1D) + ID3D11Device::CreateTexture1D + + + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + An array of initial texture data for each subresource. + ff476520 + HRESULT ID3D11Device::CreateTexture1D([In] const D3D11_TEXTURE1D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture1D** ppTexture1D) + ID3D11Device::CreateTexture1D + + + + + + +

Get the properties of the texture resource.

+
+ + ff476634 + GetDesc + GetDesc + void ID3D11Texture1D::GetDesc([Out] D3D11_TEXTURE1D_DESC* pDesc) +
+ + +

A 2D texture interface manages texel data, which is structured memory.

+
+ +

To create an empty Texture2D resource, call . For more details on creating and loading textures, see Creating Texture Resources.

Textures cannot be bound directly to the pipeline; instead, a view must be created and bound. Using a view, texture data can be interpreted at run time within certain restrictions. To use the texture as a render target or depth-stencil resource, call , and , respectively. To use the texture as an input to a shader, create a by calling .

+
+ + ff476635 + ID3D11Texture2D + ID3D11Texture2D +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the properties of the texture resource.

+
+

Pointer to a resource description (see ).

+ + ff476636 + void ID3D11Texture2D::GetDesc([Out] D3D11_TEXTURE2D_DESC* pDesc) + ID3D11Texture2D::GetDesc +
+ + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + ff476521 + HRESULT ID3D11Device::CreateTexture2D([In] const D3D11_TEXTURE2D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture2D** ppTexture2D) + ID3D11Device::CreateTexture2D + + + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + An array of initial texture data for each subresource. + ff476521 + HRESULT ID3D11Device::CreateTexture2D([In] const D3D11_TEXTURE2D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture2D** ppTexture2D) + ID3D11Device::CreateTexture2D + + + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + An array of initial texture data for each subresource. + ff476521 + HRESULT ID3D11Device::CreateTexture2D([In] const D3D11_TEXTURE2D_DESC* pDesc,[In, Buffer, Optional] const D3D11_SUBRESOURCE_DATA* pInitialData,[Out, Fast] ID3D11Texture2D** ppTexture2D) + ID3D11Device::CreateTexture2D + + + + + + + Converts a height map into a normal map. The (x,y,z) components of each normal are mapped to the (r,g,b) channels of the output texture. + + The device used to create the normal map. + The source height map texture. + The destination texture. + One or more flags that control generation of normal maps. + One or more flag specifying the source of height information. + Constant value multiplier that increases (or decreases) the values in the normal map. Higher values usually make bumps more visible, lower values usually make bumps less visible. + A object describing the result of the operation. + + + + Projects a function represented in a cube map into spherical harmonics. + + A reference to an object. + A reference to an that represents a cubemap that is going to be projected into spherical harmonics. + Order of the SH evaluation, generates Order^2 coefficients whose degree is Order-1. Valid range is between 2 and 6. + An array of SH Vector for red, green and blue components with a length Order^2. + HRESULT D3DX11SHProjectCubeMap([In] ID3D11DeviceContext* pContext,[In] unsigned int Order,[In] ID3D11Texture2D* pCubeMap,[Out, Buffer] float* pROut,[Out, Buffer, Optional] float* pGOut,[Out, Buffer, Optional] float* pBOut) + + + +

Get the properties of the texture resource.

+
+ + ff476636 + GetDesc + GetDesc + void ID3D11Texture2D::GetDesc([Out] D3D11_TEXTURE2D_DESC* pDesc) +
+ + +

A 3D texture interface accesses texel data, which is structured memory.

+
+ +

To create an empty Texture3D resource, call . For more details on creating and loading textures, see Creating Texture Resources.

Textures cannot be bound directly to the pipeline; instead, a view must be created and bound. Using a view, texture data can be interpreted at run time within certain restrictions. To use the texture as a render target or depth-stencil resource, call , and , respectively. To use the texture as an input to a shader, create a by calling .

+
+ + ff476637 + ID3D11Texture3D + ID3D11Texture3D +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the properties of the texture resource.

+
+

Pointer to a resource description (see ).

+ + ff476638 + void ID3D11Texture3D::GetDesc([Out] D3D11_TEXTURE3D_DESC* pDesc) + ID3D11Texture3D::GetDesc +
+ + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + + + + Initializes a new instance of the class. + + The device with which to associate the texture. + The description of the texture. + An array of initial texture data for each subresource. + + + + + + +

Get the properties of the texture resource.

+
+ + ff476638 + GetDesc + GetDesc + void ID3D11Texture3D::GetDesc([Out] D3D11_TEXTURE3D_DESC* pDesc) +
+ + +

A view interface specifies the parts of a resource the pipeline can access during rendering.

+
+ +

To create a view for an unordered access resource, call .

All resources must be bound to the pipeline before they can be accessed. Call to bind an unordered access view to a compute shader; call to bind an unordered access view to a pixel shader.

+
+ + ff476639 + ID3D11UnorderedAccessView + ID3D11UnorderedAccessView +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a description of the resource.

+
+

Pointer to a resource description (see .)

+ + ff476640 + void ID3D11UnorderedAccessView::GetDesc([Out] D3D11_UNORDERED_ACCESS_VIEW_DESC* pDesc) + ID3D11UnorderedAccessView::GetDesc +
+ + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the UnorderedAccess flag. + ID3D11Device::CreateUnorderedAccessView + + + + Creates a for accessing resource data. + + The device to use when creating this . + The resource that represents the render-target surface. This surface must have been created with the UnorderedAccess flag. + A structure describing the to be created. + ID3D11Device::CreateUnorderedAccessView + + + +

Get a description of the resource.

+
+ + ff476640 + GetDesc + GetDesc + void ID3D11UnorderedAccessView::GetDesc([Out] D3D11_UNORDERED_ACCESS_VIEW_DESC* pDesc) +
+ + +

A vertex-shader interface manages an executable program (a vertex shader) that controls the vertex-shader stage.

+
+ +

The vertex-shader interface has no methods; use HLSL to implement your shader functionality. All shaders are implemented from a common set of features referred to as the common-shader core..

To create a vertex shader interface, call . Before using a vertex shader you must bind it to the device by calling .

This interface is defined in D3D11.h.

+
+ + ff476641 + ID3D11VertexShader + ID3D11VertexShader +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + Initializes a new instance of the class. + + The device used to create the shader. + The compiled shader bytecode. + A dynamic class linkage interface. + + + +

The interface represents a device context which generates rendering commands.

+
+ + ff476385 + ID3D11DeviceContext + ID3D11DeviceContext +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets the constant buffers used by the vertex shader pipeline stage.

+
+

Index into the device's zero-based array to begin setting constant buffers to (ranges from 0 to - 1).

+

Number of buffers to set (ranges from 0 to - StartSlot).

+

Array of constant buffers (see ) being given to the device.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The Direct3D 11.1 runtime, which is available starting with Windows Developer Preview, can bind a larger number of resources to the shader than the maximum constant buffer size that is supported by shaders (4096 constants ? 4*32-bit components each). When you bind such a large buffer, the shader can access only the first 4096 4*32-bit component constants in the buffer, as if 4096 constants is the full size of the buffer.

If the application wants the shader to access other parts of the buffer, it must call the VSSetConstantBuffers1 method instead.

+
+ + ff476491 + void ID3D11DeviceContext::VSSetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[In, Buffer] const void** ppConstantBuffers) + ID3D11DeviceContext::VSSetConstantBuffers +
+ + +

Set a vertex shader to the device.

+
+

Pointer to a vertex shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476493 + void ID3D11DeviceContext::VSSetShader([In, Optional] ID3D11VertexShader* pVertexShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::VSSetShader +
+ + +

Set a vertex shader to the device.

+
+

Pointer to a vertex shader (see ). Passing in null disables the shader for this pipeline stage.

+

A reference to an array of class-instance interfaces (see ). Each interface used by a shader must have a corresponding class instance or the shader will get disabled. Set ppClassInstances to null if the shader does not use any interfaces.

+

The number of class-instance interfaces in the array.

+ +

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

The maximum number of instances a shader can have is 256.

+
+ + ff476493 + void ID3D11DeviceContext::VSSetShader([In, Optional] ID3D11VertexShader* pVertexShader,[In, Buffer, Optional] const ID3D11ClassInstance** ppClassInstances,[In] unsigned int NumClassInstances) + ID3D11DeviceContext::VSSetShader +
+ + +

Bind an array of shader resources to the vertex-shader stage.

+
+

Index into the device's zero-based array to begin setting shader resources to (range is from 0 to - 1).

+

Number of shader resources to set. Up to a maximum of 128 slots are available for shader resources (range is from 0 to - StartSlot).

+

Array of shader resource view interfaces to set to the device.

+ +

If an overlapping resource view is already bound to an output slot, such as a rendertarget, then this API will fill the destination shader resource slot with null.

For information about creating shader-resource views, see .

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476494 + void ID3D11DeviceContext::VSSetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[In, Buffer] const void** ppShaderResourceViews) + ID3D11DeviceContext::VSSetShaderResources +
+ + +

Set an array of sampler states to the vertex shader pipeline stage.

+
+

Index into the device's zero-based array to begin setting samplers to (ranges from 0 to - 1).

+

Number of samplers in the array. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Pointer to an array of sampler-state interfaces (see ). See Remarks.

+ +

Any sampler may be set to null; this invokes the default state, which is defined to be the following.

 //Default sampler state:	
+             SamplerDesc;	
+            SamplerDesc.Filter = ;	
+            SamplerDesc.AddressU = ;	
+            SamplerDesc.AddressV = ;	
+            SamplerDesc.AddressW = ;	
+            SamplerDesc.MipLODBias = 0;	
+            SamplerDesc.MaxAnisotropy = 1;	
+            SamplerDesc.ComparisonFunc = ;	
+            SamplerDesc.BorderColor[0] = 1.0f;	
+            SamplerDesc.BorderColor[1] = 1.0f;	
+            SamplerDesc.BorderColor[2] = 1.0f;	
+            SamplerDesc.BorderColor[3] = 1.0f;	
+            SamplerDesc.MinLOD = -FLT_MAX;	
+            SamplerDesc.MaxLOD = FLT_MAX; 

The method will hold a reference to the interfaces passed in. This differs from the device state behavior in Direct3D 10.

+
+ + ff476492 + void ID3D11DeviceContext::VSSetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[In, Buffer] const void** ppSamplers) + ID3D11DeviceContext::VSSetSamplers +
+ + +

Get the constant buffers used by the vertex shader pipeline stage.

+
+

Index into the device's zero-based array to begin retrieving constant buffers from (ranges from 0 to - 1).

+

Number of buffers to retrieve (ranges from 0 to - StartSlot).

+

Array of constant buffer interface references (see ) to be returned by the method.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476487 + void ID3D11DeviceContext::VSGetConstantBuffers([In] unsigned int StartSlot,[In] unsigned int NumBuffers,[Out, Buffer] ID3D11Buffer** ppConstantBuffers) + ID3D11DeviceContext::VSGetConstantBuffers +
+ + +

Get the vertex shader currently set on the device.

+
+

Address of a reference to a vertex shader (see ) to be returned by the method.

+

Pointer to an array of class instance interfaces (see ).

+

The number of class-instance elements in the array.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476489 + void ID3D11DeviceContext::VSGetShader([Out] ID3D11VertexShader** ppVertexShader,[Out, Buffer, Optional] ID3D11ClassInstance** ppClassInstances,[InOut] unsigned int* pNumClassInstances) + ID3D11DeviceContext::VSGetShader +
+ + +

Get the vertex shader resources.

+
+

Index into the device's zero-based array to begin getting shader resources from (ranges from 0 to - 1).

+

The number of resources to get from the device. Up to a maximum of 128 slots are available for shader resources (ranges from 0 to - StartSlot).

+

Array of shader resource view interfaces to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476490 + void ID3D11DeviceContext::VSGetShaderResources([In] unsigned int StartSlot,[In] unsigned int NumViews,[Out, Buffer] ID3D11ShaderResourceView** ppShaderResourceViews) + ID3D11DeviceContext::VSGetShaderResources +
+ + +

Get an array of sampler states from the vertex shader pipeline stage.

+
+

Index into a zero-based array to begin getting samplers from (ranges from 0 to - 1).

+

Number of samplers to get from a device context. Each pipeline stage has a total of 16 sampler slots available (ranges from 0 to - StartSlot).

+

Arry of sampler-state interface references (see ) to be returned by the device.

+ +

Any returned interfaces will have their reference count incremented by one. Applications should call IUnknown::Release on the returned interfaces when they are no longer needed to avoid memory leaks.

+
+ + ff476488 + void ID3D11DeviceContext::VSGetSamplers([In] unsigned int StartSlot,[In] unsigned int NumSamplers,[Out, Buffer] ID3D11SamplerState** ppSamplers) + ID3D11DeviceContext::VSGetSamplers +
+ + +

Describes an HLSL class instance.

+
+ +

The structure is returned by the method.

The members of this structure except InstanceIndex are valid (non default values) if they describe a class instance aquired using . The InstanceIndex member is only valid when the class instance is aquired using .

+
+ + ff476098 + D3D11_CLASS_INSTANCE_DESC + D3D11_CLASS_INSTANCE_DESC +
+ + +

The instance ID of an HLSL class; the default value is 0.

+
+ + ff476098 + unsigned int InstanceId + unsigned int InstanceId +
+ + +

The instance index of an HLSL class; the default value is 0.

+
+ + ff476098 + unsigned int InstanceIndex + unsigned int InstanceIndex +
+ + +

The type ID of an HLSL class; the default value is 0.

+
+ + ff476098 + unsigned int TypeId + unsigned int TypeId +
+ + +

Describes the constant buffer associated with an HLSL class; the default value is 0.

+
+ + ff476098 + unsigned int ConstantBuffer + unsigned int ConstantBuffer +
+ + +

The base constant buffer offset associated with an HLSL class; the default value is 0.

+
+ + ff476098 + unsigned int BaseConstantBufferOffset + unsigned int BaseConstantBufferOffset +
+ + +

The base texture associated with an HLSL class; the default value is 127.

+
+ + ff476098 + unsigned int BaseTexture + unsigned int BaseTexture +
+ + +

The base sampler associated with an HLSL class; the default value is 15.

+
+ + ff476098 + unsigned int BaseSampler + unsigned int BaseSampler +
+ + +

True if the class was created; the default value is false.

+
+ + ff476098 + BOOL Created + BOOL Created +
+ + +

Information about the video card's performance counter capabilities.

+
+ +

This structure is returned by .

+
+ + ff476104 + D3D11_COUNTER_INFO + D3D11_COUNTER_INFO +
+ + +

Largest device-dependent counter ID that the device supports. If none are supported, this value will be 0. Otherwise it will be greater than or equal to . See .

+
+ + ff476104 + D3D11_COUNTER LastDeviceDependentCounter + D3D11_COUNTER LastDeviceDependentCounter +
+ + +

Number of counters that can be simultaneously supported.

+
+ + ff476104 + unsigned int NumSimultaneousCounters + unsigned int NumSimultaneousCounters +
+ + +

Number of detectable parallel units that the counter is able to discern. Values are 1 ~ 4. Use NumDetectableParallelUnits to interpret the values of the VERTEX_PROCESSING, GEOMETRY_PROCESSING, PIXEL_PROCESSING, and OTHER_GPU_PROCESSING counters.

+
+ + ff476104 + unsigned char NumDetectableParallelUnits + unsigned char NumDetectableParallelUnits +
+ + +

Describes a counter.

+
+ +

This structure is used by , and .

+
+ + ff476103 + D3D11_COUNTER_DESC + D3D11_COUNTER_DESC +
+ + +

Type of counter (see ).

+
+ + ff476103 + D3D11_COUNTER Counter + D3D11_COUNTER Counter +
+ + +

Reserved.

+
+ + ff476103 + unsigned int MiscFlags + unsigned int MiscFlags +
+ + +

Stencil operations that can be performed based on the results of stencil test.

+
+ +

All stencil operations are specified as a . The stencil operation can be set differently based on the outcome of the stencil test (which is referred to as StencilFunc in the stencil test portion of depth-stencil testing.

This structure is a member of a depth-stencil description.

+
+ + ff476109 + D3D11_DEPTH_STENCILOP_DESC + D3D11_DEPTH_STENCILOP_DESC +
+ + +

The stencil operation to perform when stencil testing fails.

+
+ + ff476109 + D3D11_STENCIL_OP StencilFailOp + D3D11_STENCIL_OP StencilFailOp +
+ + +

The stencil operation to perform when stencil testing passes and depth testing fails.

+
+ + ff476109 + D3D11_STENCIL_OP StencilDepthFailOp + D3D11_STENCIL_OP StencilDepthFailOp +
+ + +

The stencil operation to perform when stencil testing and depth testing both pass.

+
+ + ff476109 + D3D11_STENCIL_OP StencilPassOp + D3D11_STENCIL_OP StencilPassOp +
+ + +

A function that compares stencil data against existing stencil data. The function options are listed in .

+
+ + ff476109 + D3D11_COMPARISON_FUNC StencilFunc + D3D11_COMPARISON_FUNC StencilFunc +
+ + +

Specifies the subresources of a texture that are accessible from a depth-stencil view.

+
+ +

These are valid formats for a depth-stencil view:

A depth-stencil view cannot use a typeless format. If the format chosen is , then the format of the parent resource is used.

A depth-stencil-view description is needed when calling .

+
+ + ff476112 + D3D11_DEPTH_STENCIL_VIEW_DESC + D3D11_DEPTH_STENCIL_VIEW_DESC +
+ + +

Resource data format (see ). See remarks for allowable formats.

+
+ + ff476112 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

Type of resource (see ). Specifies how a depth-stencil resource will be accessed; the value is stored in the union in this structure.

+
+ + ff476112 + D3D11_DSV_DIMENSION ViewDimension + D3D11_DSV_DIMENSION ViewDimension +
+ + +

A value that describes whether the texture is read only. Pass 0 to specify that it is not read only; otherwise, pass one of the members of the enumerated type.

+
+ + ff476112 + D3D11_DSV_FLAG Flags + D3D11_DSV_FLAG Flags +
+ + +

Specifies a 1D texture subresource (see ).

+
+ + ff476112 + D3D11_TEX1D_DSV Texture1D + D3D11_TEX1D_DSV Texture1D +
+ + +

Specifies an array of 1D texture subresources (see ).

+
+ + ff476112 + D3D11_TEX1D_ARRAY_DSV Texture1DArray + D3D11_TEX1D_ARRAY_DSV Texture1DArray +
+ + +

Specifies a 2D texture subresource (see ).

+
+ + ff476112 + D3D11_TEX2D_DSV Texture2D + D3D11_TEX2D_DSV Texture2D +
+ + +

Specifies an array of 2D texture subresources (see ).

+
+ + ff476112 + D3D11_TEX2D_ARRAY_DSV Texture2DArray + D3D11_TEX2D_ARRAY_DSV Texture2DArray +
+ + +

Specifies a multisampled 2D texture (see ).

+
+ + ff476112 + D3D11_TEX2DMS_DSV Texture2DMS + D3D11_TEX2DMS_DSV Texture2DMS +
+ + +

Specifies an array of multisampled 2D textures (see ).

+
+ + ff476112 + D3D11_TEX2DMS_ARRAY_DSV Texture2DMSArray + D3D11_TEX2DMS_ARRAY_DSV Texture2DMSArray +
+ + +

Specifies the subresource from a 2D texture that is accessible to a depth-stencil view.

+
+ +

This structure is one member of a depth-stencil-view description (see ).

+
+ + ff476243 + D3D11_TEX2D_DSV + D3D11_TEX2D_DSV +
+ + +

The index of the first mipmap level to use.

+
+ + ff476243 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

Specifies the subresources from an array of 1D textures to use in a depth-stencil view.

+
+ +

This structure is one member of a depth-stencil-view description (see ).

+
+ + ff476225 + D3D11_TEX1D_ARRAY_DSV + D3D11_TEX1D_ARRAY_DSV +
+ + +

The index of the first mipmap level to use.

+
+ + ff476225 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476225 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures to use.

+
+ + ff476225 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Specifies the subresource from a 1D texture that is accessible to a depth-stencil view.

+
+ +

This structure is one member of a depth-stencil-view description (see ).

+
+ + ff476229 + D3D11_TEX1D_DSV + D3D11_TEX1D_DSV +
+ + +

The index of the first mipmap level to use.

+
+ + ff476229 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

Specifies the subresources from an array 2D textures that are accessible to a depth-stencil view.

+
+ +

This structure is one member of a depth-stencil-view description (see ).

+
+ + ff476239 + D3D11_TEX2D_ARRAY_DSV + D3D11_TEX2D_ARRAY_DSV +
+ + +

The index of the first mipmap level to use.

+
+ + ff476239 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476239 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures to use.

+
+ + ff476239 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Specifies the subresource from a multisampled 2D texture that is accessible to a depth-stencil view.

+
+ +

Because a multisampled 2D texture contains a single subtexture, there is nothing to specify; this unused member is included so that this structure will compile in C.

+
+ + ff476236 + D3D11_TEX2DMS_DSV + D3D11_TEX2DMS_DSV +
+ + +

Unused.

+
+ + ff476236 + unsigned int UnusedField_NothingToDefine + unsigned int UnusedField_NothingToDefine +
+ + +

Specifies the subresources from an array of multisampled 2D textures for a depth-stencil view.

+
+ +

This structure is one member of a depth-stencil-view description (see ).

+
+ + ff476233 + D3D11_TEX2DMS_ARRAY_DSV + D3D11_TEX2DMS_ARRAY_DSV +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476233 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures to use.

+
+ + ff476233 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Buffer requirements for an FFT.

+
+ +

The structure is initialized by a call to one of the functions (see D3DX Functions).

+
+ + ff476308 + D3DX11_FFT_BUFFER_INFO + D3DX11_FFT_BUFFER_INFO +
+ + +

Number of temporary buffers needed. Allowed range is 0 to D3DX11_FFT_MAX_TEMP_BUFFERS.

+
+ + ff476308 + unsigned int NumTempBufferSizes + unsigned int NumTempBufferSizes +
+ + +

Number of precompute buffers required. Allowed range is 0 to D3DX11_FFT_MAX_PRECOMPUTE_BUFFERS.

+
+ + ff476308 + unsigned int NumPrecomputeBufferSizes + unsigned int NumPrecomputeBufferSizes +
+ + +

Minimum sizes (in FLOATs) of temporary buffers.

+
+ + ff476308 + unsigned int TempBufferFloatSizes[4] + unsigned int TempBufferFloatSizes +
+ + +

Minimum sizes (in FLOATs) for precompute buffers.

+
+ + ff476308 + unsigned int PrecomputeBufferFloatSizes[4] + unsigned int PrecomputeBufferFloatSizes +
+ + +

Describes an FFT.

+
+ + ff476311 + D3DX11_FFT_DESC + D3DX11_FFT_DESC +
+ + +

Number of dimension in the FFT.

+
+ + ff476311 + unsigned int NumDimensions + unsigned int NumDimensions +
+ + +

Combination of flags indicating the dimensions to transform.

+
+ + ff476311 + D3DX11_FFT_DIM_MASK DimensionMask + D3DX11_FFT_DIM_MASK DimensionMask +
+ + +

flag indicating the type of data being transformed.

+
+ + ff476311 + D3DX11_FFT_DATA_TYPE Type + D3DX11_FFT_DATA_TYPE Type +
+ + +

Length of each dimension in the FFT.

+
+ + ff476311 + unsigned int ElementLengths[32] + unsigned int ElementLengths +
+ + +

Describes compute shader and raw and structured buffer support in the current graphics driver.

+
+ +

Direct3D 11 devices () are required to support Compute Shader model 5.0. Direct3D 10.x devices (, ) can optionally support Compute Shader model 4.0 or 4.1.

+
+ + ff476126 + D3D11_FEATURE_DATA_D3D10_X_HARDWARE_OPTIONS + D3D11_FEATURE_DATA_D3D10_X_HARDWARE_OPTIONS +
+ + +

TRUE if compute shaders and raw and structured buffers are supported; otherwise .

+
+ + ff476126 + BOOL ComputeShaders_Plus_RawAndStructuredBuffers_Via_Shader_4_x + BOOL ComputeShaders_Plus_RawAndStructuredBuffers_Via_Shader_4_x +
+ + +

Describes double data type support in the current graphics driver.

+
+ +

If the runtime sets DoublePrecisionFloatShaderOps to TRUE, the hardware and driver support the following Shader Model 5 instructions:

  • dadd
  • dmax
  • dmin
  • dmul
  • deq
  • dge
  • dlt
  • dne
  • dmov
  • dmovc
  • dtof
  • ftod

Note??If DoublePrecisionFloatShaderOps is TRUE, the hardware and driver do not necessarily support double-precision division.

+
+ + ff476127 + D3D11_FEATURE_DATA_DOUBLES + D3D11_FEATURE_DATA_DOUBLES +
+ + +

Specifies whether double types are allowed. If TRUE, double types are allowed; otherwise . The runtime must set DoublePrecisionFloatShaderOps to TRUE in order for you to use any HLSL shader that is compiled with a double type.

+
+ + ff476127 + BOOL DoublePrecisionFloatShaderOps + BOOL DoublePrecisionFloatShaderOps +
+ + +

Describes which resources are supported by the current graphics driver for a given format.

+
+ + ff476128 + D3D11_FEATURE_DATA_FORMAT_SUPPORT + D3D11_FEATURE_DATA_FORMAT_SUPPORT +
+ + +

to return information on.

+
+ + ff476128 + DXGI_FORMAT InFormat + DXGI_FORMAT InFormat +
+ + +

Combination of flags indicating which resources are supported.

+
+ + ff476128 + D3D11_FORMAT_SUPPORT OutFormatSupport + D3D11_FORMAT_SUPPORT OutFormatSupport +
+ + +

Describes which unordered resource options are supported by the current graphics driver for a given format.

+
+ + ff476129 + D3D11_FEATURE_DATA_FORMAT_SUPPORT2 + D3D11_FEATURE_DATA_FORMAT_SUPPORT2 +
+ + +

to return information on.

+
+ + ff476129 + DXGI_FORMAT InFormat + DXGI_FORMAT InFormat +
+ + +

Combination of flags indicating which unordered resource options are supported.

+
+ + ff476129 + D3D11_FORMAT_SUPPORT2 OutFormatSupport2 + D3D11_FORMAT_SUPPORT2 OutFormatSupport2 +
+ + +

Describes the multi-threading features that are supported by the current graphics driver.

+
+ +

Use the structure with the method to determine multi-threading support.

+
+ + ff476130 + D3D11_FEATURE_DATA_THREADING + D3D11_FEATURE_DATA_THREADING +
+ + +

TRUE means resources can be created concurrently on multiple threads while drawing; means that the presence of coarse synchronization will prevent concurrency.

+
+ + ff476130 + BOOL DriverConcurrentCreates + BOOL DriverConcurrentCreates +
+ + +

TRUE means command lists are supported by the current driver; means that the API will emulate deferred contexts and command lists with software.

+
+ + ff476130 + BOOL DriverCommandLists + BOOL DriverCommandLists +
+ + +

Optionally provide information to texture loader APIs to control how textures get loaded. A value of D3DX11_DEFAULT for any of these parameters will cause D3DX to automatically pick use the value from the source file.

+
+ +

This structure is used by methods such as: , , or .

+
+ + ff476316 + D3DX11_IMAGE_INFO + D3DX11_IMAGE_INFO +
+ + +

The target width of the texture. If the actual width of the texture is larger or smaller than this value then the texture will be scaled up or down to fit this target width.

+
+ + ff476316 + unsigned int Width + unsigned int Width +
+ + +

The target height of the texture. If the actual height of the texture is larger or smaller than this value then the texture will be scaled up or down to fit this target height.

+
+ + ff476316 + unsigned int Height + unsigned int Height +
+ + +

The depth of the texture. This only applies to volume textures.

+
+ + ff476316 + unsigned int Depth + unsigned int Depth +
+ + +

The number of elements in the array.

+
+ + ff476316 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

The maximum number of mipmap levels in the texture. See the remarks in . Using 0 or D3DX11_DEFAULT will cause a full mipmap chain to be created.

+
+ + ff476316 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Miscellaneous resource properties specified with a flag.

+
+ + ff476316 + D3D11_RESOURCE_MISC_FLAG MiscFlags + D3D11_RESOURCE_MISC_FLAG MiscFlags +
+ + +

A enumeration specifying the format the texture will be in after it is loaded.

+
+ + ff476316 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

A value, which identifies the type of resource.

+
+ + ff476316 + D3D11_RESOURCE_DIMENSION ResourceDimension + D3D11_RESOURCE_DIMENSION ResourceDimension +
+ + +

A value, which identifies the image format.

+
+ + ff476316 + D3DX11_IMAGE_FILE_FORMAT ImageFileFormat + D3DX11_IMAGE_FILE_FORMAT ImageFileFormat +
+ + + Retrieves information about a given image file. + + File name of image to retrieve information about. + If the function succeeds, returns a filled with the description of the data in the source file. else returns null + HRESULT D3DX11GetImageInfoFromFileW([None] const wchar_t* pSrcFile,[None] ID3DX11ThreadPump* pPump,[None] D3DX11_IMAGE_INFO* pSrcInfo,[None] HRESULT* pHResult) + + + + Retrieves information about a given image file from a memory location. + + an array to the image in memory + If the function succeeds, returns a filled with the description of the data from the image memory. else returns null + HRESULT D3DX11GetImageInfoFromFileW([None] const wchar_t* pSrcFile,[None] ID3DX11ThreadPump* pPump,[None] D3DX11_IMAGE_INFO* pSrcInfo,[None] HRESULT* pHResult) + + + +

Optionally provide information to texture loader APIs to control how textures get loaded. A value of D3DX11_DEFAULT for any of these parameters will cause D3DX to automatically pick use the value from the source file.

+
+ +

When initializing the structure, you may set any member to D3DX11_DEFAULT and D3DX will initialize it with a default value from the source texture when the texture is loaded.

This structure can be used by APIs that:

  • Create resources, such as and .
  • Create data processors, such as D3DX11CreateAsyncTextureInfoProcessor or + D3DX11CreateAsyncShaderResourceViewProcessor.

The default values are:

 Width = D3DX11_DEFAULT; Height = D3DX11_DEFAULT; Depth = D3DX11_DEFAULT; FirstMipLevel = D3DX11_DEFAULT; MipLevels = D3DX11_DEFAULT; Usage = () D3DX11_DEFAULT; BindFlags = D3DX11_DEFAULT; CpuAccessFlags = D3DX11_DEFAULT; MiscFlags = D3DX11_DEFAULT; Format = DXGI_FORMAT_FROM_FILE; Filter = D3DX11_DEFAULT; MipFilter = D3DX11_DEFAULT; pSrcInfo = null;	
+            

Here is a brief example that uses this structure to supply the pixel format when loading a texture. For the complete code, see HDRFormats10.cpp in HDRToneMappingCS11 Sample.

 * pCubeRV = null;	
+            WCHAR strPath[MAX_PATH];	
+             LoadInfo; DXUTFindDXSDKMediaFileCch( strPath, MAX_PATH,  L"Light Probes\\uffizi_cross.dds" ); LoadInfo.Format = ; hr = ( pd3dDevice, strPath,  &LoadInfo, null, &pCubeRV, null );	
+            
+
+ + ff476317 + D3DX11_IMAGE_LOAD_INFO + D3DX11_IMAGE_LOAD_INFO +
+ + + The default value for load options. + + + + +

The target width of the texture. If the actual width of the texture is larger or smaller than this value then the texture will be scaled up or down to fit this target width.

+
+ + ff476317 + unsigned int Width + unsigned int Width +
+ + +

The target height of the texture. If the actual height of the texture is larger or smaller than this value then the texture will be scaled up or down to fit this target height.

+
+ + ff476317 + unsigned int Height + unsigned int Height +
+ + +

The depth of the texture. This only applies to volume textures.

+
+ + ff476317 + unsigned int Depth + unsigned int Depth +
+ + +

The highest resolution mipmap level of the texture. If this is greater than 0, then after the texture is loaded FirstMipLevel will be mapped to mipmap level 0.

+
+ + ff476317 + unsigned int FirstMipLevel + unsigned int FirstMipLevel +
+ + +

The maximum number of mipmap levels in the texture. See the remarks in . Using 0 or D3DX11_DEFAULT will cause a full mipmap chain to be created.

+
+ + ff476317 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

The way the texture resource is intended to be used. See .

+
+ + ff476317 + D3D11_USAGE Usage + D3D11_USAGE Usage +
+ + +

The pipeline stages that the texture will be allowed to bind to. See .

+
+ + ff476317 + D3D11_BIND_FLAG BindFlags + D3D11_BIND_FLAG BindFlags +
+ + +

The access permissions the cpu will have for the texture resource. See .

+
+ + ff476317 + D3D11_CPU_ACCESS_FLAG CpuAccessFlags + D3D11_CPU_ACCESS_FLAG CpuAccessFlags +
+ + +

Miscellaneous resource properties (see ).

+
+ + ff476317 + D3D11_RESOURCE_MISC_FLAG MiscFlags + D3D11_RESOURCE_MISC_FLAG MiscFlags +
+ + +

A enumeration indicating the format the texture will be in after it is loaded.

+
+ + ff476317 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

Filter the texture using the specified filter (only when resampling). See .

+
+ + ff476317 + D3DX11_FILTER_FLAG Filter + D3DX11_FILTER_FLAG Filter +
+ + +

Filter the texture mip levels using the specified filter (only if generating mipmaps). Valid values are , , , or . See .

+
+ + ff476317 + D3DX11_FILTER_FLAG MipFilter + D3DX11_FILTER_FLAG MipFilter +
+ + +

Information about the original image. See . Can be obtained with , , or .

+
+ + ff476317 + D3DX11_IMAGE_INFO* pSrcInfo + D3DX11_IMAGE_INFO pSrcInfo +
+ + + Gets an ImageLoadInformation that is setup with all default values (). + + + + +

Debug message filter; contains a lists of message types to allow or deny.

+
+ +

For use with an Interface.

+
+ + ff476177 + D3D11_INFO_QUEUE_FILTER + D3D11_INFO_QUEUE_FILTER +
+ + +

Types of messages that you want to allow. See .

+
+ + ff476177 + D3D11_INFO_QUEUE_FILTER_DESC AllowList + D3D11_INFO_QUEUE_FILTER_DESC AllowList +
+ + +

Types of messages that you want to deny.

+
+ + ff476177 + D3D11_INFO_QUEUE_FILTER_DESC DenyList + D3D11_INFO_QUEUE_FILTER_DESC DenyList +
+ + +

Allow or deny certain types of messages to pass through a filter.

+
+ + ff476178 + D3D11_INFO_QUEUE_FILTER_DESC + D3D11_INFO_QUEUE_FILTER_DESC +
+ + +

Number of message categories to allow or deny.

+
+ + ff476178 + unsigned int NumCategories + unsigned int NumCategories +
+ + +

Array of message categories to allow or deny. Array must have at least NumCategories members (see ).

+
+ + ff476178 + D3D11_MESSAGE_CATEGORY* pCategoryList + D3D11_MESSAGE_CATEGORY pCategoryList +
+ + +

Number of message severity levels to allow or deny.

+
+ + ff476178 + unsigned int NumSeverities + unsigned int NumSeverities +
+ + +

Array of message severity levels to allow or deny. Array must have at least NumSeverities members (see ).

+
+ + ff476178 + D3D11_MESSAGE_SEVERITY* pSeverityList + D3D11_MESSAGE_SEVERITY pSeverityList +
+ + +

Number of message IDs to allow or deny.

+
+ + ff476178 + unsigned int NumIDs + unsigned int NumIDs +
+ + +

Array of message IDs to allow or deny. Array must have at least NumIDs members (see ).

+
+ + ff476178 + D3D11_MESSAGE_ID* pIDList + D3D11_MESSAGE_ID pIDList +
+ + + Gets or sets the categories. + + + The categories. + + + + + Gets or sets the severities. + + + The severities. + + + + + Gets or sets the ids. + + + The ids. + + + + +

A description of a single element for the input-assembler stage.

+
+ +

An input-layout object contains an array of structures, each structure defines one element being read from an input slot. Create an input-layout object by calling . For an example, see the "Create the Input-Layout Object" subtopic under the Getting Started with the Input-Assembler Stage topic.

+
+ + ff476180 + D3D11_INPUT_ELEMENT_DESC + D3D11_INPUT_ELEMENT_DESC +
+ + +

The HLSL semantic associated with this element in a shader input-signature.

+
+ + ff476180 + const char* SemanticName + char SemanticName +
+ + +

The semantic index for the element. A semantic index modifies a semantic, with an integer index number. A semantic index is only needed in a case where there is more than one element with the same semantic. For example, a 4x4 matrix would have four components each with the semantic name

matrix

, however each of the four component would have different semantic indices (0, 1, 2, and 3).

+
+ + ff476180 + unsigned int SemanticIndex + unsigned int SemanticIndex +
+ + +

The data type of the element data. See .

+
+ + ff476180 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

An integer value that identifies the input-assembler (see input slot). Valid values are between 0 and 15, defined in D3D11.h.

+
+ + ff476180 + unsigned int InputSlot + unsigned int InputSlot +
+ + +

Optional. Offset (in bytes) between each element. Use D3D11_APPEND_ALIGNED_ELEMENT for convenience to define the current element directly after the previous one, including any packing if necessary.

+
+ + ff476180 + unsigned int AlignedByteOffset + unsigned int AlignedByteOffset +
+ + +

Identifies the input data class for a single input slot (see ).

+
+ + ff476180 + D3D11_INPUT_CLASSIFICATION InputSlotClass + D3D11_INPUT_CLASSIFICATION InputSlotClass +
+ + +

The number of instances to draw using the same per-instance data before advancing in the buffer by one element. This value must be 0 for an element that contains per-vertex data (the slot class is set to ).

+
+ + ff476180 + unsigned int InstanceDataStepRate + unsigned int InstanceDataStepRate +
+ + + Initializes a new instance of the struct. + + The HLSL semantic associated with this element in a shader input-signature. + The semantic index for the element. A semantic index modifies a semantic, with an integer index number. A semantic index is only needed in a case where there is more than one element with the same semantic. For example, a 4x4 matrix would have four components each with the semantic name matrix, however each of the four component would have different semantic indices (0, 1, 2, and 3). + The data type of the element data. + Offset (in bytes) between each element. Use AppendAligned for convenience to define the current element directly after the previous one, including any packing if necessary. + An integer value that identifies the input-assembler. Valid values are between 0 and 15. + Identifies the input data class for a single input slot. + The number of instances to draw using the same per-instance data before advancing in the buffer by one element. This value must be 0 for an element that contains per-vertex data. + + + + Initializes a new instance of the struct. + + The HLSL semantic associated with this element in a shader input-signature. + The semantic index for the element. A semantic index modifies a semantic, with an integer index number. A semantic index is only needed in a case where there is more than one element with the same semantic. For example, a 4x4 matrix would have four components each with the semantic name matrix, however each of the four component would have different semantic indices (0, 1, 2, and 3). + The data type of the element data. + Offset (in bytes) between each element. Use AppendAligned for convenience to define the current element directly after the previous one, including any packing if necessary. + An integer value that identifies the input-assembler. Valid values are between 0 and 15. + + + + Initializes a new instance of the struct. + + The HLSL semantic associated with this element in a shader input-signature. + The semantic index for the element. A semantic index modifies a semantic, with an integer index number. A semantic index is only needed in a case where there is more than one element with the same semantic. For example, a 4x4 matrix would have four components each with the semantic name matrix, however each of the four component would have different semantic indices (0, 1, 2, and 3). + The data type of the element data. + An integer value that identifies the input-assembler. Valid values are between 0 and 15. + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + Returns a value that can be used for the offset parameter of an InputElement to indicate that the element + should be aligned directly after the previous element, including any packing if neccessary. + + A value used to align input elements. + D3D11_APPEND_ALIGNED_ELEMENT + + + +

A debug message in the Information Queue.

+
+ +

This structure is returned from as part of the Information Queue feature (see Interface).

+
+ + ff476184 + D3D11_MESSAGE + D3D11_MESSAGE +
+ + +

The category of the message. See .

+
+ + ff476184 + D3D11_MESSAGE_CATEGORY Category + D3D11_MESSAGE_CATEGORY Category +
+ + +

The severity of the message. See .

+
+ + ff476184 + D3D11_MESSAGE_SEVERITY Severity + D3D11_MESSAGE_SEVERITY Severity +
+ + +

The ID of the message. See .

+
+ + ff476184 + D3D11_MESSAGE_ID ID + D3D11_MESSAGE_ID ID +
+ + +

The message string.

+
+ + ff476184 + const char* pDescription + char pDescription +
+ + +

The length of pDescription in bytes.

+
+ + ff476184 + SIZE_T DescriptionByteLength + SIZE_T DescriptionByteLength +
+ + +

Query information about graphics-pipeline activity in between calls to and .

+
+ + ff476192 + D3D11_QUERY_DATA_PIPELINE_STATISTICS + D3D11_QUERY_DATA_PIPELINE_STATISTICS +
+ + + No documentation. + + + unsigned longlong IAVertices + unsigned longlong IAVertices + + + + No documentation. + + + unsigned longlong IAPrimitives + unsigned longlong IAPrimitives + + + + No documentation. + + + unsigned longlong VSInvocations + unsigned longlong VSInvocations + + + + No documentation. + + + unsigned longlong GSInvocations + unsigned longlong GSInvocations + + + + No documentation. + + + unsigned longlong GSPrimitives + unsigned longlong GSPrimitives + + + + No documentation. + + + unsigned longlong CInvocations + unsigned longlong CInvocations + + + + No documentation. + + + unsigned longlong CPrimitives + unsigned longlong CPrimitives + + + + No documentation. + + + unsigned longlong PSInvocations + unsigned longlong PSInvocations + + + + No documentation. + + + unsigned longlong HSInvocations + unsigned longlong HSInvocations + + + + No documentation. + + + unsigned longlong DSInvocations + unsigned longlong DSInvocations + + + + No documentation. + + + unsigned longlong CSInvocations + unsigned longlong CSInvocations + + + +

Query information about the reliability of a timestamp query.

+
+ +

For a list of query types see .

+
+ + ff476194 + D3D11_QUERY_DATA_TIMESTAMP_DISJOINT + D3D11_QUERY_DATA_TIMESTAMP_DISJOINT +
+ + +

How frequently the GPU counter increments in Hz.

+
+ + ff476194 + unsigned longlong Frequency + unsigned longlong Frequency +
+ + +

If this is TRUE, something occurred in between the query's and calls that caused the timestamp counter to become discontinuous or disjoint, such as unplugging the AC chord on a laptop, overheating, or throttling up/down due to laptop savings events. The timestamp returned by for a timestamp query is only reliable if Disjoint is .

+
+ + ff476194 + BOOL Disjoint + BOOL Disjoint +
+ + +

Describes a query.

+
+ + ff476195 + D3D11_QUERY_DESC + D3D11_QUERY_DESC +
+ + +

Type of query (see ).

+
+ + ff476195 + D3D11_QUERY Query + D3D11_QUERY Query +
+ + +

Miscellaneous flags (see ).

+
+ + ff476195 + D3D11_QUERY_MISC_FLAG MiscFlags + D3D11_QUERY_MISC_FLAG MiscFlags +
+ + +

Describes the blend state for a render target.

+
+ +

For info about how blending is done, see the output-merger stage.

Here are the default values for blend state.

StateDefault Value
BlendEnable
SrcBlend
DestBlend
BlendOp
SrcBlendAlpha
DestBlendAlpha
BlendOpAlpha
RenderTargetWriteMask

?

+
+ + ff476200 + D3D11_RENDER_TARGET_BLEND_DESC + D3D11_RENDER_TARGET_BLEND_DESC +
+ + +

Enable (or disable) blending.

+
+ + ff476200 + BOOL BlendEnable + BOOL BlendEnable +
+ + +

This blend option specifies the operation to perform on the RGB value that the pixel shader outputs. The BlendOp member defines how to combine the SrcBlend and DestBlend operations.

+
+ + ff476200 + D3D11_BLEND SrcBlend + D3D11_BLEND SrcBlend +
+ + +

This blend option specifies the operation to perform on the current RGB value in the render target. The BlendOp member defines how to combine the SrcBlend and DestBlend operations.

+
+ + ff476200 + D3D11_BLEND DestBlend + D3D11_BLEND DestBlend +
+ + +

This blend operation defines how to combine the SrcBlend and DestBlend operations.

+
+ + ff476200 + D3D11_BLEND_OP BlendOp + D3D11_BLEND_OP BlendOp +
+ + +

This blend option specifies the operation to perform on the alpha value that the pixel shader outputs. Blend options that end in _COLOR are not allowed. The BlendOpAlpha member defines how to combine the SrcBlendAlpha and DestBlendAlpha operations.

+
+ + ff476200 + D3D11_BLEND SrcBlendAlpha + D3D11_BLEND SrcBlendAlpha +
+ + +

This blend option specifies the operation to perform on the current alpha value in the render target. Blend options that end in _COLOR are not allowed. The BlendOpAlpha member defines how to combine the SrcBlendAlpha and DestBlendAlpha operations.

+
+ + ff476200 + D3D11_BLEND DestBlendAlpha + D3D11_BLEND DestBlendAlpha +
+ + +

This blend operation defines how to combine the SrcBlendAlpha and DestBlendAlpha operations.

+
+ + ff476200 + D3D11_BLEND_OP BlendOpAlpha + D3D11_BLEND_OP BlendOpAlpha +
+ + +

A write mask.

+
+ + ff476200 + D3D11_COLOR_WRITE_ENABLE RenderTargetWriteMask + D3D11_COLOR_WRITE_ENABLE RenderTargetWriteMask +
+ + + Initializes a new instance of the struct. + + The is blend enabled. + The source blend. + The destination blend. + The blend operation. + The source alpha blend. + The destination alpha blend. + The alpha blend operation. + The render target write mask. + + + +

Specifies the subresources from a resource that are accessible using a render-target view.

+
+ +

A render-target-view description is passed into to create a render target.

A render-target-view cannot use the following formats:

  • Any typeless format.
  • DXGI_FORMAT_R32G32B32 if the view will be used to bind a buffer (vertex, index, constant, or stream-output).

If the format is set to , then the format of the resource that the view binds to the pipeline will be used.

+
+ + ff476201 + D3D11_RENDER_TARGET_VIEW_DESC + D3D11_RENDER_TARGET_VIEW_DESC +
+ + +

The data format (see ).

+
+ + ff476201 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

The resource type (see ), which specifies how the render-target resource will be accessed.

+
+ + ff476201 + D3D11_RTV_DIMENSION ViewDimension + D3D11_RTV_DIMENSION ViewDimension +
+ + +

Specifies which buffer elements can be accessed (see ).

+
+ + ff476201 + D3D11_BUFFER_RTV Buffer + D3D11_BUFFER_RTV Buffer +
+ + +

Specifies the subresources in a 1D texture that can be accessed (see ).

+
+ + ff476201 + D3D11_TEX1D_RTV Texture1D + D3D11_TEX1D_RTV Texture1D +
+ + +

Specifies the subresources in a 1D texture array that can be accessed (see ).

+
+ + ff476201 + D3D11_TEX1D_ARRAY_RTV Texture1DArray + D3D11_TEX1D_ARRAY_RTV Texture1DArray +
+ + +

Specifies the subresources in a 2D texture that can be accessed (see ).

+
+ + ff476201 + D3D11_TEX2D_RTV Texture2D + D3D11_TEX2D_RTV Texture2D +
+ + +

Specifies the subresources in a 2D texture array that can be accessed (see ).

+
+ + ff476201 + D3D11_TEX2D_ARRAY_RTV Texture2DArray + D3D11_TEX2D_ARRAY_RTV Texture2DArray +
+ + +

Specifies a single subresource because a multisampled 2D texture only contains one subresource (see ).

+
+ + ff476201 + D3D11_TEX2DMS_RTV Texture2DMS + D3D11_TEX2DMS_RTV Texture2DMS +
+ + +

Specifies the subresources in a multisampled 2D texture array that can be accessed (see ).

+
+ + ff476201 + D3D11_TEX2DMS_ARRAY_RTV Texture2DMSArray + D3D11_TEX2DMS_ARRAY_RTV Texture2DMSArray +
+ + +

Specifies subresources in a 3D texture that can be accessed (see ).

+
+ + ff476201 + D3D11_TEX3D_RTV Texture3D + D3D11_TEX3D_RTV Texture3D +
+ + +

Specifies the subresources from a an array of multisampled 2D textures to use in a render-target view.

+
+ +

This structure is one member of a render-target-view description (see ).

+
+ + ff476234 + D3D11_TEX2DMS_ARRAY_RTV + D3D11_TEX2DMS_ARRAY_RTV +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476234 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures to use.

+
+ + ff476234 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Specifies the subresource from a 1D texture to use in a render-target view.

+
+ +

This structure is one member of a render-target-view description (see ).

+
+ + ff476230 + D3D11_TEX1D_RTV + D3D11_TEX1D_RTV +
+ + +

The index of the mipmap level to use mip slice.

+
+ + ff476230 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

Specifies the subresource from a multisampled 2D texture to use in a render-target view.

+
+ +

Since a multisampled 2D texture contains a single subresource, there is actually nothing to specify in . Consequently, UnusedField_NothingToDefine is included so that this structure will compile in C.

+
+ + ff476237 + D3D11_TEX2DMS_RTV + D3D11_TEX2DMS_RTV +
+ + +

Integer of any value. See remarks.

+
+ + ff476237 + unsigned int UnusedField_NothingToDefine + unsigned int UnusedField_NothingToDefine +
+ + +

Specifies the subresource from a 2D texture to use in a render-target view.

+
+ +

This structure is one member of a render-target-view description (see ).

+
+ + ff476244 + D3D11_TEX2D_RTV + D3D11_TEX2D_RTV +
+ + +

The index of the mipmap level to use mip slice.

+
+ + ff476244 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

Specifies the subresources from an array of 1D textures to use in a render-target view.

+
+ +

This structure is one member of a render-target-view description (see ).

+
+ + ff476226 + D3D11_TEX1D_ARRAY_RTV + D3D11_TEX1D_ARRAY_RTV +
+ + +

The index of the mipmap level to use mip slice.

+
+ + ff476226 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476226 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures to use.

+
+ + ff476226 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Specifies the subresources from a 3D texture to use in a render-target view.

+
+ +

This structure is one member of a render target view. See .

+
+ + ff476247 + D3D11_TEX3D_RTV + D3D11_TEX3D_RTV +
+ + +

The index of the mipmap level to use mip slice.

+
+ + ff476247 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

First depth level to use.

+
+ + ff476247 + unsigned int FirstWSlice + unsigned int FirstWSlice +
+ + +

Number of depth levels to use in the render-target view, starting from FirstWSlice. A value of -1 indicates all of the slices along the w axis, starting from FirstWSlice.

+
+ + ff476247 + unsigned int WSize + unsigned int WSize +
+ + +

Specifies the subresources from an array of 2D textures to use in a render-target view.

+
+ +

This structure is one member of a render-target-view description (see ).

+
+ + ff476240 + D3D11_TEX2D_ARRAY_RTV + D3D11_TEX2D_ARRAY_RTV +
+ + +

The index of the mipmap level to use mip slice.

+
+ + ff476240 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476240 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures in the array to use in the render target view, starting from FirstArraySlice.

+
+ + ff476240 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Specifies the elements in a buffer resource to use in a render-target view.

+
+ +

A render-target view is a member of a render-target-view description (see ). Create a render-target view by calling .

+
+ + ff476093 + D3D11_BUFFER_RTV + D3D11_BUFFER_RTV +
+ + +

Number of bytes between the beginning of the buffer and the first element to access.

+
+ + ff476093 + unsigned int FirstElement + unsigned int FirstElement +
+ + +

The offset of the first element in the view to access, relative to element 0.

+
+ + ff476093 + unsigned int ElementOffset + unsigned int ElementOffset +
+ + +

The total number of elements in the view.

+
+ + ff476093 + unsigned int NumElements + unsigned int NumElements +
+ + +

The width of each element (in bytes). This can be determined from the format stored in the render-target-view description.

+
+ + ff476093 + unsigned int ElementWidth + unsigned int ElementWidth +
+ + +

Defines a 3D box.

+
+ +

The following diagram shows a 3D box, where the origin is the left, front, top corner.

The values for right, bottom, and back are each one pixel past the end of the pixels that are included in the box region. That is, the values for left, top, and front are included in the box region while the values for right, bottom, and back are excluded from the box region. For example, for a box that is one pixel wide, (right - left) == 1; the box region includes the left pixel but not the right pixel.

+
+ + ff476089 + D3D11_BOX + D3D11_BOX +
+ + +

The x position of the left hand side of the box.

+
+ + ff476089 + unsigned int left + unsigned int left +
+ + +

The y position of the top of the box.

+
+ + ff476089 + unsigned int top + unsigned int top +
+ + +

The z position of the front of the box.

+
+ + ff476089 + unsigned int front + unsigned int front +
+ + +

The x position of the right hand side of the box.

+
+ + ff476089 + unsigned int right + unsigned int right +
+ + +

The y position of the bottom of the box.

+
+ + ff476089 + unsigned int bottom + unsigned int bottom +
+ + +

The z position of the back of the box.

+
+ + ff476089 + unsigned int back + unsigned int back +
+ + + Initiailize a new instance of struct. + + Left coordinates (inclusive) + Top coordinates (inclusive) + Front coordinates (inclusive) + Right coordinates (exclusive) + Botoom coordinates (exclusive) + Back coordinates (exclusive) + +
    +
  • For a Width of 1 pixels, (right - left) = 1. If left = 0, right = Width.
  • +
  • For a Height of 1 pixels, (bottom - top) = 1. If top = 0, bottom = Height.
  • +
  • For a Depth of 1 pixels, (back - front) = 1. If front = 0, back = Depth.
  • +
+
+
+ + +

Describes a sampler state.

+
+ +

These are the default values for sampler state.

StateDefault Value
FilterMIN_MAG_MIP_LINEAR
AddressUClamp
AddressVClamp
AddressWClamp
MinLOD-3.402823466e+38F (-FLT_MAX)
MaxLOD3.402823466e+38F (FLT_MAX)
MipMapLODBias0.0f
MaxAnisotropy16
ComparisonFuncNever
BorderColorfloat4(0.0f,0.0f,0.0f,0.0f)
TextureN/A

?

+
+ + ff476207 + D3D11_SAMPLER_DESC + D3D11_SAMPLER_DESC +
+ + +

Filtering method to use when sampling a texture (see ).

+
+ + ff476207 + D3D11_FILTER Filter + D3D11_FILTER Filter +
+ + +

Method to use for resolving a u texture coordinate that is outside the 0 to 1 range (see ).

+
+ + ff476207 + D3D11_TEXTURE_ADDRESS_MODE AddressU + D3D11_TEXTURE_ADDRESS_MODE AddressU +
+ + +

Method to use for resolving a v texture coordinate that is outside the 0 to 1 range.

+
+ + ff476207 + D3D11_TEXTURE_ADDRESS_MODE AddressV + D3D11_TEXTURE_ADDRESS_MODE AddressV +
+ + +

Method to use for resolving a w texture coordinate that is outside the 0 to 1 range.

+
+ + ff476207 + D3D11_TEXTURE_ADDRESS_MODE AddressW + D3D11_TEXTURE_ADDRESS_MODE AddressW +
+ + +

Offset from the calculated mipmap level. For example, if Direct3D calculates that a texture should be sampled at mipmap level 3 and MipLODBias is 2, then the texture will be sampled at mipmap level 5.

+
+ + ff476207 + float MipLODBias + float MipLODBias +
+ + +

Clamping value used if or is specified in Filter. Valid values are between 1 and 16.

+
+ + ff476207 + unsigned int MaxAnisotropy + unsigned int MaxAnisotropy +
+ + +

A function that compares sampled data against existing sampled data. The function options are listed in .

+
+ + ff476207 + D3D11_COMPARISON_FUNC ComparisonFunc + D3D11_COMPARISON_FUNC ComparisonFunc +
+ + +

Border color to use if is specified for AddressU, AddressV, or AddressW. Range must be between 0.0 and 1.0 inclusive.

+
+ + ff476207 + SHARPDX_COLOR4 BorderColor + SHARPDX_COLOR4 BorderColor +
+ + +

Lower end of the mipmap range to clamp access to, where 0 is the largest and most detailed mipmap level and any level higher than that is less detailed.

+
+ + ff476207 + float MinLOD + float MinLOD +
+ + +

Upper end of the mipmap range to clamp access to, where 0 is the largest and most detailed mipmap level and any level higher than that is less detailed. This value must be greater than or equal to MinLOD. To have no upper limit on LOD set this to a large value such as D3D11_FLOAT32_MAX.

+
+ + ff476207 + float MaxLOD + float MaxLOD +
+ + + Returns default values for . + + + See MSDN documentation for default values. + + + + +

Describes a shader-resource view.

+
+ +

A view is a format-specific way to look at the data in a resource. The view determines what data to look at, and how it is cast when read.

When viewing a resource, the resource-view description must specify a typed format, that is compatible with the resource format. So that means that you cannot create a resource-view description using any format with _TYPELESS in the name. You can however view a typeless resource by specifying a typed format for the view. For example, a resource can be viewed with one of these typed formats: , , and , since these typed formats are compatible with the typeless resource.

Create a shader-resource-view description by calling . To view a shader-resource-view description, call .

+
+ + ff476211 + D3D11_SHADER_RESOURCE_VIEW_DESC + D3D11_SHADER_RESOURCE_VIEW_DESC +
+ + +

A specifying the viewing format. See remarks.

+
+ + ff476211 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

The resource type of the view. See D3D11_SRV_DIMENSION. This should be the same as the resource type of the underlying resource. This parameter also determines which _SRV to use in the union below.

+
+ + ff476211 + D3D_SRV_DIMENSION ViewDimension + D3D_SRV_DIMENSION ViewDimension +
+ + +

View the resource as a buffer using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_BUFFER_SRV Buffer + D3D11_BUFFER_SRV Buffer +
+ + +

View the resource as a 1D texture using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEX1D_SRV Texture1D + D3D11_TEX1D_SRV Texture1D +
+ + +

View the resource as a 1D-texture array using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEX1D_ARRAY_SRV Texture1DArray + D3D11_TEX1D_ARRAY_SRV Texture1DArray +
+ + +

View the resource as a 2D-texture using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEX2D_SRV Texture2D + D3D11_TEX2D_SRV Texture2D +
+ + +

View the resource as a 2D-texture array using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEX2D_ARRAY_SRV Texture2DArray + D3D11_TEX2D_ARRAY_SRV Texture2DArray +
+ + +

View the resource as a 2D-multisampled texture using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEX2DMS_SRV Texture2DMS + D3D11_TEX2DMS_SRV Texture2DMS +
+ + +

View the resource as a 2D-multisampled-texture array using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEX2DMS_ARRAY_SRV Texture2DMSArray + D3D11_TEX2DMS_ARRAY_SRV Texture2DMSArray +
+ + +

View the resource as a 3D texture using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEX3D_SRV Texture3D + D3D11_TEX3D_SRV Texture3D +
+ + +

View the resource as a 3D-cube texture using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEXCUBE_SRV TextureCube + D3D11_TEXCUBE_SRV TextureCube +
+ + +

View the resource as a 3D-cube-texture array using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_TEXCUBE_ARRAY_SRV TextureCubeArray + D3D11_TEXCUBE_ARRAY_SRV TextureCubeArray +
+ + +

View the resource as an extended buffer using information from a shader-resource view (see ).

+
+ + ff476211 + D3D11_BUFFEREX_SRV BufferEx + D3D11_BUFFEREX_SRV BufferEx +
+ + +

Specifies the elements in a buffer resource to use in a shader-resource view.

+
+ +

The structure is a member of the structure, which represents a shader-resource view description. You can create a shader-resource view by calling the method.

+
+ + ff476094 + D3D11_BUFFER_SRV + D3D11_BUFFER_SRV +
+ + +

Number of bytes between the beginning of the buffer and the first element to access.

+
+ + ff476094 + unsigned int FirstElement + unsigned int FirstElement +
+ + +

The offset of the first element in the view to access, relative to element 0.

+
+ + ff476094 + unsigned int ElementOffset + unsigned int ElementOffset +
+ + +

The total number of elements in the view.

+
+ + ff476094 + unsigned int NumElements + unsigned int NumElements +
+ + +

The width of each element (in bytes). This can be determined from the format stored in the shader-resource-view description.

+
+ + ff476094 + unsigned int ElementWidth + unsigned int ElementWidth +
+ + +

Specifies the subresource from a cube texture to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

+
+ + ff476251 + D3D11_TEXCUBE_SRV + D3D11_TEXCUBE_SRV +
+ + +

Index of the most detailed mipmap level to use; this number is between 0 and MipLevels (from the original TextureCube for which creates a view) -1.

+
+ + ff476251 + unsigned int MostDetailedMip + unsigned int MostDetailedMip +
+ + +

The maximum number of mipmap levels for the view of the texture. See the remarks in .

Set to -1 to indicate all the mipmap levels from MostDetailedMip on down to least detailed.

+
+ + ff476251 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Specifies the subresources from a multisampled 2D texture to use in a shader-resource view.

+
+ +

Since a multisampled 2D texture contains a single subresource, there is actually nothing to specify in . Consequently, UnusedField_NothingToDefine is included so that this structure will compile in C.

+
+ + ff476238 + D3D11_TEX2DMS_SRV + D3D11_TEX2DMS_SRV +
+ + +

Integer of any value. See remarks.

+
+ + ff476238 + unsigned int UnusedField_NothingToDefine + unsigned int UnusedField_NothingToDefine +
+ + +

Specifies the subresources from an array of cube textures to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

+
+ + ff476250 + D3D11_TEXCUBE_ARRAY_SRV + D3D11_TEXCUBE_ARRAY_SRV +
+ + +

Index of the most detailed mipmap level to use; this number is between 0 and MipLevels (from the original TextureCube for which creates a view) -1.

+
+ + ff476250 + unsigned int MostDetailedMip + unsigned int MostDetailedMip +
+ + +

The maximum number of mipmap levels for the view of the texture. See the remarks in .

Set to -1 to indicate all the mipmap levels from MostDetailedMip on down to least detailed.

+
+ + ff476250 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Index of the first 2D texture to use.

+
+ + ff476250 + unsigned int First2DArrayFace + unsigned int First2DArrayFace +
+ + +

Number of cube textures in the array.

+
+ + ff476250 + unsigned int NumCubes + unsigned int NumCubes +
+ + +

Specifies the subresources from a 3D texture to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

+
+ + ff476248 + D3D11_TEX3D_SRV + D3D11_TEX3D_SRV +
+ + +

Index of the most detailed mipmap level to use; this number is between 0 and MipLevels (from the original Texture3D for which creates a view) -1.

+
+ + ff476248 + unsigned int MostDetailedMip + unsigned int MostDetailedMip +
+ + +

The maximum number of mipmap levels for the view of the texture. See the remarks in .

Set to -1 to indicate all the mipmap levels from MostDetailedMip on down to least detailed.

+
+ + ff476248 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Specifies the subresource from a 2D texture to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

+
+ + ff476245 + D3D11_TEX2D_SRV + D3D11_TEX2D_SRV +
+ + +

Index of the most detailed mipmap level to use; this number is between 0 and MipLevels (from the original Texture2D for which creates a view) -1.

+
+ + ff476245 + unsigned int MostDetailedMip + unsigned int MostDetailedMip +
+ + +

The maximum number of mipmap levels for the view of the texture. See the remarks in .

Set to -1 to indicate all the mipmap levels from MostDetailedMip on down to least detailed.

+
+ + ff476245 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Specifies the subresources from an array of 1D textures to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

+
+ + ff476227 + D3D11_TEX1D_ARRAY_SRV + D3D11_TEX1D_ARRAY_SRV +
+ + +

Index of the most detailed mipmap level to use; this number is between 0 and MipLevels (from the original Texture1D for which creates a view) -1.

+
+ + ff476227 + unsigned int MostDetailedMip + unsigned int MostDetailedMip +
+ + +

The maximum number of mipmap levels for the view of the texture. See the remarks in .

Set to -1 to indicate all the mipmap levels from MostDetailedMip on down to least detailed.

+
+ + ff476227 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476227 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures in the array.

+
+ + ff476227 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Specifies the subresource from a 1D texture to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

As an example, assuming MostDetailedMip = 6 and MipLevels = 2, the view will have access to 2 mipmap levels, 6 and 7, of the original texture for which creates the view. In this situation, MostDetailedMip is greater than the MipLevels in the view. However, MostDetailedMip is not greater than the MipLevels in the original resource.

+
+ + ff476231 + D3D11_TEX1D_SRV + D3D11_TEX1D_SRV +
+ + +

Index of the most detailed mipmap level to use; this number is between 0 and MipLevels (from the original Texture1D for which creates a view) -1.

+
+ + ff476231 + unsigned int MostDetailedMip + unsigned int MostDetailedMip +
+ + +

The maximum number of mipmap levels for the view of the texture. See the remarks.

Set to -1 to indicate all the mipmap levels from MostDetailedMip on down to least detailed.

+
+ + ff476231 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Specifies the subresources from an array of 2D textures to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

+
+ + ff476241 + D3D11_TEX2D_ARRAY_SRV + D3D11_TEX2D_ARRAY_SRV +
+ + +

Index of the most detailed mipmap level to use; this number is between 0 and MipLevels (from the original Texture2D for which creates a view) -1.

+
+ + ff476241 + unsigned int MostDetailedMip + unsigned int MostDetailedMip +
+ + +

The maximum number of mipmap levels for the view of the texture. See the remarks in .

Set to -1 to indicate all the mipmap levels from MostDetailedMip on down to least detailed.

+
+ + ff476241 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476241 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures in the array.

+
+ + ff476241 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Specifies the subresources from an array of multisampled 2D textures to use in a shader-resource view.

+
+ +

This structure is one member of a shader-resource-view description (see ).

+
+ + ff476235 + D3D11_TEX2DMS_ARRAY_SRV + D3D11_TEX2DMS_ARRAY_SRV +
+ + +

The index of the first texture to use in an array of textures.

+
+ + ff476235 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

Number of textures to use.

+
+ + ff476235 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Describes a raw buffer resource.

+
+ +

This structure is used by to create a raw buffer.

+
+ + ff476090 + D3D11_BUFFEREX_SRV + D3D11_BUFFEREX_SRV +
+ + +

The index of the first element to be accessed by the view.

+
+ + ff476090 + unsigned int FirstElement + unsigned int FirstElement +
+ + +

The number of elements in the resource.

+
+ + ff476090 + unsigned int NumElements + unsigned int NumElements +
+ + +

Options for binding a raw buffer (see ).

+
+ + ff476090 + D3D11_BUFFEREX_SRV_FLAG Flags + D3D11_BUFFEREX_SRV_FLAG Flags +
+ + +

Description of a vertex element in a vertex buffer in an output slot.

+
+ + ff476216 + D3D11_SO_DECLARATION_ENTRY + D3D11_SO_DECLARATION_ENTRY +
+ + +

Zero-based, stream number.

+
+ + ff476216 + unsigned int Stream + unsigned int Stream +
+ + +

Type of output element; possible values include: "POSITION", "NORMAL", or "TEXCOORD0". Note that if SemanticName is null then ComponentCount can be greater than 4 and the described entry will be a gap in the stream out where no data will be written.

+
+ + ff476216 + const char* SemanticName + char SemanticName +
+ + +

Output element's zero-based index. Should be used if, for example, you have more than one texture coordinate stored in each vertex.

+
+ + ff476216 + unsigned int SemanticIndex + unsigned int SemanticIndex +
+ + +

Which component of the entry to begin writing out to. Valid values are 0 to 3. For example, if you only wish to output to the y and z components of a position, then StartComponent should be 1 and ComponentCount should be 2.

+
+ + ff476216 + unsigned char StartComponent + unsigned char StartComponent +
+ + +

The number of components of the entry to write out to. Valid values are 1 to 4. For example, if you only wish to output to the y and z components of a position, then StartComponent should be 1 and ComponentCount should be 2. Note that if SemanticName is null then ComponentCount can be greater than 4 and the described entry will be a gap in the stream out where no data will be written.

+
+ + ff476216 + unsigned char ComponentCount + unsigned char ComponentCount +
+ + +

The associated stream output buffer that is bound to the pipeline (see ). The valid range for OutputSlot is 0 to 3.

+
+ + ff476216 + unsigned char OutputSlot + unsigned char OutputSlot +
+ + +

Query information about the amount of data streamed out to the stream-output buffers in between and .

+
+ + ff476193 + D3D11_QUERY_DATA_SO_STATISTICS + D3D11_QUERY_DATA_SO_STATISTICS +
+ + + No documentation. + + + unsigned longlong NumPrimitivesWritten + unsigned longlong NumPrimitivesWritten + + + + No documentation. + + + unsigned longlong PrimitivesStorageNeeded + unsigned longlong PrimitivesStorageNeeded + + + +

Describes a 1D texture.

+
+ +

This structure is used in a call to . A helpful derived structure CD3D11_TEXTURE1D_DESC is declared in D3D11.h, to help create a texture description.

The texture size range is determined by the feature level at which you create the device and not the Microsoft Direct3D interface version. For example, if you use Microsoft Direct3D?10 hardware at feature level 10 () and call to create an , you must constrain the maximum texture size to (8192) when you create your 1D texture.

+
+ + ff476252 + D3D11_TEXTURE1D_DESC + D3D11_TEXTURE1D_DESC +
+ + +

Texture width (in texels). The range is from 1 to (16384). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476252 + unsigned int Width + unsigned int Width +
+ + +

The maximum number of mipmap levels in the texture. See the remarks in . Use 1 for a multisampled texture; or 0 to generate a full set of subtextures.

+
+ + ff476252 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Number of textures in the array. The range is from 1 to (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476252 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Texture format (see ).

+
+ + ff476252 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

Value that identifies how the texture is to be read from and written to. The most common value is ; see for all possible values.

+
+ + ff476252 + D3D11_USAGE Usage + D3D11_USAGE Usage +
+ + +

Flags (see ) for binding to pipeline stages. The flags can be combined by a logical OR. For a 1D texture, the allowable values are: , and .

+
+ + ff476252 + D3D11_BIND_FLAG BindFlags + D3D11_BIND_FLAG BindFlags +
+ + +

Flags (see ) to specify the types of CPU access allowed. Use 0 if CPU access is not required. These flags can be combined with a logical OR.

+
+ + ff476252 + D3D11_CPU_ACCESS_FLAG CPUAccessFlags + D3D11_CPU_ACCESS_FLAG CPUAccessFlags +
+ + +

Flags (see ) that identify other, less common resource options. Use 0 if none of these flags apply. These flags can be combined with a logical OR.

+
+ + ff476252 + D3D11_RESOURCE_MISC_FLAG MiscFlags + D3D11_RESOURCE_MISC_FLAG MiscFlags +
+ + +

Describes a 2D texture.

+
+ +

This structure is used in a call to . A helpful derived structure CD3D11_TEXTURE2D_DESC is declared in D3D11.h, to help create a texture description.

The device places some size restrictions (must be multiples of a minimum size) for a subsampled, block compressed, or bit-format resource.

The texture size range is determined by the feature level at which you create the device and not the Microsoft Direct3D interface version. For example, if you use Microsoft Direct3D?10 hardware at feature level 10 () and call to create an , you must constrain the maximum texture size to (8192) when you create your 2D texture.

+
+ + ff476253 + D3D11_TEXTURE2D_DESC + D3D11_TEXTURE2D_DESC +
+ + +

Texture width (in texels). The range is from 1 to (16384). For a texture cube-map, the range is from 1 to (16384). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476253 + unsigned int Width + unsigned int Width +
+ + +

Texture height (in texels). The range is from 1 to (16384). For a texture cube-map, the range is from 1 to (16384). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476253 + unsigned int Height + unsigned int Height +
+ + +

The maximum number of mipmap levels in the texture. See the remarks in . Use 1 for a multisampled texture; or 0 to generate a full set of subtextures.

+
+ + ff476253 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Number of textures in the texture array. The range is from 1 to (2048). For a texture cube-map, this value is a multiple of 6 (that is, 6 times the value in the NumCubes member of ), and the range is from 6 to . The range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476253 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Texture format (see ).

+
+ + ff476253 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

Structure that specifies multisampling parameters for the texture. See .

+
+ + ff476253 + DXGI_SAMPLE_DESC SampleDesc + DXGI_SAMPLE_DESC SampleDesc +
+ + +

Value that identifies how the texture is to be read from and written to. The most common value is ; see for all possible values.

+
+ + ff476253 + D3D11_USAGE Usage + D3D11_USAGE Usage +
+ + +

Flags (see ) for binding to pipeline stages. The flags can be combined by a logical OR.

+
+ + ff476253 + D3D11_BIND_FLAG BindFlags + D3D11_BIND_FLAG BindFlags +
+ + +

Flags (see ) to specify the types of CPU access allowed. Use 0 if CPU access is not required. These flags can be combined with a logical OR.

+
+ + ff476253 + D3D11_CPU_ACCESS_FLAG CPUAccessFlags + D3D11_CPU_ACCESS_FLAG CPUAccessFlags +
+ + +

Flags (see ) that identify other, less common resource options. Use 0 if none of these flags apply. These flags can be combined by using a logical OR. For a texture cube-map, set the flag. Cube-map arrays (that is, ArraySize > 6) require feature level or higher.

+
+ + ff476253 + D3D11_RESOURCE_MISC_FLAG MiscFlags + D3D11_RESOURCE_MISC_FLAG MiscFlags +
+ + +

Describes a 3D texture.

+
+ +

This structure is used in a call to . A helpful derived structure CD3D11_TEXTURE3D_DESC is declared in D3D11.h, to help create a texture description.

The device restricts the size of subsampled, block compressed, and bit format resources to be multiples of sizes specific to each format.

The texture size range is determined by the feature level at which you create the device and not the Microsoft Direct3D interface version. For example, if you use Microsoft Direct3D?10 hardware at feature level 10 () and call to create an , you must constrain the maximum texture size to (2048) when you create your 3D texture.

+
+ + ff476254 + D3D11_TEXTURE3D_DESC + D3D11_TEXTURE3D_DESC +
+ + +

Texture width (in texels). The range is from 1 to (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476254 + unsigned int Width + unsigned int Width +
+ + +

Texture height (in texels). The range is from 1 to (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476254 + unsigned int Height + unsigned int Height +
+ + +

Texture depth (in texels). The range is from 1 to (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

+
+ + ff476254 + unsigned int Depth + unsigned int Depth +
+ + +

The maximum number of mipmap levels in the texture. See the remarks in . Use 1 for a multisampled texture; or 0 to generate a full set of subtextures.

+
+ + ff476254 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Texture format (see ).

+
+ + ff476254 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

Value that identifies how the texture is to be read from and written to. The most common value is ; see for all possible values.

+
+ + ff476254 + D3D11_USAGE Usage + D3D11_USAGE Usage +
+ + +

Flags (see ) for binding to pipeline stages. The flags can be combined by a logical OR.

+
+ + ff476254 + D3D11_BIND_FLAG BindFlags + D3D11_BIND_FLAG BindFlags +
+ + +

Flags (see ) to specify the types of CPU access allowed. Use 0 if CPU access is not required. These flags can be combined with a logical OR.

+
+ + ff476254 + D3D11_CPU_ACCESS_FLAG CPUAccessFlags + D3D11_CPU_ACCESS_FLAG CPUAccessFlags +
+ + +

Flags (see ) that identify other, less common resource options. Use 0 if none of these flags apply. These flags can be combined with a logical OR.

+
+ + ff476254 + D3D11_RESOURCE_MISC_FLAG MiscFlags + D3D11_RESOURCE_MISC_FLAG MiscFlags +
+ + +

Describes parameters used to load a texture from another texture.

+
+ +

This structure is used in a call to .

The default values are:

 pSrcBox = null; pDstBox = null; SrcFirstMip = 0; DstFirstMip = 0; NumMips = D3DX11_DEFAULT; SrcFirstElement = 0; DstFirstElement = 0; NumElements = D3DX11_DEFAULT; Filter = D3DX11_DEFAULT; MipFilter = D3DX11_DEFAULT;	
+            
+
+ + ff476327 + D3DX11_TEXTURE_LOAD_INFO + D3DX11_TEXTURE_LOAD_INFO +
+ + +

Source texture box (see ).

+
+ + ff476327 + D3D11_BOX* pSrcBox + D3D11_BOX pSrcBox +
+ + +

Destination texture box (see ).

+
+ + ff476327 + D3D11_BOX* pDstBox + D3D11_BOX pDstBox +
+ + +

Source texture mipmap level, see D3D11CalcSubresource for more detail.

+
+ + ff476327 + unsigned int SrcFirstMip + unsigned int SrcFirstMip +
+ + +

Destination texture mipmap level, see D3D11CalcSubresource for more detail.

+
+ + ff476327 + unsigned int DstFirstMip + unsigned int DstFirstMip +
+ + +

Number of mipmap levels in the source texture.

+
+ + ff476327 + unsigned int NumMips + unsigned int NumMips +
+ + +

First element of the source texture.

+
+ + ff476327 + unsigned int SrcFirstElement + unsigned int SrcFirstElement +
+ + +

First element of the destination texture.

+
+ + ff476327 + unsigned int DstFirstElement + unsigned int DstFirstElement +
+ + +

Number of elements to load.

+
+ + ff476327 + unsigned int NumElements + unsigned int NumElements +
+ + +

Filtering options during resampling (see ).

+
+ + ff476327 + D3DX11_FILTER_FLAG Filter + D3DX11_FILTER_FLAG Filter +
+ + +

Filtering options when generating mip levels (see ).

+
+ + ff476327 + D3DX11_FILTER_FLAG MipFilter + D3DX11_FILTER_FLAG MipFilter +
+ + + Source texture box (see ). + + D3D11_BOX* pSrcBox + + + + Destination texture box (see ). + + D3D11_BOX* pDstBox + + + +

Specifies the subresources from a resource that are accessible using an unordered-access view.

+
+ +

An unordered-access-view description is passed into to create a view.

+
+ + ff476258 + D3D11_UNORDERED_ACCESS_VIEW_DESC + D3D11_UNORDERED_ACCESS_VIEW_DESC +
+ + +

The data format (see ).

+
+ + ff476258 + DXGI_FORMAT Format + DXGI_FORMAT Format +
+ + +

The resource type (see ), which specifies how the resource will be accessed.

+
+ + ff476258 + D3D11_UAV_DIMENSION ViewDimension + D3D11_UAV_DIMENSION ViewDimension +
+ + +

Specifies which buffer elements can be accessed (see ).

+
+ + ff476258 + D3D11_BUFFER_UAV Buffer + D3D11_BUFFER_UAV Buffer +
+ + +

Specifies the subresources in a 1D texture that can be accessed (see ).

+
+ + ff476258 + D3D11_TEX1D_UAV Texture1D + D3D11_TEX1D_UAV Texture1D +
+ + +

Specifies the subresources in a 1D texture array that can be accessed (see ).

+
+ + ff476258 + D3D11_TEX1D_ARRAY_UAV Texture1DArray + D3D11_TEX1D_ARRAY_UAV Texture1DArray +
+ + +

Specifies the subresources in a 2D texture that can be accessed (see ).

+
+ + ff476258 + D3D11_TEX2D_UAV Texture2D + D3D11_TEX2D_UAV Texture2D +
+ + +

Specifies the subresources in a 2D texture array that can be accessed (see ).

+
+ + ff476258 + D3D11_TEX2D_ARRAY_UAV Texture2DArray + D3D11_TEX2D_ARRAY_UAV Texture2DArray +
+ + +

Specifies subresources in a 3D texture that can be accessed (see ).

+
+ + ff476258 + D3D11_TEX3D_UAV Texture3D + D3D11_TEX3D_UAV Texture3D +
+ + +

Describes an array of unordered-access 1D texture resources.

+
+ +

This structure is used by a .

+
+ + ff476228 + D3D11_TEX1D_ARRAY_UAV + D3D11_TEX1D_ARRAY_UAV +
+ + +

The mipmap slice index.

+
+ + ff476228 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

The zero-based index of the first array slice to be accessed.

+
+ + ff476228 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

The number of slices in the array.

+
+ + ff476228 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Unordered-access-view buffer options.

+
+ + ff476096 + D3D11_BUFFER_UAV + D3D11_BUFFER_UAV +
+ + +

Resource contains raw, unstructured data. Requires the UAV format to be .

+
+ + ff476096 + unsigned int FirstElement + unsigned int FirstElement +
+ + +

Allow data to be appended to the end of the buffer. flag must also be used for any view that will be used as a AppendStructuredBuffer or a ConsumeStructuredBuffer. Requires the UAV format to be .

+
+ + ff476096 + unsigned int NumElements + unsigned int NumElements +
+ + +

Adds a counter to the unordered-access-view buffer. can only be used on a UAV that is a RWStructuredBuffer and it enables the functionality needed for the IncrementCounter and DecrementCounter methods in HLSL. Requires the UAV format to be .

+
+ + ff476096 + D3D11_BUFFER_UAV_FLAG Flags + D3D11_BUFFER_UAV_FLAG Flags +
+ + +

Describes a unordered-access 1D texture resource.

+
+ +

This structure is used by a .

+
+ + ff476232 + D3D11_TEX1D_UAV + D3D11_TEX1D_UAV +
+ + +

The mipmap slice index.

+
+ + ff476232 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

Describes a unordered-access 2D texture resource.

+
+ +

This structure is used by a .

+
+ + ff476246 + D3D11_TEX2D_UAV + D3D11_TEX2D_UAV +
+ + +

The mipmap slice index.

+
+ + ff476246 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

Describes an array of unordered-access 2D texture resources.

+
+ +

This structure is used by a .

+
+ + ff476242 + D3D11_TEX2D_ARRAY_UAV + D3D11_TEX2D_ARRAY_UAV +
+ + +

The mipmap slice index.

+
+ + ff476242 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

The zero-based index of the first array slice to be accessed.

+
+ + ff476242 + unsigned int FirstArraySlice + unsigned int FirstArraySlice +
+ + +

The number of slices in the array.

+
+ + ff476242 + unsigned int ArraySize + unsigned int ArraySize +
+ + +

Describes a unordered-access 3D texture resource.

+
+ +

This structure is used by a .

+
+ + ff476249 + D3D11_TEX3D_UAV + D3D11_TEX3D_UAV +
+ + +

The mipmap slice index.

+
+ + ff476249 + unsigned int MipSlice + unsigned int MipSlice +
+ + +

The zero-based index of the first depth slice to be accessed.

+
+ + ff476249 + unsigned int FirstWSlice + unsigned int FirstWSlice +
+ + +

The number of depth slices.

+
+ + ff476249 + unsigned int WSize + unsigned int WSize +
+ + + Internal class used to initialize this assembly. + + + + + Initializes this assembly. + + + This method is called when the assembly is loaded. + + + + + Properties defining the way a buffer is bound to the pipeline as a target for stream output operations. + + + + + Initializes a new instance of the struct. + + The buffer being bound. + The offset to the first vertex (in bytes). + + + + Gets or sets the buffer being bound. + + + + + Gets or sets the offset from the start of the buffer of the first vertex to use (in bytes). + + + + + Properties defining the way a buffer (containing vertex data) is bound + to the pipeline for rendering. + + + + + Initializes a new instance of the struct. + + The buffer being bound. + The stride between vertex element (in bytes). + The offset to the first vertex (in bytes). + + + + Gets or sets the buffer being bound. + + + + + Gets or sets the stride between vertex elements in the buffer (in bytes). + + + + + Gets or sets the offset from the start of the buffer of the first vertex to use (in bytes). + + +
+
diff --git a/distribution/SharpDX.Direct3D9.dll b/distribution/SharpDX.Direct3D9.dll new file mode 100644 index 00000000..ec1831f1 Binary files /dev/null and b/distribution/SharpDX.Direct3D9.dll differ diff --git a/distribution/SharpDX.Direct3D9.xml b/distribution/SharpDX.Direct3D9.xml new file mode 100644 index 00000000..0b33d1a4 --- /dev/null +++ b/distribution/SharpDX.Direct3D9.xml @@ -0,0 +1,35480 @@ + + + + SharpDX.Direct3D9 + + + + + A collection of . + + + + +

Contains information identifying the adapter.

+
+ +

The following pseudocode example illustrates the version format encoded in the DriverVersion, DriverVersionLowPart, and DriverVersionHighPart members.

 Product = HIWORD(DriverVersion.HighPart)	
+            Version = LOWORD(DriverVersion.HighPart)	
+            SubVersion = HIWORD(DriverVersion.LowPart)	
+            Build = LOWORD(DriverVersion.LowPart)	
+            

See the Platform SDK for more information about the HIWORD macro, the LOWORD macro, and the structure.

MAX_DEVICE_IDENTIFIER_STRING is a constant with the following definition.

#define MAX_DEVICE_IDENTIFIER_STRING        512

The VendorId, DeviceId, SubSysId, and Revision members can be used in tandem to identify particular chip sets. However, use these members with caution.

+
+ + bb172505 + D3DADAPTER_IDENTIFIER9 + D3DADAPTER_IDENTIFIER9 +
+ + +

Used for presentation to the user. This should not be used to identify particular drivers, because many different strings might be associated with the same device and driver from different vendors.

+
+ + bb172505 + char Driver[512] + char Driver +
+ + +

Used for presentation to the user.

+
+ + bb172505 + char Description[512] + char Description +
+ + +

Device name for GDI.

+
+ + bb172505 + char DeviceName[32] + char DeviceName +
+ + +

Identify the version of the Direct3D driver. It is legal to do less than and greater than comparisons on the 64-bit signed integer value. However, exercise caution if you use this element to identify problematic drivers. Instead, you should use DeviceIdentifier. See Remarks.

+
+ + bb172505 + LARGE_INTEGER DriverVersion + LARGE_INTEGER DriverVersion +
+ + +

Identify the version of the Direct3D driver. It is legal to do < and > comparisons on the 64-bit signed integer value. However, exercise caution if you use this element to identify problematic drivers. Instead, you should use DeviceIdentifier. See Remarks.

+
+ + bb172505 + unsigned int VendorId + unsigned int VendorId +
+ + +

Identify the version of the Direct3D driver. It is legal to do < and > comparisons on the 64-bit signed integer value. However, exercise caution if you use this element to identify problematic drivers. Instead, you should use DeviceIdentifier. See Remarks.

+
+ + bb172505 + unsigned int DeviceId + unsigned int DeviceId +
+ + +

Can be used to help identify a particular chip set. Query this member to identify the manufacturer. The value can be zero if unknown.

+
+ + bb172505 + unsigned int SubSysId + unsigned int SubSysId +
+ + +

Can be used to help identify a particular chip set. Query this member to identify the type of chip set. The value can be zero if unknown.

+
+ + bb172505 + unsigned int Revision + unsigned int Revision +
+ + +

Can be used to help identify a particular chip set. Query this member to identify the subsystem, typically the particular board. The value can be zero if unknown.

+
+ + bb172505 + GUID DeviceIdentifier + GUID DeviceIdentifier +
+ + +

Can be used to help identify a particular chip set. Query this member to identify the revision level of the chip set. The value can be zero if unknown.

+
+ + bb172505 + unsigned int WHQLLevel + unsigned int WHQLLevel +
+ + + Gets a value indicating whether the adapeter is WHQL certified. + + + true if certified; otherwise, false. + + + + + Gets the driver version. + + + + + Gets the certification date. + + + + + Adapter information. + + + + + Gets the capabilities of this adapter. + + The type. + The capabilities + + + + Gets the display modes supported by this adapter. + + The format. + The display modes supported by this adapter. + + + + Gets the adapter ordinal. + + + + + Gets the current display mode. + + + + + Gets the details. + + + + + Gets the monitor. + + + + + The assembly provides managed Direct3D9 API. + + bb219837 + Direct3D9 + Direct3D9 + + + +

Sets a non-transposed matrix.

+
+ +

A non-transposed matrix contains row-major data. In other words, each vector is contained in a row.

If the destination matrix is smaller than the source matrix, the additional components of the source matrix will be ignored.

+
+ + bb205720 + ID3DXBaseEffect + ID3DXBaseEffect +
+ + + Gets the string. + + The parameter. + + HRESULT ID3DXBaseEffect::GetString([In] D3DXHANDLE hParameter,[Out] const void** ppString) + + + + Gets the value of the specified parameter. + + Handle of the parameter. + The value of the parameter. + HRESULT ID3DXBaseEffect::GetValue([In] D3DXHANDLE hParameter,[In] void* pData,[In] unsigned int Bytes) + + + + Gets the value of the specified parameter. + + + Handle of the parameter. + The count. + + The value of the parameter. + + HRESULT ID3DXBaseEffect::GetValue([In] D3DXHANDLE hParameter,[In] void* pData,[In] unsigned int Bytes) + + + + Sets a bool value. + + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetBool([In] D3DXHANDLE hConstant,[In] BOOL b) + + + + Sets a float value. + + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetFloat([In] D3DXHANDLE hConstant,[In] float f) + + + + Sets an int value. + + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetInt([In] D3DXHANDLE hConstant,[In] int n) + + + + Sets a matrix. + + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetMatrix([In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix) + + + + Sets a 4D vector. + + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetVector([In] D3DXHANDLE hConstant,[In] const D3DXVECTOR4* pVector) + + + + Sets a typed value. + + Type of the value to est + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetValue([In] D3DXHANDLE hConstant,[In] const void* pData,[In] unsigned int Bytes) + + + + Sets an array of bools. + + The effect handle. + The values. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetBoolArray([In] D3DXHANDLE hConstant,[In, Buffer] const BOOL* pb,[In] unsigned int Count) + + + + Sets an array of floats. + + The effect handle. + The values. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetFloatArray([In] D3DXHANDLE hConstant,[In, Buffer] const float* pf,[In] unsigned int Count) + + + + Sets an array of ints. + + The effect handle. + The values. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetIntArray([In] D3DXHANDLE hConstant,[In, Buffer] const int* pn,[In] unsigned int Count) + + + + Sets an array of matrices. + + The effect handle. + The values. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetMatrixArray([In] D3DXHANDLE hConstant,[In, Buffer] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + + + + Sets an array of 4D vectors. + + The effect handle. + The values. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetVectorArray([In] D3DXHANDLE hConstant,[In, Buffer] const D3DXVECTOR4* pVector,[In] unsigned int Count) + + + + Sets an array of elements. + + Type of the array element + The effect handle. + The values. + + A object describing the result of the operation. + + HRESULT ID3DXBaseEffect::SetValue([In] D3DXHANDLE hConstant,[In] const void* pData,[In] unsigned int Bytes) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the effect description.

+
+

Returns a description of the effect. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205681 + HRESULT ID3DXBaseEffect::GetDesc([Out] D3DXEFFECT_DESC* pDesc) + ID3DXBaseEffect::GetDesc +
+ + +

Gets a parameter or annotation description.

+
+

Parameter or annotation handle. See Handles (Direct3D 9).

+

Returns a description of the specified parameter or annotation. See .

+ + bb205698 + HRESULT ID3DXBaseEffect::GetParameterDesc([In] D3DXHANDLE hParameter,[Out] D3DXPARAMETER_DESC* pDesc) + ID3DXBaseEffect::GetParameterDesc +
+ + +

Gets a technique description.

+
+

Technique handle. See Handles (Direct3D 9).

+

Returns a description of the technique. See .

+ + bb205707 + HRESULT ID3DXBaseEffect::GetTechniqueDesc([In] D3DXHANDLE hTechnique,[Out] D3DXTECHNIQUE_DESC* pDesc) + ID3DXBaseEffect::GetTechniqueDesc +
+ + +

Gets a pass description.

+
+

Pass handle. See Handles (Direct3D 9).

+

Returns a description of the specified pass. See .

+ +

Note??If an effect is created with , this method will return null references (in ) to the shader functions.

+
+ + bb205702 + HRESULT ID3DXBaseEffect::GetPassDesc([In] D3DXHANDLE hPass,[Out] D3DXPASS_DESC* pDesc) + ID3DXBaseEffect::GetPassDesc +
+ + +

Gets a function description.

+
+

Function handle. See Handles (Direct3D 9).

+

Returns a description of the function. See .

+ + bb205686 + HRESULT ID3DXBaseEffect::GetFunctionDesc([In] D3DXHANDLE hShader,[Out] D3DXFUNCTION_DESC* pDesc) + ID3DXBaseEffect::GetFunctionDesc +
+ + +

Gets the handle of a top-level parameter or a structure member parameter.

+
+

Handle of the parameter, or null for top-level parameters. See Handles (Direct3D 9).

+

Parameter index.

+

Returns the handle of the specified parameter, or null if the index was invalid. See Handles (Direct3D 9).

+ + bb205695 + D3DXHANDLE ID3DXBaseEffect::GetParameter([In] D3DXHANDLE hParameter,[In] unsigned int Index) + ID3DXBaseEffect::GetParameter +
+ + +

Gets the handle of a top-level parameter or a structure member parameter by looking up its name.

+
+

Handle of the parameter, or null for top-level parameters. See Handles (Direct3D 9).

+

String containing the parameter name.

+

Returns the handle of the specified parameter, or null if the index was invalid. See Handles (Direct3D 9).

+ + bb205696 + D3DXHANDLE ID3DXBaseEffect::GetParameterByName([In] D3DXHANDLE hParameter,[In] const char* pName) + ID3DXBaseEffect::GetParameterByName +
+ + +

Gets the handle of a top-level parameter or a structure member parameter by looking up its semantic with a case-insensitive search.

+
+

Handle of the parameter, or null for top-level parameters. See Handles (Direct3D 9).

+

String containing the semantic name.

+

Returns the handle of the first parameter that matches the specified semantic, or null if the semantic was not found. See Handles (Direct3D 9).

+ + bb205697 + D3DXHANDLE ID3DXBaseEffect::GetParameterBySemantic([In] D3DXHANDLE hParameter,[In] const char* pSemantic) + ID3DXBaseEffect::GetParameterBySemantic +
+ + +

Get the handle of an array element parameter.

+
+

Handle of the array. See Handles (Direct3D 9).

+

Array element index.

+

Returns the handle of the specified parameter, or null if either hParameter or ElementIndex is invalid. See Handles (Direct3D 9).

+ +

This method is used to get an element of a parameter that is an array.

+
+ + bb205699 + D3DXHANDLE ID3DXBaseEffect::GetParameterElement([In] D3DXHANDLE hParameter,[In] unsigned int Index) + ID3DXBaseEffect::GetParameterElement +
+ + +

Gets the handle of a technique.

+
+

Technique index.

+

Returns the handle of the specified technique, or null if the index was invalid. See Handles (Direct3D 9).

+ + bb205705 + D3DXHANDLE ID3DXBaseEffect::GetTechnique([In] unsigned int Index) + ID3DXBaseEffect::GetTechnique +
+ + +

Gets the handle of a technique by looking up its name.

+
+

String containing the technique name.

+

Returns the handle of the first technique that has the specified name, or null if the name was not found. See Handles (Direct3D 9).

+ + Bb205706 + D3DXHANDLE ID3DXBaseEffect::GetTechniqueByName([In] const char* pName) + ID3DXBaseEffect::GetTechniqueByName +
+ + +

Gets the handle of a pass.

+
+

Handle of the parent technique. See Handles (Direct3D 9).

+

Index for the pass.

+

Returns the handle of the specified pass inside the specified technique, or null if the index was invalid. See Handles (Direct3D 9).

+ + bb205700 + D3DXHANDLE ID3DXBaseEffect::GetPass([In] D3DXHANDLE hTechnique,[In] unsigned int Index) + ID3DXBaseEffect::GetPass +
+ + +

Gets the handle of a pass by looking up its name.

+
+

Handle of the parent technique. See Handles (Direct3D 9).

+

String containing the pass name.

+

Returns the handle of the first pass inside the specified technique that has the specified name, or null if the name was not found. See Handles (Direct3D 9).

+ + bb205701 + D3DXHANDLE ID3DXBaseEffect::GetPassByName([In] D3DXHANDLE hTechnique,[In] const char* pName) + ID3DXBaseEffect::GetPassByName +
+ + +

Gets the handle of a function.

+
+

Function index.

+

Returns the handle of the specified function, or null if the index was invalid. See Handles (Direct3D 9).

+ + bb205684 + D3DXHANDLE ID3DXBaseEffect::GetFunction([In] unsigned int Index) + ID3DXBaseEffect::GetFunction +
+ + +

Gets the handle of a function by looking up its name.

+
+

String containing the function name.

+

Returns the handle of the specified function, or null if the name was not found. See Handles (Direct3D 9).

+ + bb205685 + D3DXHANDLE ID3DXBaseEffect::GetFunctionByName([In] const char* pName) + ID3DXBaseEffect::GetFunctionByName +
+ + +

Gets the handle of an annotation.

+
+

Handle of a technique, pass, or top-level parameter. See Handles (Direct3D 9).

+

Annotation index.

+

Returns the handle of the specified annotation, or null if the index was invalid. See Handles (Direct3D 9).

+ +

Annotations are user-specific data that can be attached to any technique, pass, or parameter. See Handles (Direct3D 9).

+
+ + bb205677 + D3DXHANDLE ID3DXBaseEffect::GetAnnotation([In] D3DXHANDLE hObject,[In] unsigned int Index) + ID3DXBaseEffect::GetAnnotation +
+ + +

Gets the handle of an annotation by looking up its name.

+
+

Handle of a technique, pass, or top-level parameter. See Handles (Direct3D 9).

+

String containing the annotation name.

+

Returns the handle of the specified annotation, or null if the name was not found. See Handles (Direct3D 9).

+ + bb205678 + D3DXHANDLE ID3DXBaseEffect::GetAnnotationByName([In] D3DXHANDLE hObject,[In] const char* pName) + ID3DXBaseEffect::GetAnnotationByName +
+ + +

Set the value of an arbitrary parameter or annotation, including simple types, structs, arrays, strings, shaders and textures.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Pointer to a buffer containing data.

+

[in] Number of bytes in the buffer. Pass in D3DX_DEFAULT if you know your buffer is large enough to contain the entire parameter, and you want to skip size validation.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method can be used in place of nearly all the effect set API calls.

+
+ + bb205728 + HRESULT ID3DXBaseEffect::SetValue([In] D3DXHANDLE hParameter,[In] const void* pData,[In] unsigned int Bytes) + ID3DXBaseEffect::SetValue +
+ + +

Get the value of an arbitrary parameter or annotation, including simple types, structs, arrays, strings, shaders and textures. This method can be used in place of nearly all the Getxxx calls in .

+
+ No documentation. + No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205709 + HRESULT ID3DXBaseEffect::GetValue([In] D3DXHANDLE hParameter,[In] void* pData,[In] unsigned int Bytes) + ID3DXBaseEffect::GetValue +
+ + +

Sets a value.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Boolean value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205714 + HRESULT ID3DXBaseEffect::SetBool([In] D3DXHANDLE hParameter,[In] BOOL b) + ID3DXBaseEffect::SetBool +
+ + +

Gets a value.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a Boolean value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205679 + HRESULT ID3DXBaseEffect::GetBool([In] D3DXHANDLE hParameter,[Out] BOOL* pb) + ID3DXBaseEffect::GetBool +
+ + +

Sets an array of Boolean values.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of Boolean values.

+

Number of Boolean values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205715 + HRESULT ID3DXBaseEffect::SetBoolArray([In] D3DXHANDLE hParameter,[In, Buffer] const BOOL* pb,[In] unsigned int Count) + ID3DXBaseEffect::SetBoolArray +
+ + +

Gets an array of values.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns an array of Boolean values.

+

Number of Boolean values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205680 + HRESULT ID3DXBaseEffect::GetBoolArray([In] D3DXHANDLE hParameter,[Out, Buffer] BOOL* pb,[In] unsigned int Count) + ID3DXBaseEffect::GetBoolArray +
+ + +

Sets an integer.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Integer value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205718 + HRESULT ID3DXBaseEffect::SetInt([In] D3DXHANDLE hParameter,[In] int n) + ID3DXBaseEffect::SetInt +
+ + +

Gets an integer.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns an integer.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205687 + HRESULT ID3DXBaseEffect::GetInt([In] D3DXHANDLE hParameter,[Out] int* pn) + ID3DXBaseEffect::GetInt +
+ + +

Sets an array of integers.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of integers.

+

Number of integers in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205719 + HRESULT ID3DXBaseEffect::SetIntArray([In] D3DXHANDLE hParameter,[In, Buffer] const int* pn,[In] unsigned int Count) + ID3DXBaseEffect::SetIntArray +
+ + +

Gets an array of integers.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns an array of integers.

+

Number of integers in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205688 + HRESULT ID3DXBaseEffect::GetIntArray([In] D3DXHANDLE hParameter,[Out, Buffer] int* pn,[In] unsigned int Count) + ID3DXBaseEffect::GetIntArray +
+ + +

Sets a floating point value.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Floating point value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205716 + HRESULT ID3DXBaseEffect::SetFloat([In] D3DXHANDLE hParameter,[In] float f) + ID3DXBaseEffect::SetFloat +
+ + +

Gets a floating point value.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a floating point value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205682 + HRESULT ID3DXBaseEffect::GetFloat([In] D3DXHANDLE hParameter,[Out] float* pf) + ID3DXBaseEffect::GetFloat +
+ + +

Sets an array of floating point values.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of floating point values.

+

Number of floating point values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205717 + HRESULT ID3DXBaseEffect::SetFloatArray([In] D3DXHANDLE hParameter,[In, Buffer] const float* pf,[In] unsigned int Count) + ID3DXBaseEffect::SetFloatArray +
+ + +

Gets an array of floating point values.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns an array of floating point values.

+

Number of floating point values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205683 + HRESULT ID3DXBaseEffect::GetFloatArray([In] D3DXHANDLE hParameter,[Out, Buffer] float* pf,[In] unsigned int Count) + ID3DXBaseEffect::GetFloatArray +
+ + +

Sets a vector.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Pointer to a 4D vector.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If the destination vector is smaller than the source vector, the additional components of the source vector will be ignored.

+
+ + bb205729 + HRESULT ID3DXBaseEffect::SetVector([In] D3DXHANDLE hParameter,[In] const D3DXVECTOR4* pVector) + ID3DXBaseEffect::SetVector +
+ + +

Gets a vector.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a 4D vector.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If the destination vector is larger than the source vector, only the initial components of the destination vector will be filled, and the remaining components will be set to zero.

+
+ + bb205710 + HRESULT ID3DXBaseEffect::GetVector([In] D3DXHANDLE hParameter,[Out] D3DXVECTOR4* pVector) + ID3DXBaseEffect::GetVector +
+ + +

Sets an array of vectors.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of 4D floating point vectors.

+

Number of vectors in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If the destination vectors are smaller than the source vectors, the additional components of the source vectors will be ignored.

+
+ + bb205730 + HRESULT ID3DXBaseEffect::SetVectorArray([In] D3DXHANDLE hParameter,[In, Buffer] const D3DXVECTOR4* pVector,[In] unsigned int Count) + ID3DXBaseEffect::SetVectorArray +
+ + +

Gets an array of vectors.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns an array of 4D floating point vectors.

+

Number of vectors in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If the destination vectors are larger than the source vectors, only the initial components of each destination vector will be filled, and the remaining destination vector components will be set to zero.

+
+ + bb205711 + HRESULT ID3DXBaseEffect::GetVectorArray([In] D3DXHANDLE hParameter,[Out, Buffer] D3DXVECTOR4* pVector,[In] unsigned int Count) + ID3DXBaseEffect::GetVectorArray +
+ + +

Sets a non-transposed matrix.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Pointer to a nontransposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A non-transposed matrix contains row-major data. In other words, each vector is contained in a row.

If the destination matrix is smaller than the source matrix, the additional components of the source matrix will be ignored.

+
+ + bb205720 + HRESULT ID3DXBaseEffect::SetMatrix([In] D3DXHANDLE hParameter,[In] const D3DXMATRIX* pMatrix) + ID3DXBaseEffect::SetMatrix +
+ + +

Gets a nontransposed matrix.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a nontransposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A nontransposed matrix contains row-major data; that is, each vector is contained in a row.

If the destination matrix is larger than the source matrix, only the upper-left components of the destination matrix will be filled, and the remaining components will be set to zero.

+
+ + bb205689 + HRESULT ID3DXBaseEffect::GetMatrix([In] D3DXHANDLE hParameter,[Out] D3DXMATRIX* pMatrix) + ID3DXBaseEffect::GetMatrix +
+ + +

Sets an array of nontransposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of nontransposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A nontransposed matrix contains row-major data; that is, each vector is contained in a row.

If the destination matrices are smaller than the source matrices, the additional components of the source matrices will be ignored.

+
+ + bb205721 + HRESULT ID3DXBaseEffect::SetMatrixArray([In] D3DXHANDLE hParameter,[In, Buffer] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXBaseEffect::SetMatrixArray +
+ + +

Gets an array of nontransposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns an array of nontransposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A nontransposed matrix contains row-major data; that is, each vector is contained in a row.

If the destination matrices are larger than the source matrices, only the upper-left components of each destination matrix will be filled, and the remaining destination matrix components will be set to zero.

+
+ + bb205690 + HRESULT ID3DXBaseEffect::GetMatrixArray([In] D3DXHANDLE hParameter,[Out, Buffer] D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXBaseEffect::GetMatrixArray +
+ + +

Sets an array of references to nontransposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of references to nontransposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A nontransposed matrix contains row-major data; that is, each vector is contained in a row.

If the destination matrices are smaller than the source matrices, the additional components of the source matrices will be ignored.

+
+ + bb205722 + HRESULT ID3DXBaseEffect::SetMatrixPointerArray([In] D3DXHANDLE hParameter,[In] const D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXBaseEffect::SetMatrixPointerArray +
+ + +

Gets an array of references to nontransposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of references to nontransposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A nontransposed matrix contains row-major data; that is, each vector is contained in a row.

If the destination matrices are larger than the source matrices, only the upper-left components of each destination matrix will be filled, and the remaining destination matrix components will be set to zero.

+
+ + bb205691 + HRESULT ID3DXBaseEffect::GetMatrixPointerArray([In] D3DXHANDLE hParameter,[Out] D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXBaseEffect::GetMatrixPointerArray +
+ + +

Sets a transposed matrix.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Pointer to a transposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

If the destination matrix is smaller than the source matrix, the additional components of the source matrix will be ignored.

+
+ + bb205723 + HRESULT ID3DXBaseEffect::SetMatrixTranspose([In] D3DXHANDLE hParameter,[In] const D3DXMATRIX* pMatrix) + ID3DXBaseEffect::SetMatrixTranspose +
+ + +

Gets a transposed matrix.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a transposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

If the destination matrix is larger than the source matrix, only the upper-left elements of the destination matrix will be filled, and the remaining destination matrix components will be set to zero.

+
+ + bb205692 + HRESULT ID3DXBaseEffect::GetMatrixTranspose([In] D3DXHANDLE hParameter,[Out] D3DXMATRIX* pMatrix) + ID3DXBaseEffect::GetMatrixTranspose +
+ + +

Sets an array of transposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

If the destination matrices are smaller than the source matrices, the additional components of the source matrices will be ignored.

+
+ + bb205724 + HRESULT ID3DXBaseEffect::SetMatrixTransposeArray([In] D3DXHANDLE hParameter,[In, Buffer] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXBaseEffect::SetMatrixTransposeArray +
+ + +

Gets an array of transposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns an array of transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

If the destination matrices are larger than the source matrices, only the upper-left components of each destination matrix will be filled, and the remaining destination matrix components will be set to zero.

+
+ + bb205693 + HRESULT ID3DXBaseEffect::GetMatrixTransposeArray([In] D3DXHANDLE hParameter,[Out, Buffer] D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXBaseEffect::GetMatrixTransposeArray +
+ + +

Sets an array of references to transposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of references to transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

If the destination matrices are smaller than the source matrices, the additional components of the source matrices will be ignored.

+
+ + bb205725 + HRESULT ID3DXBaseEffect::SetMatrixTransposePointerArray([In] D3DXHANDLE hParameter,[In] const D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXBaseEffect::SetMatrixTransposePointerArray +
+ + +

Gets an array of references to transposed matrices.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Array of references to transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

If the destination matrices are larger than the source matrices, only the upper-left components of each destination matrix will be filled, and the remaining destination matrix components will be set to zero.

+
+ + bb205694 + HRESULT ID3DXBaseEffect::GetMatrixTransposePointerArray([In] D3DXHANDLE hParameter,[Out] D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXBaseEffect::GetMatrixTransposePointerArray +
+ + +

Sets a string.

+
+

Unique identifier. See Handles (Direct3D 9).

+

String to set.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205726 + HRESULT ID3DXBaseEffect::SetString([In] D3DXHANDLE hParameter,[In] const char* pString) + ID3DXBaseEffect::SetString +
+ + +

Gets a string.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a string identified by hParameter.

+ + bb205704 + HRESULT ID3DXBaseEffect::GetString([In] D3DXHANDLE hParameter,[Out] const void** ppString) + ID3DXBaseEffect::GetString +
+ + +

Sets a texture.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Texture object. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205727 + HRESULT ID3DXBaseEffect::SetTexture([In] D3DXHANDLE hParameter,[In] IDirect3DBaseTexture9* pTexture) + ID3DXBaseEffect::SetTexture +
+ + +

Gets a texture.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a texture object. See .

+ + bb205708 + HRESULT ID3DXBaseEffect::GetTexture([In] D3DXHANDLE hParameter,[Out] IDirect3DBaseTexture9** ppTexture) + ID3DXBaseEffect::GetTexture +
+ + +

Gets a pixel shader.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a pixel shader object. See object.

+ + bb205703 + HRESULT ID3DXBaseEffect::GetPixelShader([In] D3DXHANDLE hParameter,[Out] IDirect3DPixelShader9** ppPShader) + ID3DXBaseEffect::GetPixelShader +
+ + +

Gets a vertex shader.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Returns a vertex shader object. See .

+ + bb205712 + HRESULT ID3DXBaseEffect::GetVertexShader([In] D3DXHANDLE hParameter,[Out] IDirect3DVertexShader9** ppVShader) + ID3DXBaseEffect::GetVertexShader +
+ + +

Set the range of an array to pass to the device.

+
+

Unique identifier. See Handles (Direct3D 9).

+

Start index.

+

Stop index.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205713 + HRESULT ID3DXBaseEffect::SetArrayRange([In] D3DXHANDLE hParameter,[In] unsigned int uStart,[In] unsigned int uEnd) + ID3DXBaseEffect::SetArrayRange +
+ + +

Gets the effect description.

+
+ + bb205681 + GetDesc + GetDesc + HRESULT ID3DXBaseEffect::GetDesc([Out] D3DXEFFECT_DESC* pDesc) +
+ + +

Applications use the methods of the interface to manipulate texture resources including cube and volume textures.

+
+ +

The interface assigned to a particular stage for a device is obtained by calling the GetTexture method.

The LPDIRECT3DBASETEXTURE9 and PDIRECT3DBASETEXTURE9 types are defined as references to the interface.

typedef struct  *LPDIRECT3DBASETEXTURE9, *PDIRECT3DBASETEXTURE9;
+
+ + bb174322 + IDirect3DBaseTexture9 + IDirect3DBaseTexture9 +
+ + +

Applications use the methods of the interface to query and prepare resources.

+
+ +

To create a texture resource, you can call one of the following methods.

To create a geometry-oriented resource, you can call one of the following methods.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DRESOURCE9 and PDIRECT3DRESOURCE9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DRESOURCE9, *PDIRECT3DRESOURCE9;	
+            
+
+ + bb205878 + IDirect3DResource9 + IDirect3DResource9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the device associated with a resource.

+
+

Address of a reference to an interface to fill with the device reference, if the query succeeds.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method allows navigation to the owning device object.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205880 + HRESULT IDirect3DResource9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DResource9::GetDevice +
+ + +

Associates data with the resource that is intended for use by the application, not by Direct3D. Data is passed by value, and multiple sets of data can be associated with a single resource.

+
+

Reference to the globally unique identifier that identifies the private data to set.

+

Pointer to a buffer that contains the data to be associated with the resource.

+

Size of the buffer at pData, in bytes.

+

Value that describes the type of data being passed, or indicates to the application that the data should be invalidated when the resource changes.

ItemDescription

(none)

If no flags are specified, Direct3D allocates memory to hold the data within the buffer and copies the data into the new buffer. The buffer allocated by Direct3D is automatically freed, as appropriate.

D3DSPD_IUNKNOWN

The data at pData is a reference to an interface. SizeOfData must be set to the size of a reference to , that is, sizeof(*). Direct3D automatically callsIUnknown through pData when the private data is destroyed. Private data will be destroyed by a subsequent call to with the same , a subsequent call to , or when the object is released. For more information, see Remarks.

?

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Direct3D does not manage the memory at pData. If this buffer was dynamically allocated, it is the calling application's responsibility to free the memory.

+
+ + bb205886 + HRESULT IDirect3DResource9::SetPrivateData([In] const GUID& refguid,[In] const void* pData,[In] unsigned int SizeOfData,[In] unsigned int Flags) + IDirect3DResource9::SetPrivateData +
+ + +

Copies the private data associated with the resource to a provided buffer.

+
+

The globally unique identifier that identifies the private data to retrieve.

+

Pointer to a previously allocated buffer to fill with the requested private data if the call succeeds. The application calling this method is responsible for allocating and releasing this buffer. If this parameter is null, this method will return the buffer size in pSizeOfData.

+

Pointer to the size of the buffer at pData, in bytes. If this value is less than the actual size of the private data (such as 0), the method sets this parameter to the required buffer size and the method returns .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , .

+ +

This method is inherited by the following interfaces: , , , , , , .

+
+ + bb205882 + HRESULT IDirect3DResource9::GetPrivateData([In] const GUID& refguid,[In] void* pData,[InOut] unsigned int* pSizeOfData) + IDirect3DResource9::GetPrivateData +
+ + +

Frees the specified private data associated with this resource.

+
+

Reference to the globally unique identifier that identifies the private data to free.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , .

+ +

Direct3D calls this method automatically when a resource is released.

+
+ + bb205879 + HRESULT IDirect3DResource9::FreePrivateData([In] const GUID& refguid) + IDirect3DResource9::FreePrivateData +
+ + +

Assigns the priority of a resource for scheduling purposes.

+
+

Priority to assign to a resource.

Differences between Direct3D 9 and Direct3D 9 for Windows Vista

The priority can be any DWORD value; Direct3D 9 for Windows Vista also supports any of these pre-defined values D3D9_RESOURCE_PRIORITY.

?

+

Returns the previous priority value for the resource.

+ +

This method is used to change the priority of managed resources (resources created with the flag). This method returns 0 on non-managed resources.

Priorities are used to determine when managed resources are to be removed from memory. A resource assigned a low priority is removed before a resource with a high priority. If two resources have the same priority, the resource that was used more recently is kept in memory; the other resource is removed. Managed resources have a default priority of 0.

Windows Vista only - When this method is called using an interface, only resources created with the flag will be affected.

+
+ + bb205885 + unsigned int IDirect3DResource9::SetPriority([In] unsigned int PriorityNew) + IDirect3DResource9::SetPriority +
+ + +

Retrieves the priority for this resource.

+
+

Returns a DWORD value, indicating the priority of the resource.

+ +

is used for priority control of managed resources. This method returns 0 on nonmanaged resources.

Priorities are used to determine when managed resources are to be removed from memory. A resource assigned a low priority is removed before a resource with a high priority. If two resources have the same priority, the resource that was used more recently is kept in memory; the other resource is removed. Managed resources have a default priority of 0.

+
+ + bb205881 + unsigned int IDirect3DResource9::GetPriority() + IDirect3DResource9::GetPriority +
+ + +

Preloads a managed resource.

+
+ +

Calling this method indicates that the application will need this managed resource shortly. This method has no effect on nonmanaged resources.

detects "thrashing" conditions where more resources are being used in each frame than can fit in video memory simultaneously. Under such circumstances silently does nothing.

+
+ + bb205884 + void IDirect3DResource9::PreLoad() + IDirect3DResource9::PreLoad +
+ + +

Returns the type of the resource.

+
+

Returns a member of the enumerated type, identifying the type of the resource.

+ + bb205883 + D3DRESOURCETYPE IDirect3DResource9::GetType() + IDirect3DResource9::GetType +
+ + +

Retrieves the device associated with a resource.

+
+ +

This method allows navigation to the owning device object.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205880 + GetDevice + GetDevice + HRESULT IDirect3DResource9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Retrieves the priority for this resource.

+
+ +

is used for priority control of managed resources. This method returns 0 on nonmanaged resources.

Priorities are used to determine when managed resources are to be removed from memory. A resource assigned a low priority is removed before a resource with a high priority. If two resources have the same priority, the resource that was used more recently is kept in memory; the other resource is removed. Managed resources have a default priority of 0.

+
+ + bb205881 + GetPriority + GetPriority + unsigned int IDirect3DResource9::GetPriority() +
+ + +

Returns the type of the resource.

+
+ + bb205883 + GetType + GetType + D3DRESOURCETYPE IDirect3DResource9::GetType() +
+ + + Gets or sets the debug-name for this object. + + + The debug name. + + + + + Filters mipmap levels of a texture. + + The source level. + The filter. + + A object describing the result of the operation. + + HRESULT D3DXFilterTexture([In] IDirect3DBaseTexture9* pBaseTexture,[In, Buffer] const PALETTEENTRY* pPalette,[In] unsigned int SrcLevel,[In] D3DX_FILTER Filter) + + + + Filters mipmap levels of a texture. + + The source level. + The filter. + The palette. + + A object describing the result of the operation. + + HRESULT D3DXFilterTexture([In] IDirect3DBaseTexture9* pBaseTexture,[In, Buffer] const PALETTEENTRY* pPalette,[In] unsigned int SrcLevel,[In] D3DX_FILTER Filter) + + + + Saves a texture to a file. + + The texture. + Name of the file. + The format. + + A object describing the result of the operation. + + HRESULT D3DXSaveTextureToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DBaseTexture9* pSrcTexture,[In, Buffer] const PALETTEENTRY* pSrcPalette) + + + + Saves a texture to a file. + + The texture. + Name of the file. + The format. + The palette. + A object describing the result of the operation. + HRESULT D3DXSaveTextureToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DBaseTexture9* pSrcTexture,[In, Buffer] const PALETTEENTRY* pSrcPalette) + + + + Saves a texture to a stream. + + The texture. + The format. + A containing the saved texture. + HRESULT D3DXSaveTextureToFileInMemory([Out] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DBaseTexture9* pSrcTexture,[In, Buffer] const PALETTEENTRY* pSrcPalette) + + + + Saves a texture to a stream. + + The texture. + The format. + The palette. + A containing the saved texture. + HRESULT D3DXSaveTextureToFileInMemory([Out] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DBaseTexture9* pSrcTexture,[In, Buffer] const PALETTEENTRY* pSrcPalette) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets the most detailed level-of-detail for a managed texture.

+
+

Most detailed level-of-detail value to set for the mipmap chain.

+

A DWORD value, clamped to the maximum level-of-detail value (one less than the total number of levels). Subsequent calls to this method will return the clamped value, not the level-of-detail value that was previously set.

+ +

This method applies to the following interfaces, which inherit from .

SetLOD is used for level-of-detail control of managed textures. This method returns 0 on nonmanaged textures.

SetLOD communicates to the Direct3D texture manager the most detailed mipmap in the chain that should be loaded into local video memory. For example, in a five-level mipmap chain, setting LODNew to 2 indicates that the texture manager should load only mipmap levels 2 through 4 into local video memory at any given time.

More specifically, if the texture was created with the dimensions of 256x256, setting the most detailed level to 0 indicates that 256 x 256 is the largest mipmap available, setting the most detailed level to 1 indicates that 128 x 128 is the largest mipmap available, and so on, up to the most detailed mip level (the smallest texture size) for the chain.

+
+ + bb174328 + unsigned int IDirect3DBaseTexture9::SetLOD([In] unsigned int LODNew) + IDirect3DBaseTexture9::SetLOD +
+ + +

Returns a value clamped to the maximum level-of-detail set for a managed texture (this method is not supported for an unmanaged texture).

+
+

A DWORD value, clamped to the maximum level-of-detail value (one less than the total number of levels). Calling GetLOD on an unmanaged texture is not supported and will result in a D3DERR error code being returned.

+ + bb174326 + unsigned int IDirect3DBaseTexture9::GetLOD() + IDirect3DBaseTexture9::GetLOD +
+ + +

Returns the number of texture levels in a multilevel texture.

+
+

A DWORD value indicating the number of texture levels in a multilevel texture.

+ +

This method applies to the following interfaces, which inherit from .

+
+ + bb174325 + unsigned int IDirect3DBaseTexture9::GetLevelCount() + IDirect3DBaseTexture9::GetLevelCount +
+ + +

Set the filter type that is used for automatically generated mipmap sublevels.

+
+

Filter type. See . This method will fail if the filter type is invalid or not supported.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Changing the filter type "dirties" the mipmap sublevels and causes them to be regenerated.

The (default) filter type set at texture creation time is . If the driver does not support a linear filter, the filter type will be set to . All filter types supported by the driver for regular texture filtering are supported for autogeneration except . SetAutoGenFilterType will fail unless the driver sets the appropriate D3DPTFILTERCAPS_MINFxxx caps. These values are specified in the TextureFilterCaps and/or CubeTextureFilterCaps members of . For more information about texture filter types, see .

This method has no effect if the texture is not created with . In this case, no failure is returned. For more information about usage constants, see .

+
+ + bb174327 + HRESULT IDirect3DBaseTexture9::SetAutoGenFilterType([In] D3DTEXTUREFILTERTYPE FilterType) + IDirect3DBaseTexture9::SetAutoGenFilterType +
+ + +

Get the filter type that is used for automatically generated mipmap sublevels.

+
+

Filter type. See . A texture must be created with to use this method. Any other usage value will cause this method to return .

+ +

Changing the filter type "dirties" the mipmap sublevels and causes them to be regenerated.

The (default) filter type set at texture creation time is . If the driver doesn't support a linear filter, the filter type will be set to . All filter types supported by the driver for regular texture filtering are supported for autogeneration except . For each resource type, drivers should support all the filter types reported in the corresponding texture, CubeTexture, and volumetexture filter caps. For more information about texture types, see .

This method has no effect if the texture is not created with .

+
+ + bb174324 + D3DTEXTUREFILTERTYPE IDirect3DBaseTexture9::GetAutoGenFilterType() + IDirect3DBaseTexture9::GetAutoGenFilterType +
+ + +

Generate mipmap sublevels.

+
+ +

An application can generate mipmap sublevels at any time by calling GenerateMipSubLevels. To have mipmap sublevels generated automatically at texture creation time (see Automatic Generation of Mipmaps (Direct3D 9)), specify during CreateTexture, CreateCubeTexture, and CreateVolumeTexture. For more information about usage constants, see .

+
+ + bb174323 + void IDirect3DBaseTexture9::GenerateMipSubLevels() + IDirect3DBaseTexture9::GenerateMipSubLevels +
+ + + Gets or sets the level of details. + + + The level of details. + + unsigned int IDirect3DBaseTexture9::GetLOD() + unsigned int IDirect3DBaseTexture9::SetLOD([In] unsigned int LODNew) + + + +

Returns the number of texture levels in a multilevel texture.

+
+ +

This method applies to the following interfaces, which inherit from .

+
+ + bb174325 + GetLevelCount + GetLevelCount + unsigned int IDirect3DBaseTexture9::GetLevelCount() +
+ + +

Get or sets the filter type that is used for automatically generated mipmap sublevels.

+
+ +

Changing the filter type "dirties" the mipmap sublevels and causes them to be regenerated.

The (default) filter type set at texture creation time is . If the driver doesn't support a linear filter, the filter type will be set to . All filter types supported by the driver for regular texture filtering are supported for autogeneration except . For each resource type, drivers should support all the filter types reported in the corresponding texture, CubeTexture, and volumetexture filter caps. For more information about texture types, see .

This method has no effect if the texture is not created with .

+
+ + bb174324 + GetAutoGenFilterType / SetAutoGenFilterType + GetAutoGenFilterType + D3DTEXTUREFILTERTYPE IDirect3DBaseTexture9::GetAutoGenFilterType() +
+ + +

Describes a subset of the mesh that has the same attribute and bone combination.

+
+ +

The subset of the mesh described by can be rendered in a single drawing call.

+
+ + bb172712 + D3DXBONECOMBINATION + D3DXBONECOMBINATION +
+ + + Get the bone identifiers. + + + + +

Attribute table identifier.

+
+ + bb172712 + unsigned int AttribId + unsigned int AttribId +
+ + +

Starting face.

+
+ + bb172712 + unsigned int FaceStart + unsigned int FaceStart +
+ + +

Face count.

+
+ + bb172712 + unsigned int FaceCount + unsigned int FaceCount +
+ + +

Starting vertex.

+
+ + bb172712 + unsigned int VertexStart + unsigned int VertexStart +
+ + +

Vertex count.

+
+ + bb172712 + unsigned int VertexCount + unsigned int VertexCount +
+ + +

Pointer to an array of values that identify each of the bones that can be drawn in a single drawing call. Note that the array can be of variable length to accommodate variable length bone combinations of ConvertToIndexedBlendedMesh.

The size of the array varies based on the type of mesh generated. A non-indexed mesh array size is equal to the number of weights per vertex (pMaxVertexInfl in ConvertToBlendedMesh). An indexed mesh array size is equal to the number of bone matrix palette entries (paletteSize in ConvertToIndexedBlendedMesh).

+
+ + bb172712 + unsigned int* BoneId + unsigned int BoneId +
+ + + No documentation. + + + D3DCAPS9 + D3DCAPS9 + + + + No documentation. + + + D3DDEVTYPE DeviceType + D3DDEVTYPE DeviceType + + + + No documentation. + + + unsigned int AdapterOrdinal + unsigned int AdapterOrdinal + + + + No documentation. + + + D3DCAPS Caps + D3DCAPS Caps + + + + No documentation. + + + D3DCAPS2 Caps2 + D3DCAPS2 Caps2 + + + + No documentation. + + + D3DCAPS3 Caps3 + D3DCAPS3 Caps3 + + + + No documentation. + + + D3DPRESENT_INTERVAL PresentationIntervals + D3DPRESENT_INTERVAL PresentationIntervals + + + + No documentation. + + + D3DCURSORCAPS CursorCaps + D3DCURSORCAPS CursorCaps + + + + No documentation. + + + D3DDEVCAPS DevCaps + D3DDEVCAPS DevCaps + + + + No documentation. + + + D3DPMISCCAPS PrimitiveMiscCaps + D3DPMISCCAPS PrimitiveMiscCaps + + + + No documentation. + + + D3DPRASTERCAPS RasterCaps + D3DPRASTERCAPS RasterCaps + + + + No documentation. + + + D3DPCMPCAPS ZCmpCaps + D3DPCMPCAPS ZCmpCaps + + + + No documentation. + + + D3DPBLENDCAPS SrcBlendCaps + D3DPBLENDCAPS SrcBlendCaps + + + + No documentation. + + + D3DPBLENDCAPS DestBlendCaps + D3DPBLENDCAPS DestBlendCaps + + + + No documentation. + + + D3DPCMPCAPS AlphaCmpCaps + D3DPCMPCAPS AlphaCmpCaps + + + + No documentation. + + + D3DPSHADECAPS ShadeCaps + D3DPSHADECAPS ShadeCaps + + + + No documentation. + + + D3DPTEXTURECAPS TextureCaps + D3DPTEXTURECAPS TextureCaps + + + + No documentation. + + + D3DPTFILTERCAPS TextureFilterCaps + D3DPTFILTERCAPS TextureFilterCaps + + + + No documentation. + + + D3DPTFILTERCAPS CubeTextureFilterCaps + D3DPTFILTERCAPS CubeTextureFilterCaps + + + + No documentation. + + + D3DPTFILTERCAPS VolumeTextureFilterCaps + D3DPTFILTERCAPS VolumeTextureFilterCaps + + + + No documentation. + + + D3DPTADDRESSCAPS TextureAddressCaps + D3DPTADDRESSCAPS TextureAddressCaps + + + + No documentation. + + + D3DPTADDRESSCAPS VolumeTextureAddressCaps + D3DPTADDRESSCAPS VolumeTextureAddressCaps + + + + No documentation. + + + D3DLINECAPS LineCaps + D3DLINECAPS LineCaps + + + + No documentation. + + + unsigned int MaxTextureWidth + unsigned int MaxTextureWidth + + + + No documentation. + + + unsigned int MaxTextureHeight + unsigned int MaxTextureHeight + + + + No documentation. + + + unsigned int MaxVolumeExtent + unsigned int MaxVolumeExtent + + + + No documentation. + + + unsigned int MaxTextureRepeat + unsigned int MaxTextureRepeat + + + + No documentation. + + + unsigned int MaxTextureAspectRatio + unsigned int MaxTextureAspectRatio + + + + No documentation. + + + unsigned int MaxAnisotropy + unsigned int MaxAnisotropy + + + + No documentation. + + + float MaxVertexW + float MaxVertexW + + + + No documentation. + + + float GuardBandLeft + float GuardBandLeft + + + + No documentation. + + + float GuardBandTop + float GuardBandTop + + + + No documentation. + + + float GuardBandRight + float GuardBandRight + + + + No documentation. + + + float GuardBandBottom + float GuardBandBottom + + + + No documentation. + + + float ExtentsAdjust + float ExtentsAdjust + + + + No documentation. + + + D3DSTENCILCAPS StencilCaps + D3DSTENCILCAPS StencilCaps + + + + No documentation. + + + D3DFVFCAPS FVFCaps + D3DFVFCAPS FVFCaps + + + + No documentation. + + + D3DTEXOPCAPS TextureOpCaps + D3DTEXOPCAPS TextureOpCaps + + + + No documentation. + + + unsigned int MaxTextureBlendStages + unsigned int MaxTextureBlendStages + + + + No documentation. + + + unsigned int MaxSimultaneousTextures + unsigned int MaxSimultaneousTextures + + + + No documentation. + + + D3DVTXPCAPS VertexProcessingCaps + D3DVTXPCAPS VertexProcessingCaps + + + + No documentation. + + + unsigned int MaxActiveLights + unsigned int MaxActiveLights + + + + No documentation. + + + unsigned int MaxUserClipPlanes + unsigned int MaxUserClipPlanes + + + + No documentation. + + + unsigned int MaxVertexBlendMatrices + unsigned int MaxVertexBlendMatrices + + + + No documentation. + + + unsigned int MaxVertexBlendMatrixIndex + unsigned int MaxVertexBlendMatrixIndex + + + + No documentation. + + + float MaxPointSize + float MaxPointSize + + + + No documentation. + + + unsigned int MaxPrimitiveCount + unsigned int MaxPrimitiveCount + + + + No documentation. + + + unsigned int MaxVertexIndex + unsigned int MaxVertexIndex + + + + No documentation. + + + unsigned int MaxStreams + unsigned int MaxStreams + + + + No documentation. + + + unsigned int MaxStreamStride + unsigned int MaxStreamStride + + + + No documentation. + + + unsigned int VertexShaderVersion + unsigned int VertexShaderVersion + + + + No documentation. + + + unsigned int MaxVertexShaderConst + unsigned int MaxVertexShaderConst + + + + No documentation. + + + unsigned int PixelShaderVersion + unsigned int PixelShaderVersion + + + + No documentation. + + + float PixelShader1xMaxValue + float PixelShader1xMaxValue + + + + No documentation. + + + D3DDEVCAPS2 DevCaps2 + D3DDEVCAPS2 DevCaps2 + + + + No documentation. + + + float MaxNpatchTessellationLevel + float MaxNpatchTessellationLevel + + + + No documentation. + + + unsigned int Reserved5 + unsigned int Reserved5 + + + + No documentation. + + + unsigned int MasterAdapterOrdinal + unsigned int MasterAdapterOrdinal + + + + No documentation. + + + unsigned int AdapterOrdinalInGroup + unsigned int AdapterOrdinalInGroup + + + + No documentation. + + + unsigned int NumberOfAdaptersInGroup + unsigned int NumberOfAdaptersInGroup + + + + No documentation. + + + D3DDTCAPS DeclTypes + D3DDTCAPS DeclTypes + + + + No documentation. + + + unsigned int NumSimultaneousRTs + unsigned int NumSimultaneousRTs + + + + No documentation. + + + D3DPTFILTERCAPS StretchRectFilterCaps + D3DPTFILTERCAPS StretchRectFilterCaps + + + + No documentation. + + + D3DVSHADERCAPS2_0 VS20Caps + D3DVSHADERCAPS2_0 VS20Caps + + + + No documentation. + + + D3DPSHADERCAPS2_0 PS20Caps + D3DPSHADERCAPS2_0 PS20Caps + + + + No documentation. + + + D3DPTFILTERCAPS VertexTextureFilterCaps + D3DPTFILTERCAPS VertexTextureFilterCaps + + + + No documentation. + + + unsigned int MaxVShaderInstructionsExecuted + unsigned int MaxVShaderInstructionsExecuted + + + + No documentation. + + + unsigned int MaxPShaderInstructionsExecuted + unsigned int MaxPShaderInstructionsExecuted + + + + No documentation. + + + unsigned int MaxVertexShader30InstructionSlots + unsigned int MaxVertexShader30InstructionSlots + + + + No documentation. + + + unsigned int MaxPixelShader30InstructionSlots + unsigned int MaxPixelShader30InstructionSlots + + + + Gets the pixel shader version. + + + + + Gets the vertex shader version. + + + + + Shader compilation results. + + + + + Initializes a new instance of the class. + + The bytecode. + The result code. + The message. + + + + Performs an implicit conversion from to . + + The input. + + The result of the conversion. + + + + +

The interface is used to access the constant table. This table contains the variables that are used by high-level language shaders and effects.

+
+ +

The LPD3DXCONSTANTTABLE type is defined as a reference to the interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXCONSTANTTABLE;	
+            
+
+ + bb205762 + ID3DXConstantTable + ID3DXConstantTable +
+ + + Gets a single constant description in the constant table. + + The effect handle. + The constant description + HRESULT ID3DXConstantTable::GetConstantDesc([In] D3DXHANDLE hConstant,[Out, Buffer] D3DXCONSTANT_DESC* pConstantDesc,[InOut] unsigned int* pCount) + + + + Gets an array of constant descriptions in the constant table. + + The effect handle. + An array of constant descriptions + HRESULT ID3DXConstantTable::GetConstantDesc([In] D3DXHANDLE hConstant,[Out, Buffer] D3DXCONSTANT_DESC* pConstantDesc,[InOut] unsigned int* pCount) + + + + Sets a bool value. + + The device. + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXConstantTable::SetBool([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] BOOL b) + + + + Sets a float value. + + The device. + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXConstantTable::SetFloat([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] float f) + + + + Sets an int value. + + The device. + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXConstantTable::SetInt([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] int n) + + + + Sets a matrix. + + The device. + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXConstantTable::SetMatrix([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix) + + + + Sets a 4D vector. + + The device. + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXConstantTable::SetVector([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const D3DXVECTOR4* pVector) + + + + Sets a typed value. + + Type of the value to est + The device. + The effect handle. + The value. + + A object describing the result of the operation. + + HRESULT ID3DXConstantTable::SetValue([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const void* pData,[In] unsigned int Bytes) + + + + Sets an array of bools. + + The device. + The effect handle. + The values. + A object describing the result of the operation. + HRESULT ID3DXConstantTable::SetBoolArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const BOOL* pb,[In] unsigned int Count) + + + + Sets an array of floats. + + The device. + The effect handle. + The values. + A object describing the result of the operation. + HRESULT ID3DXConstantTable::SetFloatArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const float* pf,[In] unsigned int Count) + + + + Sets an array of ints. + + The device. + The effect handle. + The values. + A object describing the result of the operation. + HRESULT ID3DXConstantTable::SetIntArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const int* pn,[In] unsigned int Count) + + + + Sets an array of matrices. + + The device. + The effect handle. + The values. + A object describing the result of the operation. + HRESULT ID3DXConstantTable::SetMatrixArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + + + + Sets an array of 4D vectors. + + The device. + The effect handle. + The values. + A object describing the result of the operation. + HRESULT ID3DXConstantTable::SetVectorArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const D3DXVECTOR4* pVector,[In] unsigned int Count) + + + + Sets an array of elements. + + Type of the array element + The device. + The effect handle. + The values. + + A object describing the result of the operation. + + HRESULT ID3DXConstantTable::SetValue([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const void* pData,[In] unsigned int Bytes) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets a reference to the buffer that contains the constant table.

+
+

Returns a reference the buffer.

+ + bb205763 + void* ID3DXConstantTable::GetBufferPointer() + ID3DXConstantTable::GetBufferPointer +
+ + +

Gets the buffer size of the constant table.

+
+

Returns the size of the buffer, in bytes.

+ + bb205764 + unsigned int ID3DXConstantTable::GetBufferSize() + ID3DXConstantTable::GetBufferSize +
+ + +

Gets a description of the constant table.

+
+

Description of the constant table. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb205769 + HRESULT ID3DXConstantTable::GetDesc([Out] D3DXCONSTANTTABLE_DESC* pDesc) + ID3DXConstantTable::GetDesc +
+ + +

Gets a reference to an array of constant descriptions in the constant table.

+
+

Unique identifier to a constant. See .

+

Returns a reference to an array of descriptions. See .

+

The input supplied must be the maximum size of the array. The output is the number of elements that are filled in the array when the function returns.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

will sometimes return a with a Register_Count of 0. This will happen with a constant appears in more than one Register_Set but does not have space in that register set allocated.

Because a sampler can appear more than once in a constant table, this method can return an array of descriptions, each one with a different register index.

+
+ + Bb205767 + HRESULT ID3DXConstantTable::GetConstantDesc([In] D3DXHANDLE hConstant,[Out, Buffer] D3DXCONSTANT_DESC* pConstantDesc,[InOut] unsigned int* pCount) + ID3DXConstantTable::GetConstantDesc +
+ + +

Returns the sampler index.

+
+

The sampler handle.

+

Returns the sampler index number from the constant table.

+ + bb205770 + unsigned int ID3DXConstantTable::GetSamplerIndex([In] D3DXHANDLE hConstant) + ID3DXConstantTable::GetSamplerIndex +
+ + +

Gets a constant by looking up its index.

+
+

Unique identifier to the parent data structure. If the constant is a top-level parameter (there is no parent data structure), use null.

+

Zero-based index of the constant.

+

Returns a unique identifier to the constant.

+ +

To get a constant from an array of constants, use .

+
+ + bb205765 + D3DXHANDLE ID3DXConstantTable::GetConstant([In] D3DXHANDLE hConstant,[In] unsigned int Index) + ID3DXConstantTable::GetConstant +
+ + +

Gets a constant by looking up its name.

+
+

Unique identifier to the parent data structure. If the constant is a top-level parameter (there is no parent data structure), use null.

+

Name of the constant.

+

Returns a unique identifier to the constant.

+ + bb205766 + D3DXHANDLE ID3DXConstantTable::GetConstantByName([In] D3DXHANDLE hConstant,[In] const char* pName) + ID3DXConstantTable::GetConstantByName +
+ + +

Gets a constant from an array of constants. An array is made up of elements.

+
+

Unique identifier to the array of constants. This value may not be null.

+

Zero-based index of the element in the array.

+

Returns a unique identifier to the element constant.

+ +

To get a constant that is not part of an array, use or .

+
+ + bb205768 + D3DXHANDLE ID3DXConstantTable::GetConstantElement([In] D3DXHANDLE hConstant,[In] unsigned int Index) + ID3DXConstantTable::GetConstantElement +
+ + +

Sets the constants to their default values. The default values are declared in the variable declarations in the shader.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205773 + HRESULT ID3DXConstantTable::SetDefaults([In] IDirect3DDevice9* pDevice) + ID3DXConstantTable::SetDefaults +
+ + +

Sets the contents of the buffer to the constant table.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to a constant. See .

+

Buffer containing data.

+

Size of the buffer, in bytes.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205785 + HRESULT ID3DXConstantTable::SetValue([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const void* pData,[In] unsigned int Bytes) + ID3DXConstantTable::SetValue +
+ + +

Sets a Boolean value.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the constant. See .

+

Boolean value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205771 + HRESULT ID3DXConstantTable::SetBool([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] BOOL b) + ID3DXConstantTable::SetBool +
+ + +

Sets an array of Boolean values.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the array of constants. See .

+

Array of Boolean values.

+

Number of Boolean values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205772 + HRESULT ID3DXConstantTable::SetBoolArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const BOOL* pb,[In] unsigned int Count) + ID3DXConstantTable::SetBoolArray +
+ + +

Sets an integer value.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the constant. See .

+

Integer.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205776 + HRESULT ID3DXConstantTable::SetInt([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] int n) + ID3DXConstantTable::SetInt +
+ + +

Sets an array of integers.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the array of constants. See .

+

Array of integers.

+

Number of integers in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205778 + HRESULT ID3DXConstantTable::SetIntArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const int* pn,[In] unsigned int Count) + ID3DXConstantTable::SetIntArray +
+ + +

Sets a floating-point number.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the constant. See .

+

Floating-point number.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205774 + HRESULT ID3DXConstantTable::SetFloat([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] float f) + ID3DXConstantTable::SetFloat +
+ + +

Sets an array of floating-point numbers.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the array of constants. See .

+

Array of floating-point numbers.

+

Number of floating-point values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205775 + HRESULT ID3DXConstantTable::SetFloatArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const float* pf,[In] unsigned int Count) + ID3DXConstantTable::SetFloatArray +
+ + +

Sets a 4D vector.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the vector constant. See .

+

Pointer to a 4D vector.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205786 + HRESULT ID3DXConstantTable::SetVector([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const D3DXVECTOR4* pVector) + ID3DXConstantTable::SetVector +
+ + +

Sets an array of 4D vectors.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the array of vector constants. See .

+

Array of 4D vectors.

+

Number of vectors in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205787 + HRESULT ID3DXConstantTable::SetVectorArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const D3DXVECTOR4* pVector,[In] unsigned int Count) + ID3DXConstantTable::SetVectorArray +
+ + +

Sets a nontransposed matrix.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the matrix of constants. See .

+

Pointer to a nontransposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205779 + HRESULT ID3DXConstantTable::SetMatrix([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix) + ID3DXConstantTable::SetMatrix +
+ + +

Sets an array of nontransposed matrices.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the array of constant matrices. See .

+

Array of nontransposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205780 + HRESULT ID3DXConstantTable::SetMatrixArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXConstantTable::SetMatrixArray +
+ + +

Sets an array of references to nontransposed matrices.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to an array of constant matrices. See .

+

Array of references to nontransposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A nontransposed matrix contains row-major data; that is, each vector is contained in a row.

+
+ + bb205781 + HRESULT ID3DXConstantTable::SetMatrixPointerArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXConstantTable::SetMatrixPointerArray +
+ + +

Sets a transposed matrix.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the matrix of constants. See .

+

Pointer to a transposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205782 + HRESULT ID3DXConstantTable::SetMatrixTranspose([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix) + ID3DXConstantTable::SetMatrixTranspose +
+ + +

Sets an array of transposed matrices.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the array of matrix constants. See .

+

Array of transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205783 + HRESULT ID3DXConstantTable::SetMatrixTransposeArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In, Buffer] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXConstantTable::SetMatrixTransposeArray +
+ + +

Sets an array of references to transposed matrices.

+
+

Pointer to an interface, representing the device associated with the constant table.

+

Unique identifier to the array of matrix constants. See .

+

Array of references to transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

+
+ + bb205784 + HRESULT ID3DXConstantTable::SetMatrixTransposePointerArray([In] IDirect3DDevice9* pDevice,[In] D3DXHANDLE hConstant,[In] const D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXConstantTable::SetMatrixTransposePointerArray +
+ + + Gets the buffer. + + + + +

Gets a reference to the buffer that contains the constant table.

+
+ + bb205763 + GetBufferPointer + GetBufferPointer + void* ID3DXConstantTable::GetBufferPointer() +
+ + +

Gets the buffer size of the constant table.

+
+ + bb205764 + GetBufferSize + GetBufferSize + unsigned int ID3DXConstantTable::GetBufferSize() +
+ + +

Gets a description of the constant table.

+
+ + bb205769 + GetDesc + GetDesc + HRESULT ID3DXConstantTable::GetDesc([Out] D3DXCONSTANTTABLE_DESC* pDesc) +
+ + + A collection of . + + + + + Adapter information. + + + + + Gets the capabilities of this adapter. + + The type. + The capabilities + + + + Gets the display modes supported by this adapter. + + The filter. + + The display modes supported by this adapter. + + + + + Gets the adapter ordinal. + + + + + Gets the current display mode. + + + + + Gets the details. + + + + + Gets the monitor. + + + + +

Information about the properties of a display mode.

+
+ +

This structure is used in various methods to create and manage Direct3D 9Ex devices () and swapchains ().

+
+ + bb172549 + D3DDISPLAYMODEEX + D3DDISPLAYMODEEX +
+ + + Initializes a new instance of the class. + + + + +

The size of this structure. This should always be set to sizeof().

+
+ + bb172549 + unsigned int Size + unsigned int Size +
+ + +

Width of the display mode.

+
+ + bb172549 + unsigned int Width + unsigned int Width +
+ + +

Height of the display mode.

+
+ + bb172549 + unsigned int Height + unsigned int Height +
+ + +

Refresh rate of the display mode.

+
+ + bb172549 + unsigned int RefreshRate + unsigned int RefreshRate +
+ + +

Format of the display mode. See .

+
+ + bb172549 + D3DFORMAT Format + D3DFORMAT Format +
+ + +

Indicates whether the scanline order is progressive or interlaced. See .

+
+ + bb172549 + D3DSCANLINEORDERING ScanLineOrdering + D3DSCANLINEORDERING ScanLineOrdering +
+ + + Gets the aspect ratio. + + + + +

Describes the display mode.

+
+ + bb172548 + D3DDISPLAYMODE + D3DDISPLAYMODE +
+ + +

Screen width, in pixels.

+
+ + bb172548 + unsigned int Width + unsigned int Width +
+ + +

Screen height, in pixels.

+
+ + bb172548 + unsigned int Height + unsigned int Height +
+ + +

Refresh rate. The value of 0 indicates an adapter default.

+
+ + bb172548 + unsigned int RefreshRate + unsigned int RefreshRate +
+ + +

Member of the enumerated type, describing the surface format of the display mode.

+
+ + bb172548 + D3DFORMAT Format + D3DFORMAT Format +
+ + + Gets the aspect ratio. + + + + + A collection of + + + + +

Applications use the methods of the interface to manipulate a cube texture resource.

+
+ +

The interface can be obtained by calling the method or one of the xxx functions.

This interface inherits additional functionality from the interface.

This interface, like all COM interfaces, inherits additional functionality from the interface.

The LPDIRECT3DCUBETEXTURE9 and PDIRECT3DCubeTexture9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DCUBETEXTURE9, *PDIRECT3DCubeTexture9;	
+            
+
+ + bb174329 + IDirect3DCubeTexture9 + IDirect3DCubeTexture9 +
+ + + Initializes a new instance of the class. + + The device. + Length of the edge. + The level count. + The usage. + The format. + The pool. + + + + Initializes a new instance of the class. + + The device. + Length of the edge. + The level count. + The usage. + The format. + The pool. + The shared handle. + + + + Checks texture-creation parameters. + + Device associated with the texture. + Requested size of the texture. Null if + Requested number of mipmap levels for the texture. + The requested usage for the texture. + Requested format for the texture. + Memory class where the resource will be placed. + A value type containing the proposed values to pass to the texture creation functions. + HRESULT D3DXCheckCubeTextureRequirements([In] IDirect3DDevice9* pDevice,[InOut] unsigned int* pSize,[InOut] unsigned int* pNumMipLevels,[In] unsigned int Usage,[InOut] D3DFORMAT* pFormat,[In] D3DPOOL Pool) + + + + Uses a user-provided function to fill each texel of each mip level of a given cube texture. + + A function that is used to fill the texture. + A object describing the result of the operation. + + + + Uses a compiled high-level shader language (HLSL) function to fill each texel of each mipmap level of a texture. + + A texture shader object that is used to fill the texture. + A object describing the result of the operation. + + + + Locks a rectangle on a cube texture resource. + + Type of the face. + The level. + The flags. + + A describing the region locked. + + HRESULT IDirect3DCubeTexture9::LockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[In] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a cube texture resource. + + Type of the face. + The level. + The flags. + The stream pointing to the locked region. + + A describing the region locked. + + HRESULT IDirect3DCubeTexture9::LockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[In] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a cube texture resource. + + Type of the face. + The level. + The rectangle. + The flags. + + A describing the region locked. + + HRESULT IDirect3DCubeTexture9::LockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[In] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a cube texture resource. + + Type of the face. + The level. + The rectangle. + The flags. + The stream pointing to the locked region. + + A describing the region locked. + + HRESULT IDirect3DCubeTexture9::LockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[In] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Adds a dirty region to a cube texture resource. + + Type of the face. + A object describing the result of the operation. + HRESULT IDirect3DCubeTexture9::AddDirtyRect([In] D3DCUBEMAP_FACES FaceType,[In] const void* pDirtyRect) + + + + Adds a dirty region to a cube texture resource. + + Type of the face. + The dirty rect ref. + A object describing the result of the operation. + HRESULT IDirect3DCubeTexture9::AddDirtyRect([In] D3DCUBEMAP_FACES FaceType,[In] const void* pDirtyRect) + + + + Creates a from a file + + The device. + The filename. + + A + + HRESULT D3DXCreateCubeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a file + + The device. + The filename. + The usage. + The pool. + + A + + HRESULT D3DXCreateCubeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a file + + The device. + The filename. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateCubeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a file + + The device. + The filename. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateCubeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a file + + The device. + The filename. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateCubeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The usage. + The pool. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The stream. + A + HRESULT D3DXCreateCubeTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The usage. + The pool. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + A + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + The pointer. + The size in bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Creates a from a stream. + + The device. + Name of the file. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves a description of one face of the specified cube texture level.

+
+

Specifies a level of a mipmapped cube texture.

+

Pointer to a structure, describing one face of the specified cube texture level.

+ +

The structure contains Width and Height members, which describe the size of one face in the cube. To get the size of the entire cube, multiply six (the number of cube faces) by the product of Width and Height.

+
+ + bb174332 + HRESULT IDirect3DCubeTexture9::GetLevelDesc([In] unsigned int Level,[Out] D3DSURFACE_DESC* pDesc) + IDirect3DCubeTexture9::GetLevelDesc +
+ + +

Retrieves a cube texture map surface.

+
+

Member of the enumerated type, identifying a cube map face.

+

Specifies a level of a mipmapped cube texture.

+

Address of a reference to an interface, representing the returned cube texture map surface.

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174331 + HRESULT IDirect3DCubeTexture9::GetCubeMapSurface([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[Out] IDirect3DSurface9** ppCubeMapSurface) + IDirect3DCubeTexture9::GetCubeMapSurface +
+ + +

Locks a rectangle on a cube texture resource.

+
+

Member of the enumerated type, identifying a cube map face.

+

Specifies a level of a mipmapped cube texture.

+

Pointer to a structure, describing the region to lock.

+

Pointer to a rectangle to lock. Specified by a reference to a structure. Specifying null for this parameter expands the dirty region to cover the entire cube texture.

+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

You may not specify a subrect when using . For a description of the flags, see .

+

If the method succeeds, the return value is . is returned if one or more of the arguments is invalid.

+ +

For performance reasons, dirty regions are only recorded for level zero of a texture. Dirty regions are automatically recorded when is called without or . See for more information.

Cube textures created with are not lockable. Cube textures created in video memory are lockable when created with USAGE_DYNAMIC.

The only lockable format for a depth-stencil texture is .

+
+ + bb174334 + HRESULT IDirect3DCubeTexture9::LockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + IDirect3DCubeTexture9::LockRect +
+ + +

Unlocks a rectangle on a cube texture resource.

+
+

Member of the enumerated type, identifying a cube map face.

+

Specifies a level of a mipmapped cube texture.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ + bb174335 + HRESULT IDirect3DCubeTexture9::UnlockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level) + IDirect3DCubeTexture9::UnlockRect +
+ + +

Adds a dirty region to a cube texture resource.

+
+

Member of the enumerated type, identifying the cube map face.

+

Pointer to a structure, specifying the dirty region. Specifying null expands the dirty region to cover the entire cube texture.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ +

For performance reasons, dirty regions are only recorded for level zero of a texture. For sublevels, it is assumed that the corresponding (scaled) rectangle or box is also dirty. Dirty regions are automatically recorded when is called without or . The destination surface of is also marked dirty automatically.

Using and explicitly specifying dirty regions can be used to increase the efficiency of . Using this method, applications can optimize what subset of a resource is copied by specifying dirty regions on the resource. However, the dirty regions may be expanded to optimize alignment.

+
+ + bb174330 + HRESULT IDirect3DCubeTexture9::AddDirtyRect([In] D3DCUBEMAP_FACES FaceType,[In] const void* pDirtyRect) + IDirect3DCubeTexture9::AddDirtyRect +
+ + + A Cube Texture requirement. + + + + + The corrected size of the texture, in pixels. + + + + + The corrected surface format. + + + + + The corrected mip level count. + + + + + D3DX constants and methods + + + + + The value used to signify that the default value for a parameter should be used. + + D3DX_DEFAULT + + + + The default value for non power-of-two textures. + + D3DX_DEFAULT_NONPOW2 + + + + Indicates that the method should format from file. + + D3DFMT_FROM_FILE + + + + Indicates that the method should load from file. + + D3DX_FROM_FILE + + + + Checks the D3DX runtime version against this compiled version. + + True if version are compatible + BOOL D3DXCheckVersion([In] unsigned int D3DSdkVersion,[In] unsigned int D3DXSdkVersion) + + + + Get and set debug mute mode. + + if set to true [mute]. + Return the debug mute mode + BOOL D3DXDebugMute([In] BOOL Mute) + + + + Converts a declarator from a flexible vertex format (FVF) code. + + Combination of that describes the FVF from which to generate the returned declarator array.. + + A declarator from a flexible vertex format (FVF) code. + + HRESULT D3DXDeclaratorFromFVF([In] D3DFVF FVF,[In, Buffer] D3DVERTEXELEMENT9* pDeclarator) + + + + Converts a flexible vertex format (FVF) code from a declarator. + + The declarator array. + A that describes the vertex format returned from the declarator. + HRESULT D3DXFVFFromDeclarator([In, Buffer] const D3DVERTEXELEMENT9* pDeclarator,[Out] D3DFVF* pFVF) + + + + Generates an output vertex declaration from the input declaration. The output declaration is intended for use by the mesh tessellation functions. + + The input declaration. + The output declaration + HRESULT D3DXGenerateOutputDecl([In, Buffer] D3DVERTEXELEMENT9* pOutput,[In, Buffer] const D3DVERTEXELEMENT9* pInput) + + + + Gets the number of elements in the vertex declaration. + + The declaration. + The number of elements in the vertex declaration. + unsigned int D3DXGetDeclLength([In, Buffer] const D3DVERTEXELEMENT9* pDecl) + + + + Gets the size of a vertex from the vertex declaration. + + The elements. + The stream. + The vertex declaration size, in bytes. + unsigned int D3DXGetDeclVertexSize([In, Buffer] const D3DVERTEXELEMENT9* pDecl,[In] unsigned int Stream) + + + + Returns the size of a vertex for a flexible vertex format (FVF). + + The vertex format. + The FVF vertex size, in bytes. + unsigned int D3DXGetFVFVertexSize([In] D3DFVF FVF) + + + + Gets the size of the rectangle patch. + + The segment count. + The triangle count. + The vertex count. + A object describing the result of the operation. + HRESULT D3DXRectPatchSize([In] const float* pfNumSegs,[In] unsigned int* pdwTriangles,[In] unsigned int* pdwVertices) + + + + Gets the size of the triangle patch. + + The segment count. + The triangle count. + The vertex count. + A object describing the result of the operation. + HRESULT D3DXTriPatchSize([In] const float* pfNumSegs,[In] unsigned int* pdwTriangles,[In] unsigned int* pdwVertices) + + + + Gets an array of from a . + + The stream. + The vertex count. + The format. + An array of + + + + Gets an array of from a . + + The stream. + The vertex count. + The stride. + An array of + + + + Creates a FOURCC Format code from bytes description. + + The c1. + The c2. + The c3. + The c4. + A Format FourCC + MAKEFOURCC + + + + Generates an optimized face remapping for a triangle list. + + The indices. + The face count. + The vertex count. + The original mesh face that was split to generate the current face. + HRESULT D3DXOptimizeFaces([In] const void* pbIndices,[In] unsigned int cFaces,[In] unsigned int cVertices,[In] BOOL b32BitIndices,[In, Buffer] int* pFaceRemap) + + + + Generates an optimized vertex remapping for a triangle list. This function is commonly used after applying the face remapping generated by D3DXOptimizeFaces. + + The indices. + The face count. + The vertex count. + The original mesh face that was split to generate the current face. + HRESULT D3DXOptimizeFaces([In] const void* pbIndices,[In] unsigned int cFaces,[In] unsigned int cVertices,[In] BOOL b32BitIndices,[In, Buffer] int* pFaceRemap) + + + + Generates an optimized vertex remapping for a triangle list. This function is commonly used after applying the face remapping generated by . + + The indices. + The face count. + The vertex count. + A buffer that will contain the new index for each vertex. The value stored in pVertexRemap for a given element is the source vertex location in the new vertex ordering. + HRESULT D3DXOptimizeVertices([In] const void* pbIndices,[In] unsigned int cFaces,[In] unsigned int cVertices,[In] BOOL b32BitIndices,[In, Buffer] int* pVertexRemap) + + + + Generates an optimized vertex remapping for a triangle list. This function is commonly used after applying the face remapping generated by . + + The indices. + The face count. + The vertex count. + A buffer that will contain the new index for each vertex. The value stored in pVertexRemap for a given element is the source vertex location in the new vertex ordering. + HRESULT D3DXOptimizeVertices([In] const void* pbIndices,[In] unsigned int cFaces,[In] unsigned int cVertices,[In] BOOL b32BitIndices,[In, Buffer] int* pVertexRemap) + + + +

Applications use the methods of the interface to perform DrawPrimitive-based rendering, create resources, work with system-level variables, adjust gamma ramp levels, work with palettes, and create shaders.

+
+ +

The interface is obtained by calling the method.

This interface, like all COM interfaces, inherits the interface methods.

The LPDIRECT3DDEVICE9 and PDIRECT3DDEVICE9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DDEVICE9, *PDIRECT3DDEVICE9;	
+            
+
+ + bb174336 + IDirect3DDevice9 + IDirect3DDevice9 +
+ + + Creates a device to represent the display adapter. + + + This method returns a fully working device interface, set to the required display mode (or windowed), and allocated with the appropriate back buffers. To begin rendering, the application needs only to create and set a depth buffer (assuming EnableAutoDepthStencil is FALSE in ). When you create a Direct3D device, you supply two different window parameters: a focus window (hFocusWindow) and a device window (the hDeviceWindow in ). The purpose of each window is: The focus window alerts Direct3D when an application switches from foreground mode to background mode (via Alt-Tab, a mouse click, or some other method). A single focus window is shared by each device created by an application. The device window determines the location and size of the back buffer on screen. This is used by Direct3D when the back buffer contents are copied to the front buffer during {{Present}}. This method should not be run during the handling of WM_CREATE. An application should never pass a window handle to Direct3D while handling WM_CREATE. Any call to create, release, or reset the device must be done using the same thread as the window procedure of the focus window. Note that D3DCREATE_HARDWARE_VERTEXPROCESSING, D3DCREATE_MIXED_VERTEXPROCESSING, and D3DCREATE_SOFTWARE_VERTEXPROCESSING are mutually exclusive flags, and at least one of these vertex processing flags must be specified when calling this method. Back buffers created as part of the device are only lockable if D3DPRESENTFLAG_LOCKABLE_BACKBUFFER is specified in the presentation parameters. (Multisampled back buffers and depth surfaces are never lockable.) The methods {{Reset}}, , and {{TestCooperativeLevel}} must be called from the same thread that used this method to create a device. D3DFMT_UNKNOWN can be specified for the windowed mode back buffer format when calling CreateDevice, {{Reset}}, and {{CreateAdditionalSwapChain}}. This means the application does not have to query the current desktop format before calling CreateDevice for windowed mode. For full-screen mode, the back buffer format must be specified. If you attempt to create a device on a 0x0 sized window, CreateDevice will fail. + + an instance of + Ordinal number that denotes the display adapter. {{D3DADAPTER_DEFAULT}} is always the primary display adapter. + Member of the enumerated type that denotes the desired device type. If the desired device type is not available, the method will fail. + The focus window alerts Direct3D when an application switches from foreground mode to background mode. See Remarks. For full-screen mode, the window specified must be a top-level window. For windowed mode, this parameter may be NULL only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-NULL value. + Combination of one or more options that control device creation. For more information, see {{D3DCREATE}}. + Pointer to a structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies {{D3DCREATE_ADAPTERGROUP_DEVICE}}, pPresentationParameters is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created. For Windows 2000 and Windows XP, the full-screen device display refresh rate is set in the following order: User-specified nonzero ForcedRefreshRate registry key, if supported by the device. Application-specified nonzero refresh rate value in the presentation parameter. Refresh rate of the latest desktop mode, if supported by the device. 75 hertz if supported by the device. 60 hertz if supported by the device. Device default. An unsupported refresh rate will default to the closest supported refresh rate below it. For example, if the application specifies 63 hertz, 60 hertz will be used. There are no supported refresh rates below 57 hertz. pPresentationParameters is both an input and an output parameter. Calling this method may change several members including: If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns. If BackBufferFormat equals before the method is called, it will be changed when the method returns. + Address of a pointer to the returned interface, which represents the created device. + If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_DEVICELOST, D3DERR_INVALIDCALL, D3DERR_NOTAVAILABLE, D3DERR_OUTOFVIDEOMEMORY. + HRESULT CreateDevice([None] UINT Adapter,[None] D3DDEVTYPE DeviceType,[None] HWND hFocusWindow,[None] int BehaviorFlags,[None] D3DPRESENT_PARAMETERS* pPresentationParameters,[None] IDirect3DDevice9** ppReturnedDeviceInterface) + + + + Clears one or more surfaces such as a render target, a stencil buffer, and a depth buffer. + + Flags that specify which surfaces will be cleared. + The color that will be used to fill the cleared render target. + The value that will be used to fill the cleared depth buffer. + The value that will be used to fill the cleared stencil buffer. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::Clear([None] int Count,[In, Buffer, Optional] const D3DRECT* pRects,[None] int Flags,[None] D3DCOLOR Color,[None] float Z,[None] int Stencil) + + + + Clears one or more surfaces such as a render target, a stencil buffer, and a depth buffer. + + Flags that specify which surfaces will be cleared. + The color that will be used to fill the cleared render target. + The value that will be used to fill the cleared depth buffer. + The value that will be used to fill the cleared stencil buffer. + The areas on the surfaces that will be cleared. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::Clear([None] int Count,[In, Buffer, Optional] const D3DRECT* pRects,[None] int Flags,[None] D3DCOLOR Color,[None] float Z,[None] int Stencil) + + + + Allows an application to fill a rectangular area of a D3DPOOL_DEFAULT surface with a specified color. + + + This method can only be applied to a render target, a render-target texture surface, or an off-screen plain surface with a pool type of D3DPOOL_DEFAULT. IDirect3DDevice9::ColorFill will work with all formats. However, when using a reference or software device, the only formats supported are D3DFMT_X1R5G5B5, D3DFMT_A1R5G5B5, D3DFMT_R5G6B5, D3DFMT_X8R8G8B8, D3DFMT_A8R8G8B8, D3DFMT_YUY2, D3DFMT_G8R8_G8B8, D3DFMT_UYVY, D3DFMT_R8G8_B8G8, D3DFMT_R16F, D3DFMT_G16R16F, D3DFMT_A16B16G16R16F, D3DFMT_R32F, D3DFMT_G32R32F, and D3DFMT_A32B32G32R32F. When using a DirectX 7 or DirectX 8.x driver, the only YUV formats supported are D3DFMT_UYVY and D3DFMT_YUY2. + + Pointer to the surface to be filled. + Color used for filling. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::ColorFill([None] IDirect3DSurface9* pSurface,[In, Optional] const RECT* pRect,[None] D3DCOLOR color) + + + + Draws the indexed user primitives. + + + + Type of the primitive. + Minimum index of the vertex. + The vertex count. + The primitive count. + The index data. + The index data format. + The vertex data. + The vertex stride. + A object describing the result of the operation. + + + + Draws the indexed user primitives. + + + + Type of the primitive. + The start index. + Minimum index of the vertex. + The vertex count. + The primitive count. + The index data. + The index data format. + The vertex data. + The vertex stride. + A object describing the result of the operation. + + + + Draws the indexed user primitives. + + + + Type of the primitive. + The start index. + The start vertex. + Minimum index of the vertex. + The vertex count. + The primitive count. + The index data. + The index data format. + The vertex data. + The vertex stride. + A object describing the result of the operation. + + + + Draws the rectangle patch. + + The handle. + The segment counts. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::DrawRectPatch([In] unsigned int Handle,[In, Buffer] const float* pNumSegs,[In] const void* pRectPatchInfo) + + + + Draws the rectangle patch. + + The handle. + The segment counts. + The info. + + A object describing the result of the operation. + + IDirect3DDevice9::DrawRectPatch + + + + Draws the triangle patch. + + The handle. + The segment counts. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::DrawTriPatch([In] unsigned int Handle,[In, Buffer] const float* pNumSegs,[In] const void* pTriPatchInfo) + + + + Draws the triangle patch. + + The handle. + The segment counts. + The info. + + A object describing the result of the operation. + + + + + Draws the user primitives. + + + Type of the primitive. + The primitive count. + The data. + + A object describing the result of the operation. + + + + + Draws the user primitives. + + + Type of the primitive. + The start index. + The primitive count. + The data. + + A object describing the result of the operation. + + + + + Gets the back buffer. + + The swap chain. + The back buffer. + A object describing the result of the operation. + + + + Gets the palette entries. + + The palette number. + An array of + + + + Gets the pixel shader boolean constant. + + The start register. + The count. + An array of boolean constants + + + + Gets the pixel shader float constant. + + The start register. + The count. + An array of float constants + + + + Gets the pixel shader integer constant. + + The start register. + The count. + An array of int constants + + + + Gets the state of the render. + + The state. + The render state value + HRESULT IDirect3DDevice9::GetRenderState([In] D3DRENDERSTATETYPE State,[In] void* pValue) + + + + Gets the state of the render. + + Type of the state value. + The state. + + The render state value + + HRESULT IDirect3DDevice9::GetRenderState([In] D3DRENDERSTATETYPE State,[In] void* pValue) + + + + Gets the state of the sampler. + + The sampler. + The state. + + The sampler state value + + HRESULT IDirect3DDevice9::GetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] void* pValue) + + + + Gets the state of the sampler. + + Type of the sampler statet value + The sampler. + The state. + + The sampler state value + + HRESULT IDirect3DDevice9::GetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] void* pValue) + + + + Gets the state of the texture stage. + + The stage. + The type. + + The texture stage state. + + HRESULT IDirect3DDevice9::GetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] void* pValue) + + + + Gets the state of the texture stage. + + Type of the texture stage state + The stage. + The type. + + The texture stage state. + + HRESULT IDirect3DDevice9::GetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] void* pValue) + + + + Gets the vertex shader boolean constant. + + The start register. + The count. + An array of boolean constants + HRESULT IDirect3DDevice9::GetVertexShaderConstantB([In] unsigned int StartRegister,[In] void* pConstantData,[In] unsigned int BoolCount) + + + + Gets the vertex shader float constant. + + The start register. + The count. + An array of float constants + HRESULT IDirect3DDevice9::GetVertexShaderConstantF([In] unsigned int StartRegister,[In, Buffer] float* pConstantData,[In] unsigned int Vector4fCount) + + + + Gets the vertex shader integer constant. + + The start register. + The count. + An array of int constants + HRESULT IDirect3DDevice9::GetVertexShaderConstantI([In] unsigned int StartRegister,[Out] int* pConstantData,[In] unsigned int Vector4iCount) + + + + Sets the cursor position. + + The point. + if set to true [flags]. + void IDirect3DDevice9::SetCursorPosition([In] int X,[In] int Y,[In] unsigned int Flags) + + + + Sets the cursor position. + + The x. + The y. + if set to true [flags]. + void IDirect3DDevice9::SetCursorPosition([In] int X,[In] int Y,[In] unsigned int Flags) + + + + Sets the cursor properties. + + The point. + The cursor bitmap ref. + + HRESULT IDirect3DDevice9::SetCursorProperties([In] unsigned int XHotSpot,[In] unsigned int YHotSpot,[In] IDirect3DSurface9* pCursorBitmap) + + + + Sets the gamma ramp. + + The swap chain. + The ramp ref. + if set to true [calibrate]. + void IDirect3DDevice9::SetGammaRamp([In] unsigned int iSwapChain,[In] unsigned int Flags,[In] const D3DGAMMARAMP* pRamp) + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + A object describing the result of the operation. + IDirect3DDevice9::Present + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + The area of the back buffer that should be presented. + The area of the front buffer that should receive the result of the presentation. + A object describing the result of the operation. + IDirect3DDevice9::Present + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + The area of the back buffer that should be presented. + The area of the front buffer that should receive the result of the presentation. + The destination window whose client area is taken as the target for this presentation. + A object describing the result of the operation. + IDirect3DDevice9::Present + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + The area of the back buffer that should be presented. + The area of the front buffer that should receive the result of the presentation. + The destination window whose client area is taken as the target for this presentation. + Specifies a region on the back buffer that contains the minimal amount of pixels that need to be updated. + A object describing the result of the operation. + IDirect3DDevice9::Present + + + + Resets the stream source frequency by setting the frequency to 1. + + The stream index. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetStreamSourceFreq([In] unsigned int StreamNumber,[In] unsigned int Setting) + + + + Sets the pixel shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantB([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int BoolCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantI([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4iCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + The count. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + The offset. + The count. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetPixelShaderConstantB([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int BoolCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetPixelShaderConstantI([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4iCount) + + + + Sets the pixel shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the RenderState. + + State of the render. + if set to true [enable]. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetRenderState([In] D3DRENDERSTATETYPE State,[In] unsigned int Value) + + + + Sets the RenderState. + + State of the render. + A float value. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetRenderState([In] D3DRENDERSTATETYPE State,[In] unsigned int Value) + + + + Sets the RenderState. + + Type of the enum value + State of the render. + An enum value. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetRenderState([In] D3DRENDERSTATETYPE State,[In] unsigned int Value) + + + + Sets the SamplerState. + + The sampler. + The type. + The texture filter. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] unsigned int Value) + + + + Sets the SamplerState. + + The sampler. + The type. + The texture address. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] unsigned int Value) + + + + Sets the SamplerState. + + The sampler. + The type. + A float value. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] unsigned int Value) + + + + Sets the stream source frequency. + + The stream. + The frequency. + The source. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetStreamSourceFreq([In] unsigned int StreamNumber,[In] unsigned int Setting) + + + + Sets the state of the texture stage. + + The stage. + The type. + The texture argument. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] unsigned int Value) + + + + Sets the state of the texture stage. + + The stage. + The type. + The texture operation. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] unsigned int Value) + + + + Sets the state of the texture stage. + + The stage. + The type. + The texture transform. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] unsigned int Value) + + + + Sets the state of the texture stage. + + The stage. + The type. + The value. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] unsigned int Value) + + + + Sets the transform. + + The state. + The matrix ref. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetTransform([In] D3DTRANSFORMSTATETYPE State,[In] const D3DMATRIX* pMatrix) + + + + Sets the transform. + + The index. + The matrix ref. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetTransform([In] D3DTRANSFORMSTATETYPE State,[In] const D3DMATRIX* pMatrix) + + + + Sets the transform. + + The state. + The matrix ref. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetTransform([In] D3DTRANSFORMSTATETYPE State,[In] const D3DMATRIX* pMatrix) + + + + Sets the transform. + + The index. + The matrix ref. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetTransform([In] D3DTRANSFORMSTATETYPE State,[In] const D3DMATRIX* pMatrix) + + + + Sets the vertex shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantB([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int BoolCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantI([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4iCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + The count. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + The offset. + The count. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetVertexShaderConstantB([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int BoolCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetVertexShaderConstantI([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4iCount) + + + + Sets the vertex shader constant. + + The start register. + The data. + The offset. + The count. + A object describing the result of the operation. + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + + + + Stretches the rectangle. + + The source surface ref. + The dest surface ref. + The filter. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::StretchRect([In] IDirect3DSurface9* pSourceSurface,[In, Optional] const RECT* pSourceRect,[In] IDirect3DSurface9* pDestSurface,[In, Optional] const RECT* pDestRect,[In] D3DTEXTUREFILTERTYPE Filter) + + + + Updates the surface. + + The source surface ref. + The destination surface ref. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9::UpdateSurface([In] IDirect3DSurface9* pSourceSurface,[In] const RECT* pSourceRect,[In] IDirect3DSurface9* pDestinationSurface,[In] const POINT* pDestPoint) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Reports the current cooperative-level status of the Direct3D device for a windowed or full-screen application.

+
+

If the method succeeds, the return value is , indicating that the device is operational and the calling application can continue. If the method fails, the return value can be one of the following values: , , .

+ +

If the device is lost but cannot be restored at the current time, returns the return code. This would be the case, for example, when a full-screen device has lost focus. If an application detects a lost device, it should pause and periodically call until it receives a return value of . The application may then attempt to reset the device by calling and, if this succeeds, restore the necessary resources and resume normal operation. Note that will return if the device is either "lost" or "not reset".

A call to will fail if called on a different thread than that used to create the device being reset.

+
+ + bb174472 + HRESULT IDirect3DDevice9::TestCooperativeLevel() + IDirect3DDevice9::TestCooperativeLevel +
+ + +

Returns an estimate of the amount of available texture memory.

+
+

The function returns an estimate of the available texture memory.

+ +

The returned value is rounded to the nearest MB. This is done to reflect the fact that video memory estimates are never precise due to alignment and other issues that affect consumption by certain resources. Applications can use this value to make gross estimates of memory availability to make large-scale resource decisions such as how many levels of a mipmap to attempt to allocate, but applications cannot use this value to make small-scale decisions such as if there is enough memory left to allocate another resource.

+
+ + bb174378 + unsigned int IDirect3DDevice9::GetAvailableTextureMem() + IDirect3DDevice9::GetAvailableTextureMem +
+ + +

Evicts all managed resources, including both Direct3D and driver-managed resources.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be , D3DERR_COMMAND_UNPARSED.

+ +

This function causes only the copy of resources to be evicted. The resource copy in system memory is retained. See .

+
+ + bb174377 + HRESULT IDirect3DDevice9::EvictManagedResources() + IDirect3DDevice9::EvictManagedResources +
+ + +

Returns an interface to the instance of the Direct3D object that created the device.

+
+

Address of a reference to an interface, representing the interface of the Direct3D object that created the device.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Calling will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174386 + HRESULT IDirect3DDevice9::GetDirect3D([Out] IDirect3D9** ppD3D9) + IDirect3DDevice9::GetDirect3D +
+ + +

Retrieves the capabilities of the rendering device.

+
+

Pointer to a structure, describing the returned device.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

retrieves the software vertex pipeline capabilities when the device is being used in software vertex processing mode.

+
+ + bb174385 + HRESULT IDirect3DDevice9::GetDeviceCaps([Out] D3DCAPS9* pCaps) + IDirect3DDevice9::GetDeviceCaps +
+ + +

Retrieves the display mode's spatial resolution, color resolution, and refresh frequency.

+
+

An unsigned integer specifying the swap chain.

+

Pointer to a structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode.

+ + bb174387 + HRESULT IDirect3DDevice9::GetDisplayMode([In] unsigned int iSwapChain,[Out] D3DDISPLAYMODE* pMode) + IDirect3DDevice9::GetDisplayMode +
+ + +

Retrieves the creation parameters of the device.

+
+

Pointer to a structure, describing the creation parameters of the device.

+

If the method succeeds, the return value is .

is returned if the argument is invalid.

+ +

You can query the AdapterOrdinal member of the returned structure to retrieve the ordinal of the adapter represented by this device.

+
+ + bb174382 + HRESULT IDirect3DDevice9::GetCreationParameters([Out] D3DDEVICE_CREATION_PARAMETERS* pParameters) + IDirect3DDevice9::GetCreationParameters +
+ + +

Sets properties for the cursor.

+
+

X-coordinate offset (in pixels) that marks the center of the cursor. The offset is relative to the upper-left corner of the cursor. When the cursor is given a new position, the image is drawn at an offset from this new position determined by subtracting the hot spot coordinates from the position.

+

Y-coordinate offset (in pixels) that marks the center of the cursor. The offset is relative to the upper-left corner of the cursor. When the cursor is given a new position, the image is drawn at an offset from this new position determined by subtracting the hot spot coordinates from the position.

+

Pointer to an interface. This parameter must point to an 8888 ARGB surface (format ). The contents of this surface will be copied and potentially format-converted into an internal buffer from which the cursor is displayed. The dimensions of this surface must be less than the dimensions of the display mode, and must be a power of two in each direction, although not necessarily the same power of two. The alpha channel must be either 0.0 or 1.0.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

An operating system cursor is created and used under either of these conditions:

  • The hardware has set (see ), and the cursor size is 32x32 (which is the cursor size in the operating system).
  • The application is running in windowed mode.

Otherwise, DirectX uses an emulated cursor. An application uses to move an emulated cursor to follow mouse movement.

It is recommended for applications to always trap WM_MOUSEMOVE events and call DXSetCursorPosition.

Direct3D cursor functions use either GDI cursor or software emulation, depending on the hardware. Users typically want to respond to a WM_SETCURSOR message. For example, they might want to write the message handler as follows:

 case WM_SETCURSOR:	
+            // Turn off window cursor. 	
+            SetCursor( null );	
+            m_pd3dDevice->ShowCursor( TRUE );	
+            return TRUE; // Prevent Windows from setting cursor to window class cursor.	
+            break;	
+            

Or, users might want to call the method if they want to change the cursor.

The application can determine what hardware support is available for cursors by examining appropriate members of the structure. Typically, hardware supports only 32x32 cursors and, when windowed, the system might support only 32x32 cursors. In this case, still succeeds but the cursor might be reduced to that size. The hot spot is scaled appropriately.

The cursor does not survive when the device is lost. This method must be called after the device is reset.

+
+ + bb174430 + HRESULT IDirect3DDevice9::SetCursorProperties([In] unsigned int XHotSpot,[In] unsigned int YHotSpot,[In] IDirect3DSurface9* pCursorBitmap) + IDirect3DDevice9::SetCursorProperties +
+ + +

Sets the cursor position and update options.

+
+

The new X-position of the cursor in virtual desktop coordinates. See Remarks.

+

The new Y-position of the cursor in virtual desktop coordinates. See Remarks.

+

Specifies the update options for the cursor. Currently, only one flag is defined.

ValueMeaning
D3DCURSOR_IMMEDIATE_UPDATE

Update cursor at the refresh rate.

If this flag is specified, the system guarantees that the cursor will be updated at a minimum of half the display refresh rate, but never more frequently than the display refresh rate. Otherwise, the method delays cursor updates until the next call. Not setting this flag usually results in better performance than if the flag is set. However, applications should set this flag if the rate of calls to Present is low enough that users would notice a significant delay in cursor motion. This flag has no effect in a windowed-mode application. Some video cards implement hardware color cursors. This flag does not have an effect on these cards.

?

+ +

When running in full-screen mode, screen space coordinates are the back buffer coordinates appropriately scaled to the current display mode. When running in windowed mode, screen space coordinates are the desktop coordinates. The cursor image is drawn at the specified position minus the hotspot-offset specified by the SetCursorProperties method.

If the cursor has been hidden by ShowCursor, the cursor is not drawn.

+
+ + bb174429 + void IDirect3DDevice9::SetCursorPosition([In] int X,[In] int Y,[In] unsigned int Flags) + IDirect3DDevice9::SetCursorPosition +
+ + +

Displays or hides the cursor.

+
+

If bShow is TRUE, the cursor is shown. If bShow is , the cursor is hidden.

+

Value indicating whether the cursor was previously visible. TRUE if the cursor was previously visible, or if the cursor was not previously visible.

+ +

Direct3D cursor functions use either GDI cursor or software emulation, depending on the hardware. Users usually want to respond to a WM_SETCURSOR message. For example, the users might want to write the message handler like this:

 case WM_SETCURSOR: // Turn off window cursor  SetCursor( null ); m_pd3dDevice->ShowCursor( TRUE ); return TRUE; // prevent Windows from setting cursor to window class cursor break;	
+            

Or users might want to call the method if they want to change the cursor. See the code in the DirectX Graphics C/C++ Samples for more detail.

+
+ + bb174470 + BOOL IDirect3DDevice9::ShowCursor([In] BOOL bShow) + IDirect3DDevice9::ShowCursor +
+ + +

Creates an additional swap chain for rendering multiple views.

+
+

Pointer to a structure, containing the presentation parameters for the new swap chain. This value cannot be null.

Calling this method changes the value of members of the structure.

  • If BackBufferCount == 0, calling CreateAdditionalSwapChain will increase it to 1.
  • If the application is in windowed mode, and if either the BackBufferWidth or the BackBufferHeight == 0, they will be set to the client area width and height of the hwnd.
+

Address of a reference to an interface, representing the additional swap chain.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , , , E_OUTOFMEMORY.

+ +

There is always at least one swap chain (the implicit swap chain) for each device because Direct3D 9 has one swap chain as a property of the device.

Note that any given device can support only one full-screen swap chain.

can be specified for the windowed mode back buffer format when calling , and CreateAdditionalSwapChain. This means the application does not have to query the current desktop format before calling CreateDevice for windowed mode. For full-screen mode, the back buffer format must be specified.

+
+ + bb174354 + HRESULT IDirect3DDevice9::CreateAdditionalSwapChain([In] D3DPRESENT_PARAMETERS* pPresentationParameters,[Out, Fast] IDirect3DSwapChain9** pSwapChain) + IDirect3DDevice9::CreateAdditionalSwapChain +
+ + +

Gets a reference to a swap chain.

+
+

The swap chain ordinal value. For more information, see NumberOfAdaptersInGroup in .

+

Pointer to an interface that will receive a copy of swap chain.

+ + bb174411 + HRESULT IDirect3DDevice9::GetSwapChain([In] unsigned int iSwapChain,[Out] IDirect3DSwapChain9** pSwapChain) + IDirect3DDevice9::GetSwapChain +
+ + +

Gets the number of implicit swap chains.

+
+

Number of implicit swap chains. See Remarks.

+ +

Implicit swap chains are created by the device during . This method returns the number of swap chains created by CreateDevice.

An application may create additional swap chains using .

+
+ + bb174396 + unsigned int IDirect3DDevice9::GetNumberOfSwapChains() + IDirect3DDevice9::GetNumberOfSwapChains +
+ + +

Resets the type, size, and format of the swap chain.

+
+

Pointer to a structure, describing the new presentation parameters. This value cannot be null.

When switching to full-screen mode, Direct3D will try to find a desktop format that matches the back buffer format, so that back buffer and front buffer formats will be identical (to eliminate the need for color conversion).

When this method returns:

  • BackBufferCount, BackBufferWidth, and BackBufferHeight are set to zero.
  • BackBufferFormat is set to for windowed mode only; a full-screen mode must specify a format.
+

Possible return values include: , , , , or (see D3DERR).

+ +

If a call to fails, the device will be placed in the "lost" state (as indicated by a return value of from a call to ) unless it is already in the "not reset" state (as indicated by a return value of from a call to ). Refer to and Lost Devices (Direct3D 9) for further information concerning the use of in the context of lost devices.

Calling causes all texture memory surfaces to be lost, managed textures to be flushed from video memory, and all state information to be lost. Before calling the method for a device, an application should release any explicit render targets, depth stencil surfaces, additional swap chains, state blocks, and resources associated with the device.

There are two different types of swap chains: full-screen or windowed. If the new swap chain is full-screen, the adapter will be placed in the display mode that matches the new size.

Direct3D 9 applications can expect messages to be sent to them during this call (for example, before this call is returned); applications should take precautions not to call into Direct3D at this time. In addition, when fails, the only valid methods that can be called are , , and the various Release member functions. Calling any other method can result in an exception.

A call to will fail if called on a different thread than that used to create the device being reset.

Pixel shaders and vertex shaders survive calls for Direct3D 9. They do not need to be re-created explicitly by the application.

can be specified for the windowed mode back buffer format when calling , , and . This means the application does not have to query the current desktop format before calling for windowed mode. For full-screen mode, the back buffer format must be specified. Setting BackBufferCount equal to zero (BackBufferCount = 0) results in one back buffer.

When trying to reset more than one display adapter in a group, set pPresentationParameters to point to an array of structures, one for each display in the adapter group.

If a multihead device was created with , requires an array of structures wherein each structure must specify a full-screen display. To switch back to windowed mode, the application must destroy the device and re-create a non-multihead device in windowed mode.

+
+ + bb174425 + HRESULT IDirect3DDevice9::Reset([In, Out, Params] D3DPRESENT_PARAMETERS* pPresentationParameters) + IDirect3DDevice9::Reset +
+ + +

Presents the contents of the next buffer in the sequence of back buffers owned by the device.

+
+

Pointer to a value that must be null unless the swap chain was created with . pSourceRect is a reference to a structure containing the source rectangle. If null, the entire source surface is presented. If the rectangle exceeds the source surface, the rectangle is clipped to the source surface.

+

Pointer to a value that must be null unless the swap chain was created with . pDestRect is a reference to a structure containing the destination rectangle, in window client coordinates. If null, the entire client area is filled. If the rectangle exceeds the destination client area, the rectangle is clipped to the destination client area.

+

Pointer to a destination window whose client area is taken as the target for this presentation. If this value is null, then the hWndDeviceWindow member of is taken.

+

Value must be null unless the swap chain was created with . For more information about swap chains, see Flipping Surfaces (Direct3D 9) and . If this value is non-null, the contained region is expressed in back buffer coordinates. The rectangles within the region are the minimal set of pixels that need to be updated. This method takes these rectangles into account when optimizing the presentation by copying only the pixels within the region, or some suitably expanded set of rectangles. This is an aid to optimization only, and the application should not rely on the region being copied exactly. The implementation can choose to copy the whole source rectangle.

+

Possible return values include: or (see D3DERR).

+ +

If necessary, a stretch operation is applied to transfer the pixels within the source rectangle to the destination rectangle in the client area of the target window.

Present will fail, returning , if called between BeginScene and EndScene pairs unless the render target is not the current render target (such as the back buffer you get from creating an additional swap chain). This is a new behavior for Direct3D 9.

+
+ + bb174423 + HRESULT IDirect3DDevice9::Present([In] const void* pSourceRect,[In] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const void* pDirtyRegion) + IDirect3DDevice9::Present +
+ + +

Retrieves a back buffer from the device's swap chain.

+
+

An unsigned integer specifying the swap chain.

+

Index of the back buffer object to return. Back buffers are numbered from 0 to the total number of back buffers minus one. A value of 0 returns the first back buffer, not the front buffer. The front buffer is not accessible through this method. Use to retrieve a copy of the front buffer.

+

Stereo view is not supported in Direct3D 9, so the only valid value for this parameter is .

+

Address of a reference to an interface, representing the returned back buffer surface.

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174379 + HRESULT IDirect3DDevice9::GetBackBuffer([In] unsigned int iSwapChain,[In] unsigned int iBackBuffer,[In] D3DBACKBUFFER_TYPE Type,[Out] IDirect3DSurface9** ppBackBuffer) + IDirect3DDevice9::GetBackBuffer +
+ + +

Returns information describing the raster of the monitor on which the swap chain is presented.

+
+

An unsigned integer specifying the swap chain.

+

Pointer to a structure filled with information about the position or other status of the raster on the monitor driven by this adapter.

+ + bb174402 + HRESULT IDirect3DDevice9::GetRasterStatus([In] unsigned int iSwapChain,[Out] D3DRASTER_STATUS* pRasterStatus) + IDirect3DDevice9::GetRasterStatus +
+ + +

This method allows the use of GDI dialog boxes in full-screen mode applications.

+
+

TRUE to enable GDI dialog boxes, and to disable them.

+

If the method succeeds, the return value is . If the method fails, the return value can be unless all of the following are true.

  • The application specified a back buffer format compatible with GDI, in other words, one of , , or .
  • The application specified no multisampling.
  • The application specified .
  • The application specified .
  • The application did not specify .
  • The application is not between BeginScene and EndScene.
+ +

The GDI dialog boxes must be created as child to the device window. They should also be created within the same thread that created the device because this enables the parent window to manage redrawing the child window.

The method has no effect for windowed mode applications, but this setting will be respected if the application resets the device into full-screen mode. If SetDialogBoxMode succeeds in a windowed mode application, any subsequent reset to full-screen mode will be checked against the restrictions listed above. Also, SetDialogBoxMode causes all back buffers on the swap chain to be discarded, so an application is expected to refresh its content for all back buffers after this call.

+
+ + bb174432 + HRESULT IDirect3DDevice9::SetDialogBoxMode([In] BOOL bEnableDialogs) + IDirect3DDevice9::SetDialogBoxMode +
+ + +

Sets the gamma correction ramp for the implicit swap chain. This method will affect the entire screen (not just the active window if you are running in windowed mode).

+
+

Unsigned integer specifying the swap chain.

+

Indicates whether correction should be applied. Gamma correction results in a more consistent display, but can incur processing overhead and should not be used frequently. Short-duration effects, such as flashing the whole screen red, should not be calibrated, but long-duration gamma changes should be calibrated. One of the following values can be set:

ItemDescription

D3DSGR_CALIBRATE

If a gamma calibrator is installed, the ramp will be modified before being sent to the device to account for the system and monitor response curves. If a calibrator is not installed, the ramp will be passed directly to the device.

D3DSGR_NO_CALIBRATION

No gamma correction is applied. The supplied gamma table is transferred directly to the device.

?

+

Pointer to a structure, representing the gamma correction ramp to be set for the implicit swap chain.

+ +

There is always at least one swap chain (the implicit swap chain) for each device, because Direct3D 9 has one swap chain as a property of the device. The gamma ramp takes effect immediately; there is no wait for a vertical sync.

If the device does not support gamma ramps in the swap chain's current presentation mode (full-screen or windowed), no error return is given. Applications can check the and capability bits in the Caps2 member of the structure to determine the capabilities of the device and whether a calibrator is installed.

For windowed gamma correction presentation, use if the hardware supports the feature. In DirectX 8, SetGammaRamp will set the gamma ramp only on a full-screen mode application. For more information about gamma correction, see Gamma (Direct3D 9).

+
+ + bb174434 + void IDirect3DDevice9::SetGammaRamp([In] unsigned int iSwapChain,[In] unsigned int Flags,[In] const D3DGAMMARAMP* pRamp) + IDirect3DDevice9::SetGammaRamp +
+ + +

Retrieves the gamma correction ramp for the swap chain.

+
+

An unsigned integer specifying the swap chain.

+ + bb174390 + void IDirect3DDevice9::GetGammaRamp([In] unsigned int iSwapChain,[Out] D3DGAMMARAMP* pRamp) + IDirect3DDevice9::GetGammaRamp +
+ + +

Creates a texture resource.

+
+

Width of the top-level of the texture, in pixels. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0, 1 will be taken instead.

+

Height of the top-level of the texture, in pixels. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0, 1 will be taken instead.

+

Number of levels in the texture. If this is zero, Direct3D will generate all texture sublevels down to 1 by 1 pixels for hardware that supports mipmapped textures. Call to see the number of levels generated.

+

Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more constants. It is good practice to match the usage parameter with the behavior flags in .

+

Member of the enumerated type, describing the format of all levels in the texture.

+

Member of the enumerated type, describing the memory class into which the texture should be placed.

+

Pointer to an interface, representing the created texture resource.

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , E_OUTOFMEMORY.

+ +

An application can discover support for Automatic Generation of Mipmaps (Direct3D 9) in a particular format by calling with . If returns , will succeed but it will return a one-level texture.

In Windows Vista CreateTexture can create a texture from a system memory reference allowing the application more flexibility over the use, allocation and deletion of the system memory. For example, an application could pass a GDI system memory bitmap reference and get a Direct3D texture interface around it. Using a system memory reference with CreateTexture has the following restrictions.

  • The pitch of the texture must be equal to the width multiplied by the number of bytes per pixel.
  • Only textures with a single mipmap level are supported. The Levels argument must be 1.
  • The Pool argument must be .
  • The pSharedHandle argument must be a valid reference to a buffer that can hold the system memory point; *pSharedHandle must be a valid reference to system memory with a size in bytes of texture width * texture height * bytes per pixel of the texture format.
+
+ + bb174363 + HRESULT IDirect3DDevice9::CreateTexture([In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Levels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DTexture9** ppTexture,[In] void** pSharedHandle) + IDirect3DDevice9::CreateTexture +
+ + +

Creates a volume texture resource.

+
+

Width of the top-level of the volume texture, in pixels. This value must be a power of two if the member of is set. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by two results in 0 (zero), 1 will be taken instead. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Height of the top-level of the volume texture, in pixels. This value must be a power of two if the member of is set. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0 (zero), 1 will be taken instead. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Depth of the top-level of the volume texture, in pixels. This value must be a power of two if the member of is set. The pixel dimensions of subsequent levels will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0 (zero), 1 will be taken instead. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Number of levels in the texture. If this is zero, Direct3D will generate all texture sublevels down to 1x1 pixels for hardware that supports mipmapped volume textures. Call to see the number of levels generated.

+

Usage can be 0, which indicates no usage value. If usage is desired, use or . For more information, see .

+

Member of the enumerated type, describing the format of all levels in the volume texture.

+

Member of the enumerated type, describing the memory class into which the volume texture should be placed.

+

Address of a reference to an interface, representing the created volume texture resource.

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , E_OUTOFMEMORY.

+ + bb174367 + HRESULT IDirect3DDevice9::CreateVolumeTexture([In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Depth,[In] unsigned int Levels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DVolumeTexture9** ppVolumeTexture,[In] void** pSharedHandle) + IDirect3DDevice9::CreateVolumeTexture +
+ + +

Creates a cube texture resource.

+
+

Size of the edges of all the top-level faces of the cube texture. The pixel dimensions of subsequent levels of each face will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension clamps at a size of 1 pixel. Thus, if the division by 2 results in 0 (zero), 1 will be taken instead.

+

Number of levels in each face of the cube texture. If this is zero, Direct3D will generate all cube texture sublevels down to 1x1 pixels for each face for hardware that supports mipmapped cube textures. Call to see the number of levels generated.

+

Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more constants. It is good practice to match the usage parameter in CreateCubeTexture with the behavior flags in . For more information, see Remarks.

+

Member of the enumerated type, describing the format of all levels in all faces of the cube texture.

+

Member of the enumerated type, describing the memory class into which the cube texture should be placed.

+

Address of a reference to an interface, representing the created cube texture resource.

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , E_OUTOFMEMORY.

+ +

A mipmap (texture) is a collection of successively downsampled (mipmapped) surfaces. On the other hand, a cube texture (created by ) is a collection of six textures (mipmaps), one for each face. All faces must be present in the cube texture. Also, a cube map surface must be the same pixel size in all three dimensions (x, y, and z).

An application can discover support for Automatic Generation of Mipmaps (Direct3D 9) in a particular format by calling with . If returns , will succeed but it will return a one-level texture.

+
+ + bb174355 + HRESULT IDirect3DDevice9::CreateCubeTexture([In] unsigned int EdgeLength,[In] unsigned int Levels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DCubeTexture9** ppCubeTexture,[In] void** pSharedHandle) + IDirect3DDevice9::CreateCubeTexture +
+ + +

Creates a vertex buffer.

+
+

Size of the vertex buffer, in bytes. For FVF vertex buffers, Length must be large enough to contain at least one vertex, but it need not be a multiple of the vertex size. Length is not validated for non-FVF buffers. See Remarks.

+

Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more constants. It is good practice to match the usage parameter in CreateVertexBuffer with the behavior flags in . For more information, see Remarks.

+

Combination of , a usage specifier that describes the vertex format of the vertices in this buffer. If this parameter is set to a valid FVF code, the created vertex buffer is an FVF vertex buffer (see Remarks). Otherwise, if this parameter is set to zero, the vertex buffer is a non-FVF vertex buffer.

+

Member of the enumerated type, describing a valid memory class into which to place the resource. Do not set to .

+

Address of a reference to an interface, representing the created vertex buffer resource.

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , E_OUTOFMEMORY.

+ +

A vertex buffer can be used with either hardware or software vertex processing. This is determined by how the device and the vertex buffer are created.

When a device is created, CreateDevice uses the behavior flag to determine whether to process vertices in hardware or software. There are three possibilities:

  • Process vertices in hardware by setting .
  • Process vertices in software by setting .
  • Process vertices in either hardware or software by setting .

Mixed-mode devices might need to switch between software and hardware processing (using ) after the device is created.

When a vertex buffer is created, CreateVertexBuffer uses the usage parameter to decide whether to process vertices in hardware or software.

  • If CreateDevice uses , CreateVertexBuffer must use 0.
  • If CreateDevice uses , CreateVertexBuffer must use either 0 or . For either value, vertices will be processed in software.
  • If CreateDevice uses , CreateVertexBuffer can use either 0 or .

To use a vertex buffer with a mixed mode device, create a single vertex buffer which can be used for both hardware or software processing. Use to set the current vertex buffer and use , if necessary, to change the device behavior to match. It is recommended that the vertex buffer usage matches the device behavior. Note that a vertex buffer created for software processing cannot be located in video memory.

The interface supports rendering of primitives using vertex data stored in vertex buffer objects. Vertex buffers are created from the , and are usable only with the object from which they are created.

When set to a nonzero value, which must be a valid FVF code, the FVF parameter indicates that the buffer content is to be characterized by an FVF code. A vertex buffer that is created with an FVF code is referred to as an FVF vertex buffer. For more information, see FVF Vertex Buffers (Direct3D 9).

Non-FVF buffers can be used to interleave data during multipass rendering or multitexture rendering in a single pass. To do this, one buffer contains geometry data and the others contain texture coordinates for each texture to be rendered. When rendering, the buffer containing the geometry data is interleaved with each of the buffers containing the texture coordinates. If FVF buffers were used instead, each of them would need to contain identical geometry data in addition to the texture coordinate data specific to each texture rendered. This would result in either a speed or memory penalty, depending on the strategy used. For more information about texture coordinates, see Texture Coordinates (Direct3D 9).

+
+ + bb174364 + HRESULT IDirect3DDevice9::CreateVertexBuffer([In] unsigned int Length,[In] D3DUSAGE Usage,[In] D3DFVF FVF,[In] D3DPOOL Pool,[Out, Fast] IDirect3DVertexBuffer9** ppVertexBuffer,[In] void** pSharedHandle) + IDirect3DDevice9::CreateVertexBuffer +
+ + +

Creates an index buffer.

+
+

Size of the index buffer, in bytes.

+

Usage can be 0, which indicates no usage value. However, if usage is desired, use a combination of one or more constants. It is good practice to match the usage parameter in CreateIndexBuffer with the behavior flags in . For more information, see Remarks.

+

Member of the enumerated type, describing the format of the index buffer. For more information, see Remarks. The valid settings are the following:

ItemDescription

Indices are 16 bits each.

Indices are 32 bits each.

?

+

Member of the enumerated type, describing a valid memory class into which to place the resource.

+

Address of a reference to an interface, representing the created index buffer resource.

+

This parameter can be used in Direct3D?9 for Windows?Vista to share resources; set it to null to not share a resource. This parameter is not used in Direct3D?9 for operating systems earlier than Windows?Vista; set it to null.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

Index buffers are memory resources used to hold indices, they are similar to both surfaces and vertex buffers. The use of index buffers enables Direct3D to avoid unnecessary data copying and to place the buffer in the optimal memory type for the expected usage.

To use index buffers, create an index buffer, lock it, fill it with indices, unlock it, pass it to , set up the vertices, set up the vertex shader, and call for rendering.

The MaxVertexIndex member of the structure indicates the types of index buffers that are valid for rendering.

+
+ + bb174357 + HRESULT IDirect3DDevice9::CreateIndexBuffer([In] unsigned int Length,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DIndexBuffer9** ppIndexBuffer,[In] void** pSharedHandle) + IDirect3DDevice9::CreateIndexBuffer +
+ + +

Creates a render-target surface.

+
+

Width of the render-target surface, in pixels.

+

Height of the render-target surface, in pixels.

+

Member of the enumerated type, describing the format of the render target.

+

Member of the enumerated type, which describes the multisampling buffer type. This parameter specifies the antialiasing type for this render target. When this surface is passed to , its multisample type must be the same as that of the depth-stencil set by .

+

Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error, . The MultisampleQuality values of paired render targets, depth stencil surfaces, and the multisample type must all match.

+

Render targets are not lockable unless the application specifies TRUE for Lockable.

Note that lockable render targets reduce performance on some graphics hardware. The readback performance (moving data from video memory to system memory) depends on the type of hardware used (AGP vs. PCI Express) and is usually far lower than upload performance (moving data from system to video memory). If you need read access to render targets, use GetRenderTargetData instead of lockable render targets.

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

Address of a reference to an interface.

+ +

Render-target surfaces are placed in the memory class.

The creation of lockable, multisampled render targets is not supported.

+
+ + bb174361 + HRESULT IDirect3DDevice9::CreateRenderTarget([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Lockable,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + IDirect3DDevice9::CreateRenderTarget +
+ + +

Creates a depth-stencil resource.

+
+

Width of the depth-stencil surface, in pixels.

+

Height of the depth-stencil surface, in pixels.

+

Member of the enumerated type, describing the format of the depth-stencil surface. This value must be one of the enumerated depth-stencil formats for this device.

+

Member of the enumerated type, describing the multisampling buffer type. This value must be one of the allowed multisample types. When this surface is passed to , its multisample type must be the same as that of the render target set by .

+

Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error . The MultisampleQuality values of paired render targets, depth stencil surfaces, and the MultiSample type must all match.

+

Set this flag to TRUE to enable z-buffer discarding, and otherwise. If this flag is set, the contents of the depth stencil buffer will be invalid after calling either or with a different depth surface.

This flag has the same behavior as the constant, , in .

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

Address of a reference to an interface, representing the created depth-stencil surface resource.

+ +

The memory class of the depth-stencil buffer is always .

+
+ + bb174356 + HRESULT IDirect3DDevice9::CreateDepthStencilSurface([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Discard,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + IDirect3DDevice9::CreateDepthStencilSurface +
+ + +

Copies rectangular subsets of pixels from one surface to another.

+
+

Pointer to an interface, representing the source surface. This parameter must point to a different surface than pDestinationSurface.

+

Pointer to a rectangle on the source surface. Specifying null for this parameter causes the entire surface to be copied.

+

Pointer to an interface, representing the destination surface.

+

Pointer to the upper left corner of the destination rectangle. Specifying null for this parameter causes the entire surface to be copied.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: .

+ +

This method is similar to CopyRects in DirectX 8.

This function has the following restrictions.

  • The source surface must have been created with .
  • The destination surface must have been created with .
  • Neither surface can be locked or holding an outstanding device context.
  • Neither surface can be created with multisampling. The only valid flag for both surfaces is .
  • The surface format cannot be a depth stencil format.
  • The source and dest rects must fit within the surface.
  • No stretching or shrinking is allowed (the rects must be the same size).
  • The source format must match the dest format.

The following table shows the supported combinations.

Dest formats
TextureRT textureRTOff-screen plain
Src formatsTextureYesYesYes*Yes
RT textureNoNoNoNo
RTNoNoNoNo
Off-screen plainYesYesYesYes

?

* If the driver does not support the requested copy, it will be emulated using lock and copy.

If the application needs to copy data from a render target to a surface, it can use GetRenderTargetData.

+
+ + bb205857 + HRESULT IDirect3DDevice9::UpdateSurface([In] IDirect3DSurface9* pSourceSurface,[In, Optional] const RECT* pSourceRect,[In] IDirect3DSurface9* pDestinationSurface,[In, Optional] const POINT* pDestPoint) + IDirect3DDevice9::UpdateSurface +
+ + +

Updates the dirty portions of a texture.

+
+

Pointer to an interface, representing the source texture. The source texture must be in system memory ().

+

Pointer to an interface, representing the destination texture. The destination texture must be in the memory pool.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

You can dirty a portion of a texture by locking it, or by calling one of the following methods.

retrieves the dirty portions of the texture by calculating what has been accumulated since the last update operation.

For performance reasons, dirty regions are only recorded for level zero of a texture. For sublevels, it is assumed that the corresponding (scaled) rectangle or box is also dirty. Dirty regions are automatically recorded when LockRect or is called without or . Also, the destination surface of is marked dirty.

This method fails if the textures are of different types, if their bottom-level buffers are of different sizes, or if their matching levels do not match. For example, consider a six-level source texture with the following dimensions.

 32x16, 16x8, 8x4, 4x2, 2x1, 1x1	
+            

This six-level source texture could be the source for the following one-level destination.

 1x1	
+            

For the following two-level destination.

 2x1, 1x1	
+            

Or, for the following three-level destination.

 4x2, 2x1, 1x1	
+            

In addition, this method will fail if the textures are of different formats. If the destination texture has fewer levels than the source, only the matching levels are copied. If the source texture has fewer levels than the destination, the method will fail.

If the source texture has dirty regions, the copy can be optimized by restricting the copy to only those regions. It is not guaranteed that only those bytes marked dirty will be copied.

Here are the possibilities for source and destination surface combinations:

  • If pSourceTexture is a non-autogenerated mipmap and pDestinationTexture is an autogenerated mipmap, only the topmost matching level is updated, and the destination sublevels are regenerated. All other source sublevels are ignored.
  • If both pSourceTexture and pDestinationTexture are autogenerated mipmaps, only the topmost matching level is updated. The sublevels from the source are ignored and the destination sublevels are regenerated.
  • If pSourceTexture is an autogenerated mipmap and pDestinationTexture a non-autogenerated mipmap, UpdateTexture will fail.
+
+ + bb205858 + HRESULT IDirect3DDevice9::UpdateTexture([In] IDirect3DBaseTexture9* pSourceTexture,[In] IDirect3DBaseTexture9* pDestinationTexture) + IDirect3DDevice9::UpdateTexture +
+ + +

Copies the render-target data from device memory to system memory.

+
+

Pointer to an object, representing a render target.

+

Pointer to an object, representing a destination surface.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , .

+ +

The destination surface must be either an off-screen plain surface or a level of a texture (mipmap or cube texture) created with .

The source surface must be a regular render target or a level of a render-target texture (mipmap or cube texture) created with POOL_DEFAULT.

This method will fail if:

  • The render target is multisampled.
  • The source render target is a different size than the destination surface.
  • The source render target and destination surface formats do not match.
+
+ + bb174405 + HRESULT IDirect3DDevice9::GetRenderTargetData([In] IDirect3DSurface9* pRenderTarget,[In] IDirect3DSurface9* pDestSurface) + IDirect3DDevice9::GetRenderTargetData +
+ + +

Generates a copy of the device's front buffer and places that copy in a system memory buffer provided by the application.

+
+

An unsigned integer specifying the swap chain.

+

Pointer to an interface that will receive a copy of the contents of the front buffer. The data is returned in successive rows with no intervening space, starting from the vertically highest row on the device's output to the lowest.

For windowed mode, the size of the destination surface should be the size of the desktop. For full-screen mode, the size of the destination surface should be the screen size.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , ,

+ +

The buffer pointed to by pDestSurface will be filled with a representation of the front buffer, converted to the standard 32 bits per pixel format .

This method is the only way to capture an antialiased screen shot.

This function is very slow, by design, and should not be used in any performance-critical path.

For more information, see Lost Devices and Retrieved Data.

+
+ + bb174388 + HRESULT IDirect3DDevice9::GetFrontBufferData([In] unsigned int iSwapChain,[In] IDirect3DSurface9* pDestSurface) + IDirect3DDevice9::GetFrontBufferData +
+ + +

Copy the contents of the source rectangle to the destination rectangle. The source rectangle can be stretched and filtered by the copy. This function is often used to change the aspect ratio of a video stream.

+
+

Pointer to the source surface. See .

+

Pointer to the source rectangle. A null for this parameter causes the entire source surface to be used.

+

Pointer to the destination surface. See .

+

Pointer to the destination rectangle. A null for this parameter causes the entire destination surface to be used.

+

Filter type. Allowable values are , , or . For more information, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ +

StretchRect Restrictions

  • Driver support varies. See the section on driver support (below) to see which drivers support which source and destination formats.
  • The source and destination surfaces must be created in the default memory pool.
  • If filtering is specified, you must set the appropriate filter caps (see StretchRectFilterCaps in ).
  • Stretching is not supported between source and destination rectangles on the same surface.
  • Stretching is not supported if the destination surface is an off-screen plain surface but the source is not.
  • You many not stretch between source and destination rectangles if either surface is in a compressed format (see Using Compressed Textures (Direct3D 9)).
  • Stretching supports color-space conversion from YUV to high-precision RGBA only. Since color conversion support is not supported by software emulation, use to test the hardware for color conversion support.
  • If the source or destination surface is a texture surface (or a cube texture surface), you must use a Direct3D 9 driver that supports (see ).

Additional Restrictions for Depth and Stencil Surfaces

  • The source and destination surfaces must be plain depth stencil surfaces (not textures) (see ).
  • Neither of the surfaces can be discardable.
  • The entire surface must be copied (that is: sub-rectangle copies are not allowed).
  • Format conversion, stretching, and shrinking are not supported.
  • StretchRect cannot be called inside of a BeginScene/EndScene pair.

Using StretchRect to downsample a Multisample Rendertarget

You can use StretchRect to copy from one rendertarget to another. If the source rendertarget is multisampled, this results in downsampling the source rendertarget. For instance you could:

  • Create a multisampled rendertarget.
  • Create a second rendertarget of the same size, that is not multisampled.
  • Copy (using StretchRect the multisample rendertarget to the second rendertarget.

Note that use of the extra surface involved in using StretchRect to downsample a Multisample Rendertarget will result in a performance hit.

Driver Support

There are many restrictions as to which surface combinations are valid for StretchRect. Factors include whether the driver is a Direct3D 9 driver or older, and whether the operation will result in stretching/shrinking. Since applications are not expected to recognize if the driver is a Direct3D 9 driver or not, the runtime will automatically set a new cap, cap (see ), for Direct3D 9-level drivers and above.

DirectX 8 Driver (no stretching)
Dest formats
TextureRT textureRTOff-screen plain
Src formatsTextureNoNoNoNo
RT textureNoYesYesNo
RTNoYesYesNo
Off-screen plainYesYesYesYes

?

DirectX 8 Driver (stretching)
Dest formats
TextureRT textureRTOff-screen plain
Src formatsTextureNoNoNoNo
RT textureNoNoNoNo
RTNoYesYesNo
Off-screen plainNoYesYesNo

?

Direct3D 9 Driver (no stretching)
Dest formats
TextureRT textureRTOff-screen plain
Src formatsTextureNoYesYesNo
RT textureNoYesYesNo
RTNoYesYesNo
Off-screen plainNoYesYesYes

?

Direct3D 9 Driver (stretching)
Dest formats
TextureRT textureRTOff-screen plain
Src formatsTextureNoYesYesNo
RT textureNoYesYesNo
RTNoYesYesNo
Off-screen plainNoYesYesNo

?

+
+ + bb174471 + HRESULT IDirect3DDevice9::StretchRect([In] IDirect3DSurface9* pSourceSurface,[In, Optional] const RECT* pSourceRect,[In] IDirect3DSurface9* pDestSurface,[In, Optional] const RECT* pDestRect,[In] D3DTEXTUREFILTERTYPE Filter) + IDirect3DDevice9::StretchRect +
+ + +

Allows an application to fill a rectangular area of a surface with a specified color.

+
+

Pointer to the surface to be filled.

+

Pointer to the source rectangle. Using null means that the entire surface will be filled.

+

Color used for filling.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method can only be applied to a render target, a render-target texture surface, or an off-screen plain surface with a pool type of .

will work with all formats. However, when using a reference or software device, the only formats supported are , , , , , , , , , , , , , , and .

When using a DirectX 7 or DirectX 8.x driver, the only YUV formats supported are and .

+
+ + bb174353 + HRESULT IDirect3DDevice9::ColorFill([In] IDirect3DSurface9* pSurface,[In, Optional] const RECT* pRect,[In] D3DCOLOR color) + IDirect3DDevice9::ColorFill +
+ + +

Create an off-screen surface.

+
+

Width of the surface.

+

Height of the surface.

+

Format of the surface. See .

+

Surface pool type. See .

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

Pointer to the interface created.

+ +

will return a surface that has identical characteristics to a surface created by the DirectX 8.x method CreateImageSurface.

is the appropriate pool for use with the and .

is not allowed when creating an offscreen plain surface. For more information about memory pools, see .

Off-screen plain surfaces are always lockable, regardless of their pool types.

+
+ + bb174358 + HRESULT IDirect3DDevice9::CreateOffscreenPlainSurface([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + IDirect3DDevice9::CreateOffscreenPlainSurface +
+ + +

Sets a new color buffer for the device.

+
+

Index of the render target. See Remarks.

+

Pointer to a new color buffer. If null, the color buffer for the corresponding RenderTargetIndex is disabled. Devices always must be associated with a color buffer. The new render-target surface must have at least specified.

+

If the method succeeds, the return value is . This method will return if either:

  • pRenderTarget = null and RenderTargetIndex = 0
  • pRenderTarget is != null and the render target is invalid.
+ +

The device can support multiple render targets. The number of render targets supported by a device is contained in the NumSimultaneousRTs member of . See Multiple Render Targets (Direct3D 9).

Setting a new render target will cause the viewport (see Viewports and Clipping (Direct3D 9)) to be set to the full size of the new render target.

Some hardware tests the compatibility of the depth stencil buffer with the color buffer. If this is done, it is only done in a debug build.

Restrictions for using this method include the following:

  • The multisample type must be the same for the render target and the depth stencil surface.
  • The formats must be compatible for the render target and the depth stencil surface. See .
  • The size of the depth stencil surface must be greater than or equal to the size of the render target.

These restrictions are validated only when using the debug runtime when any of the Draw methods are called.

Cube textures differ from other surfaces in that they are collections of surfaces. To call with a cube texture, you must select an individual face using and pass the resulting surface to .

+
+ + bb174455 + HRESULT IDirect3DDevice9::SetRenderTarget([In] unsigned int RenderTargetIndex,[In] IDirect3DSurface9* pRenderTarget) + IDirect3DDevice9::SetRenderTarget +
+ + +

Retrieves a render-target surface.

+
+

Index of the render target. See Remarks.

+

Address of a reference to an interface, representing the returned render-target surface for this device.

+ +

Typically, methods that return state will not work on a device that is created using . This method however, will work even on a pure device because it returns an interface.

The device can now support multiple render targets. The number of render targets supported by a device is contained in the NumSimultaneousRTs member of . See Multiple Render Targets (Direct3D 9).

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using the interface results in a memory leak.

+
+ + bb174404 + HRESULT IDirect3DDevice9::GetRenderTarget([In] unsigned int RenderTargetIndex,[Out] IDirect3DSurface9** ppRenderTarget) + IDirect3DDevice9::GetRenderTarget +
+ + +

Sets the depth stencil surface.

+
+

Address of a reference to an interface representing the depth stencil surface. Setting this to null disables the depth stencil operation.

+

If the method succeeds, the return value is . If pZStencilSurface is other than null, the return value is when the stencil surface is invalid.

+ +

Restrictions for using this method include the following:

  • The multisample type must be the same for the render target and the depth stencil surface.
  • The formats must be compatible for the render target and the depth stencil surface. See .
  • The size of the depth stencil surface must be greater than or equal to the size of the render target.

These restrictions are validated only when using the debug runtime when any of the Draw methods are called.

Cube textures differ from other surfaces in that they are collections of surfaces. To call with a cube texture, you must select an individual face using and pass the resulting surface to .

+
+ + bb174431 + HRESULT IDirect3DDevice9::SetDepthStencilSurface([In] IDirect3DSurface9* pNewZStencil) + IDirect3DDevice9::SetDepthStencilSurface +
+ + +

Gets the depth-stencil surface owned by the Direct3DDevice object.

+
+

Address of a reference to an interface, representing the returned depth-stencil surface.

+

If the method succeeds, the return value is .If the device doesn't have a depth stencil buffer associated with it, the return value will be . Otherwise, if the method fails, the return value can be .

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174384 + HRESULT IDirect3DDevice9::GetDepthStencilSurface([Out] IDirect3DSurface9** ppZStencilSurface) + IDirect3DDevice9::GetDepthStencilSurface +
+ + +

Begins a scene.

+
+

If the method succeeds, the return value is . The method will fail with if is called while already in a / pair. This happens only when is called twice without first calling .

+ +

Applications must call before performing any rendering and must call when rendering is complete and before calling again.

If fails, the device was unable to begin the scene, and there is no need to call . In fact, calls to will fail if the previous failed. This applies to any application that creates multiple swap chains.

There should be one / pair between any successive calls to present (either or ). should be called once before any rendering is performed, and should be called once after all rendering for a frame has been submitted to the runtime. Multiple non-nested / pairs between calls to present are legal, but having more than one pair may incur a performance hit. To enable maximal parallelism between the CPU and the graphics accelerator, it is advantageous to call as far ahead of calling present as possible.

+
+ + bb174350 + HRESULT IDirect3DDevice9::BeginScene() + IDirect3DDevice9::BeginScene +
+ + +

Ends a scene that was begun by calling .

+
+

If the method succeeds, the return value is . The method will fail with if is called while already in a / pair. This happens only when is called twice without first calling .

+ +

When this method succeeds, the scene has been queued up for rendering by the driver. This is not a synchronous method, so the scene is not guaranteed to have completed rendering when this method returns.

Applications must call before performing any rendering and must call when rendering is complete and before calling again.

If fails, the device was unable to begin the scene, and there is no need to call . In fact, calls to will fail if the previous failed. This applies to any application that creates multiple swap chains.

There should be at most one / pair between any successive calls to present (either or ). should be called once before any rendering is performed, and should be called once after all rendering for a frame has been submitted to the runtime. To enable maximal parallelism between the CPU and the graphics accelerator, it is advantageous to call as far ahead of calling present as possible.

+
+ + bb174375 + HRESULT IDirect3DDevice9::EndScene() + IDirect3DDevice9::EndScene +
+ + +

Clears one or more surfaces such as a render target, multiple render targets, a stencil buffer, and a depth buffer.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ +

Use this method to clear a surface including: a render target, all render targets in an MRT, a stencil buffer, or a depth buffer. Flags determines how many surfaces are cleared. Use pRects to clear a subset of a surface defined by an array of rectangles.

will fail if you:

  • Try to clear either the depth buffer or the stencil buffer of a render target that does not have an attached depth buffer.
  • Try to clear the stencil buffer when the depth buffer does not contain stencil data.
+
+ + bb174352 + HRESULT IDirect3DDevice9::Clear([In] unsigned int Count,[In, Buffer, Optional] const D3DRECT* pRects,[In] D3DCLEAR Flags,[In] D3DCOLOR Color,[In] float Z,[In] unsigned int Stencil) + IDirect3DDevice9::Clear +
+ + +

Sets a single device transformation-related state.

+
+

Device-state variable that is being modified. This parameter can be any member of the enumerated type, or the D3DTS_WORLDMATRIX macro.

+

Pointer to a structure that modifies the current transformation.

+

If the method succeeds, the return value is . is returned if one of the arguments is invalid.

+ + bb174463 + HRESULT IDirect3DDevice9::SetTransform([In] int State,[In] const D3DMATRIX* pMatrix) + IDirect3DDevice9::SetTransform +
+ + +

Retrieves a matrix describing a transformation state.

+
+

Device state variable that is being modified. This parameter can be any member of the enumerated type, or the D3DTS_WORLDMATRIX macro.

+

Pointer to a structure, describing the returned transformation state.

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other flag values in .

+
+ + bb174414 + HRESULT IDirect3DDevice9::GetTransform([In] D3DTRANSFORMSTATETYPE State,[Out] D3DMATRIX* pMatrix) + IDirect3DDevice9::GetTransform +
+ + +

Multiplies a device's world, view, or projection matrices by a specified matrix.

+
+

Member of the enumerated type, or the D3DTS_WORLDMATRIX macro that identifies which device matrix is to be modified. The most common setting, D3DTS_WORLDMATRIX(0), modifies the world matrix, but you can specify that the method modify the view or projection matrices, if needed.

+

Pointer to a structure that modifies the current transformation.

+

If the method succeeds, the return value is . if one of the arguments is invalid.

+ +

The multiplication order is pMatrix times State.

An application might use the method to work with hierarchies of transformations. For example, the geometry and transformations describing an arm might be arranged in the following hierarchy.

 shoulder_transformation upper_arm geometry elbow transformation lower_arm geometry wrist transformation hand geometry	
+            

An application might use the following series of calls to render this hierarchy. Not all the parameters are shown in this pseudocode.

 (D3DTS_WORLDMATRIX(0),  shoulder_transform)	
+            (upper_arm)	
+            (D3DTS_WORLDMATRIX(0),  elbow_transform)	
+            (lower_arm)	
+            (D3DTS_WORLDMATRIX(0),  wrist_transform)	
+            (hand)
+
+ + bb174422 + HRESULT IDirect3DDevice9::MultiplyTransform([In] D3DTRANSFORMSTATETYPE arg0,[In] const D3DMATRIX* arg1) + IDirect3DDevice9::MultiplyTransform +
+ + +

Sets the viewport parameters for the device.

+
+

Pointer to a structure, specifying the viewport parameters to set.

+

If the method succeeds, the return value is . If the method fails, it will return . This will happen if pViewport is invalid, or if pViewport describes a region that cannot exist within the render target surface.

+ +

Direct3D sets the following default values for the viewport.

  vp;	
+            vp.X      = 0;	
+            vp.Y      = 0;	
+            vp.Width  = RenderTarget.Width;	
+            vp.Height = RenderTarget.Height;	
+            vp.MinZ   = 0.0f;	
+            vp.MaxZ   = 1.0f;	
+            

can be used to draw on part of the screen. Make sure to call it before any geometry is drawn so the viewport settings will take effect.

To draw multiple views within a scene, repeat the and draw geometry sequence for each view.

+
+ + bb174469 + HRESULT IDirect3DDevice9::SetViewport([In] const D3DVIEWPORT9* pViewport) + IDirect3DDevice9::SetViewport +
+ + +

Retrieves the viewport parameters currently set for the device.

+
+

Pointer to a structure, representing the returned viewport parameters.

+

If the method succeeds, the return value is . is returned if the pViewport parameter is invalid.

+ +

Typically, methods that return state will not work on a device that is created using . This method however, will work even on a pure device.

+
+ + bb174420 + HRESULT IDirect3DDevice9::GetViewport([Out] D3DVIEWPORT9* pViewport) + IDirect3DDevice9::GetViewport +
+ + +

Sets the material properties for the device.

+
+

Pointer to a structure, describing the material properties to set.

+

If the method succeeds, the return value is . if the pMaterial parameter is invalid.

+ + bb174437 + HRESULT IDirect3DDevice9::SetMaterial([In] const D3DMATERIAL9* pMaterial) + IDirect3DDevice9::SetMaterial +
+ + +

Retrieves the current material properties for the device.

+
+

Pointer to a structure to fill with the currently set material properties.

+

If the method succeeds, the return value is . if the pMaterial parameter is invalid.

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other values in .

+
+ + bb174394 + HRESULT IDirect3DDevice9::GetMaterial([Out] D3DMATERIAL9* pMaterial) + IDirect3DDevice9::GetMaterial +
+ + +

Assigns a set of lighting properties for this device.

+
+

Zero-based index of the set of lighting properties to set. If a set of lighting properties exists at this index, it is overwritten by the new properties specified in pLight.

+

Pointer to a structure, containing the lighting parameters to set.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Set light properties by preparing a structure and then calling the method. The method accepts the index at which the device should place the set of light properties to its internal list of light properties, and the address of a prepared structure that defines those properties. You can call with new information as needed to update the light's illumination properties.

The system allocates memory to accommodate a set of lighting properties each time you call the method with an index that has never been assigned properties. Applications can set a number of lights, with only a subset of the assigned lights enabled at a time. Check the MaxActiveLights member of the structure when you retrieve device capabilities to determine the maximum number of active lights supported by that device. If you no longer need a light, you can disable it or overwrite it with a new set of light properties.

The following example prepares and sets properties for a white point-light whose emitted light will not attenuate over distance.

 // Assume d3dDevice is a valid reference to an  interface.	
+             d3dLight;	
+               hr; // Initialize the structure.	
+            ZeroMemory(&d3dLight, sizeof(d3dLight)); // Set up a white point light.	
+            d3dLight.Type = ;	
+            d3dLight.Diffuse.r  = 1.0f;	
+            d3dLight.Diffuse.g  = 1.0f;	
+            d3dLight.Diffuse.b  = 1.0f;	
+            d3dLight.Ambient.r  = 1.0f;	
+            d3dLight.Ambient.g  = 1.0f;	
+            d3dLight.Ambient.b  = 1.0f;	
+            d3dLight.Specular.r = 1.0f;	
+            d3dLight.Specular.g = 1.0f;	
+            d3dLight.Specular.b = 1.0f; // Position it high in the scene and behind the user.	
+            // Remember, these coordinates are in world space, so	
+            // the user could be anywhere in world space, too. 	
+            // For the purposes of this example, assume the user	
+            // is at the origin of world space.	
+            d3dLight.Position.x = 0.0f;	
+            d3dLight.Position.y = 1000.0f;	
+            d3dLight.Position.z = -100.0f; // Don't attenuate.	
+            d3dLight.Attenuation0 = 1.0f; 	
+            d3dLight.Range        = 1000.0f; // Set the property information for the first light.	
+            hr = d3dDevice->SetLight(0, &d3dLight);	
+            if (SUCCEEDED(hr)) // Handle Success	
+            else // Handle failure	
+            

Enable a light source by calling the method for the device.

+
+ + bb174436 + HRESULT IDirect3DDevice9::SetLight([In] unsigned int Index,[In] const D3DLIGHT9* arg1) + IDirect3DDevice9::SetLight +
+ + +

Retrieves a set of lighting properties that this device uses.

+
+

Zero-based index of the lighting property set to retrieve. This method will fail if a lighting property has not been set for this index by calling the method.

+

Pointer to a structure that is filled with the retrieved lighting-parameter set.

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other values in .

Retrieve all the properties for an existing light source by calling the method for the device. When calling the method, pass the zero-based index of the light source for which the properties will be retrieved as the first parameter, and supply the address of a structure as the second parameter. The device fills the structure to describe the lighting properties it uses for the light source at that index.

 // Assume d3dDevice is a valid reference to an  interface.	
+             hr;	
+            D3DLight9 light; // Get the property information for the first light.	
+            hr = pd3dDevice->GetLight(0, &light);	
+            if (SUCCEEDED(hr)) // Handle Success	
+            else // Handle failure	
+            

If you supply an index outside the range of the light sources assigned in the device, the method fails, returning .

When you assign a set of light properties for a light source in a scene, the light source can be activated by calling the method for the device. New light sources are disabled by default. The method accepts two parameters. Set the first parameter to the zero-based index of the light source to be affected by the method, and set the second parameter to TRUE to enable the light or to disable it. The following code example illustrates the use of this method by enabling the first light source in the device's list of light source properties.

 // Assume d3dDevice is a valid reference to an  interface.	
+             hr; hr = pd3dDevice->LightEnable(0, TRUE);	
+            if (SUCCEEDED(hr)) // Handle Success	
+            else // Handle failure	
+            

Check the MaxActiveLights member of the structure when you retrieve device capabilities to determine the maximum number of active lights supported by that device.

If you enable or disable a light that has no properties that are set with , the method creates a light source with the properties listed in following table and enables or disables it.

+
+ + bb174392 + HRESULT IDirect3DDevice9::GetLight([In] unsigned int Index,[Out] D3DLIGHT9* arg1) + IDirect3DDevice9::GetLight +
+ + +

Enables or disables a set of lighting parameters within a device.

+
+

Zero-based index of the set of lighting parameters that are the target of this method.

+

Value that indicates if the set of lighting parameters are being enabled or disabled. Set this parameter to TRUE to enable lighting with the parameters at the specified index, or to disable it.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If a value for LightIndex is outside the range of the light property sets assigned within the device, the method creates a light source represented by a structure with the following properties and sets its enabled state to the value specified in bEnable.

MemberDefault
Type
Diffuse (R:1, G:1, B:1, A:0)
Specular (R:0, G:0, B:0, A:0)
Ambient (R:0, G:0, B:0, A:0)
Position (0, 0, 0)
Direction (0, 0, 1)
Range 0
Falloff 0
Attenuation0 0
Attenuation1 0
Attenuation2 0
Theta 0
Phi 0

?

+
+ + bb174421 + HRESULT IDirect3DDevice9::LightEnable([In] unsigned int Index,[In] BOOL Enable) + IDirect3DDevice9::LightEnable +
+ + +

Retrieves the activity status - enabled or disabled - for a set of lighting parameters within a device.

+
+

Zero-based index of the set of lighting parameters that are the target of this method.

+

Pointer to a variable to fill with the status of the specified lighting parameters. After the call, a nonzero value at this address indicates that the specified lighting parameters are enabled; a value of 0 indicates that they are disabled.

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other values in .

+
+ + bb174393 + HRESULT IDirect3DDevice9::GetLightEnable([In] unsigned int Index,[Out] BOOL* pEnable) + IDirect3DDevice9::GetLightEnable +
+ + +

Sets the coefficients of a user-defined clipping plane for the device.

+
+

Index of the clipping plane for which the plane equation coefficients are to be set.

+

Pointer to an address of a four-element array of values that represent the clipping plane coefficients to be set, in the form of the general plane equation. See Remarks.

+

If the method succeeds, the return value is . If the method fails, the return value is . This error indicates that the value in Index exceeds the maximum clipping plane index supported by the device or that the array at pPlane is not large enough to contain four floating-point values.

+ +

The coefficients that this method sets take the form of the general plane equation. If the values in the array at pPlane were labeled A, B, C, and D in the order that they appear in the array, they would fit into the general plane equation so that Ax + By + Cz + Dw = 0. A point with homogeneous coordinates (x, y, z, w) is visible in the half space of the plane if Ax + By + Cz + Dw >= 0. Points that exist behind the clipping plane are clipped from the scene.

When the fixed function pipeline is used the plane equations are assumed to be in world space. When the programmable pipeline is used the plane equations are assumed to be in the clipping space (the same space as output vertices).

This method does not enable the clipping plane equation being set. To enable a clipping plane, set the corresponding bit in the DWORD value applied to the render state.

+
+ + bb174426 + HRESULT IDirect3DDevice9::SetClipPlane([In] unsigned int Index,[In] const SHARPDX_VECTOR4* pPlane) + IDirect3DDevice9::SetClipPlane +
+ + +

Retrieves the coefficients of a user-defined clipping plane for the device.

+
+

Index of the clipping plane for which the plane equation coefficients are retrieved.

+

Pointer to a four-element array of values that represent the coefficients of the clipping plane in the form of the general plane equation. See Remarks.

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other values in ."

The coefficients that this method reports take the form of the general plane equation. If the values in the array at pPlane were labeled A, B, C, and D in the order that they appear in the array, they would fit into the general plane equation so that Ax + By + Cz + Dw = 0. A point with homogeneous coordinates (x, y, z, w) is visible in the half space of the plane if Ax + By + Cz + Dw >= 0. Points that exist on or behind the clipping plane are clipped from the scene.

The plane equation used by this method exists in world space and is set by a previous call to the method.

+
+ + bb174380 + HRESULT IDirect3DDevice9::GetClipPlane([In] unsigned int Index,[Out] float* pPlane) + IDirect3DDevice9::GetClipPlane +
+ + +

Sets a single device render-state parameter.

+
+

Device state variable that is being modified. This parameter can be any member of the enumerated type.

+

New value for the device render state to be set. The meaning of this parameter is dependent on the value specified for State. For example, if State were , the second parameter would be one member of the enumerated type.

+

If the method succeeds, the return value is . is returned if one of the arguments is invalid.

+ + bb174454 + HRESULT IDirect3DDevice9::SetRenderState([In] D3DRENDERSTATETYPE State,[In] unsigned int Value) + IDirect3DDevice9::SetRenderState +
+ + +

Retrieves a render-state value for a device.

+
+

Device state variable that is being queried. This parameter can be any member of the enumerated type.

+

Pointer to a variable that receives the value of the queried render state variable when the method returns.

+

If the method succeeds, the return value is . if one of the arguments is invalid.

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other values in ."

+
+ + bb174403 + HRESULT IDirect3DDevice9::GetRenderState([In] D3DRENDERSTATETYPE State,[In] void* pValue) + IDirect3DDevice9::GetRenderState +
+ + +

Creates a new state block that contains the values for all device states, vertex-related states, or pixel-related states.

+
+

Type of state data that the method should capture. This parameter can be set to a value defined in the enumerated type.

+

Pointer to a state block interface. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , E_OUTOFMEMORY.

+ +

Vertex-related device states typically refer to those states that affect how the system processes vertices. Pixel-related states generally refer to device states that affect how the system processes pixel or depth-buffer data during rasterization. Some states are contained in both groups.

Differences between Direct3D 9 and Direct3D 10:

In Direct3D 9, a state block contains state data, for the states it was requested to capture, when the object is created. To change the value of the state block, call or /. There is no state saved when a state block object is created in Direct3D 10.

?

+
+ + bb174362 + HRESULT IDirect3DDevice9::CreateStateBlock([In] D3DSTATEBLOCKTYPE Type,[Out, Fast] IDirect3DStateBlock9** ppSB) + IDirect3DDevice9::CreateStateBlock +
+ + +

Signals Direct3D to begin recording a device-state block.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Applications can ensure that all recorded states are valid by calling the method prior to calling this method.

The following methods can be recorded in a state block, after calling and before .

The ordering of state changes in a state block is not guaranteed. If the same state is specified multiple times in a state block, only the last value is used.

+
+ + bb174351 + HRESULT IDirect3DDevice9::BeginStateBlock() + IDirect3DDevice9::BeginStateBlock +
+ + +

Signals Direct3D to stop recording a device-state block and retrieve a reference to the state block interface.

+
+

Pointer to a state block interface. See .

+ + bb174376 + HRESULT IDirect3DDevice9::EndStateBlock([In] IDirect3DStateBlock9** ppSB) + IDirect3DDevice9::EndStateBlock +
+ + +

Sets the clip status.

+
+

Pointer to a structure, describing the clip status settings to be set.

+

If the method succeeds, the return value is . If one of the arguments is invalid, the return value is .

+ +

Clip status is used during software vertex processing. Therefore, this method is not supported on pure or nonpure hardware processing devices. For more information about pure devices, see .

When clipping is enabled during vertex processing (by , , or other drawing functions), Direct3D computes a clip code for every vertex. The clip code is a combination of D3DCS_* bits. When a vertex is outside a particular clipping plane, the corresponding bit is set in the clipping code. Direct3D maintains the clip status using , which has ClipUnion and ClipIntersection members. ClipUnion is a bitwise "OR" of all vertex clip codes and ClipIntersection is a bitwise "AND" of all vertex clip codes. Initial values are zero for ClipUnion and 0xFFFFFFFF for ClipIntersection. When is set to , ClipUnion and ClipIntersection are set to zero. Direct3D updates the clip status during drawing calls. To compute clip status for a particular object, set ClipUnion and ClipIntersection to their initial value and continue drawing.

Clip status is not updated by and because there is no software emulation for them.

+
+ + bb174427 + HRESULT IDirect3DDevice9::SetClipStatus([In] const D3DCLIPSTATUS9* pClipStatus) + IDirect3DDevice9::SetClipStatus +
+ + +

Retrieves the clip status.

+
+

Pointer to a structure that describes the clip status.

+

If the method succeeds, the return value is .

is returned if the argument is invalid.

+ +

When clipping is enabled during vertex processing (by , , or other drawing functions), Direct3D computes a clip code for every vertex. The clip code is a combination of D3DCS_* bits. When a vertex is outside a particular clipping plane, the corresponding bit is set in the clipping code. Direct3D maintains the clip status using , which has ClipUnion and ClipIntersection members. ClipUnion is a bitwise "OR" of all vertex clip codes and ClipIntersection is a bitwise "AND" of all vertex clip codes. Initial values are zero for ClipUnion and 0xFFFFFFFF for ClipIntersection. When is set to , ClipUnion and ClipIntersection are set to zero. Direct3D updates the clip status during drawing calls. To compute clip status for a particular object, set ClipUnion and ClipIntersection to their initial value and continue drawing.

Clip status is not updated by and because there is no software emulation for them.

Clip status is used during software vertex processing. Therefore, this method is not supported on pure or nonpure hardware processing devices. For more information about pure devices, see .

+
+ + bb174381 + HRESULT IDirect3DDevice9::GetClipStatus([Out] D3DCLIPSTATUS9* pClipStatus) + IDirect3DDevice9::GetClipStatus +
+ + +

Retrieves a texture assigned to a stage for a device.

+
+

Stage identifier of the texture to retrieve. Stage identifiers are zero-based.

+

Address of a reference to an interface, representing the returned texture.

+ +

Typically, methods that return state will not work on a device that is created using . This method however, will work even on a pure device because it returns an interface.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174412 + HRESULT IDirect3DDevice9::GetTexture([In] unsigned int Stage,[Out] IDirect3DBaseTexture9** ppTexture) + IDirect3DDevice9::GetTexture +
+ + +

Assigns a texture to a stage for a device.

+
+

Zero based sampler number. Textures are bound to samplers; samplers define sampling state such as the filtering mode and the address wrapping mode. Textures are referenced differently by the programmable and the fixed function pipeline:

  • Programmable shaders reference textures using the sampler number. The number of samplers available to a programmable shader is dependent on the shader version. For vertex shaders, see Sampler (Direct3D 9 asm-vs). For pixel shaders see Sampler (Direct3D 9 asm-ps).
  • The fixed function pipeline on the other hand, references textures by texture stage number. The maximum number of samplers is determined from two caps: MaxSimultaneousTextures and MaxTextureBlendStages of the structure.

There are two other special cases for stage/sampler numbers.

  • A special number called D3DDMAPSAMPLER is used for Displacement Mapping (Direct3D 9).
  • A programmable vertex shader uses a special number defined by a when accessing Vertex Textures in vs_3_0 (DirectX HLSL).
+

Pointer to an interface, representing the texture being set.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

SetTexture is not allowed if the texture is created with a pool type of . SetTexture is not allowed with a pool type of texture unless DevCaps is set with .

+
+ + bb174461 + HRESULT IDirect3DDevice9::SetTexture([In] unsigned int Stage,[In] IDirect3DBaseTexture9* pTexture) + IDirect3DDevice9::SetTexture +
+ + +

Retrieves a state value for an assigned texture.

+
+

Stage identifier of the texture for which the state is retrieved. Stage identifiers are zero-based. Devices can have up to eight set textures, so the maximum value allowed for Stage is 7.

+

Texture state to retrieve. This parameter can be any member of the enumerated type.

+

Pointer a variable to fill with the retrieved state value. The meaning of the retrieved value is determined by the Type parameter.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other flag values in ."

+
+ + bb174413 + HRESULT IDirect3DDevice9::GetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] void* pValue) + IDirect3DDevice9::GetTextureStageState +
+ + +

Sets the state value for the currently assigned texture.

+
+

Stage identifier of the texture for which the state value is set. Stage identifiers are zero-based. Devices can have up to eight set textures, so the maximum value allowed for Stage is 7.

+

Texture state to set. This parameter can be any member of the enumerated type.

+

State value to set. The meaning of this value is determined by the Type parameter.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174462 + HRESULT IDirect3DDevice9::SetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] unsigned int Value) + IDirect3DDevice9::SetTextureStageState +
+ + +

Gets the sampler state value.

+
+

The sampler stage index.

+

This parameter can be any member of the enumerated type.

+

State value to get. The meaning of this value is determined by the Type parameter.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other values in ."

+
+ + bb174406 + HRESULT IDirect3DDevice9::GetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] void* pValue) + IDirect3DDevice9::GetSamplerState +
+ + +

Sets the sampler state value.

+
+

The sampler stage index.

+

This parameter can be any member of the enumerated type.

+

State value to set. The meaning of this value is determined by the Type parameter.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174456 + HRESULT IDirect3DDevice9::SetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] unsigned int Value) + IDirect3DDevice9::SetSamplerState +
+ + +

Reports the device's ability to render the current texture-blending operations and arguments in a single pass.

+
+

Pointer to a DWORD value to fill with the number of rendering passes needed to complete the desired effect through multipass rendering.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , , , , , , , , , , ,.

+ +

The method should be used to validate scenarios only when other capabilities are deficient. For example, in a multistage texturing scenario, you could query the MaxTextureBlendStages and MaxSimultaneousTextures members of a structure to determine if multistage texturing is possible on the device.

Current hardware does not necessarily implement all possible combinations of operations and arguments. You can determine whether a particular blending operation can be performed with given arguments by setting the desired blending operation, and then calling the method.

The method uses the current render states, textures, and texture-stage states to perform validation at the time of the call. Changes to these factors after the call invalidate the previous result, and the method must be called again before rendering a scene.

For best performance, call at initialization time; do not use it within a render loop.

Using diffuse iterated values, either as an argument or as an operation (D3DTA_DIFFUSED3DTOP_BLENDDIFFUSEALPHA) is rarely supported on current hardware. Most hardware can introduce iterated color data only at the last texture operation stage.

Try to specify the texture () for each stage as the first argument, rather than the second argument.

Many cards do not support use of diffuse or scalar values at arbitrary texture stages. Often, these are available only at the first or last texture-blending stage.

Many cards do not have a blending unit associated with the first texture that is capable of more than replicating alpha to color channels or inverting the input. Therefore, your application might need to use only the second texture stage, if possible. On such hardware, the first unit is presumed to be in its default state, which has the first color argument set to with the operation.

Operations on the output alpha that are more intricate than or substantially different from the color operations are less likely to be supported.

Some hardware does not support simultaneous use of and .

Many cards do not support simultaneous use of multiple textures and mipmapped trilinear filtering. If trilinear filtering has been requested for a texture involved in multitexture blending operations and validation fails, turn off trilinear filtering and revalidate. In this case, you might want to perform multipass rendering instead.

+
+ + bb205859 + HRESULT IDirect3DDevice9::ValidateDevice([In] unsigned int* pNumPasses) + IDirect3DDevice9::ValidateDevice +
+ + +

Sets palette entries.

+
+

An ordinal value identifying the particular palette upon which the operation is to be performed.

+

Pointer to a structure, representing the palette entries to set. The number of structures pointed to by pEntries is assumed to be 256. See Remarks.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For Direct3D 9 applications, any palette sent to this method must conform to the capability bit of the structure. If is not set, every entry in the palette must have alpha set to 1.0 or this method will fail with . If is set, then any set of alpha values are allowed. Note that the debug runtime will print a warning message if all palette entries have alpha set to 0.

A single logical palette is associated with the device, and is shared by all texture stages.

+
+ + bb174439 + HRESULT IDirect3DDevice9::SetPaletteEntries([In] unsigned int PaletteNumber,[In, Buffer] const PALETTEENTRY* pEntries) + IDirect3DDevice9::SetPaletteEntries +
+ + +

Retrieves palette entries.

+
+

An ordinal value identifying the particular palette to retrieve.

+

Pointer to a structure, representing the returned palette entries.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For more information about , see the Platform SDK.

Note??As of Direct3D 9, the peFlags member of the structure does not work the way it is documented in the Platform SDK. The peFlags member is now the alpha channel for 8-bit palettized formats.

+
+ + bb174397 + HRESULT IDirect3DDevice9::GetPaletteEntries([In] unsigned int PaletteNumber,[In, Buffer] PALETTEENTRY* pEntries) + IDirect3DDevice9::GetPaletteEntries +
+ + +

Sets the current texture palette.

+
+

Value that specifies the texture palette to set as the current texture palette.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A single logical palette is associated with the device, and is shared by all texture stages.

+
+ + bb174428 + HRESULT IDirect3DDevice9::SetCurrentTexturePalette([In] unsigned int PaletteNumber) + IDirect3DDevice9::SetCurrentTexturePalette +
+ + +

Retrieves the current texture palette.

+
+

Pointer to a returned value that identifies the current texture palette.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ + bb174383 + HRESULT IDirect3DDevice9::GetCurrentTexturePalette([Out] unsigned int* PaletteNumber) + IDirect3DDevice9::GetCurrentTexturePalette +
+ + +

Sets the scissor rectangle.

+
+

Pointer to a structure that defines the rendering area within the render target if scissor test is enabled. This parameter may not be null.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

The scissor rectangle is used as a rectangular clipping region.

See Rectangles (Direct3D 9) for further information on the use of rectangles in DirectX.

+
+ + bb174457 + HRESULT IDirect3DDevice9::SetScissorRect([In] const RECT* pRect) + IDirect3DDevice9::SetScissorRect +
+ + +

Gets the scissor rectangle.

+
+

Returns a reference to a structure that defines the rendering area within the render target if scissor test is enabled.

+

If the method succeeds, the return value is . If the method fails, the return value can be the following: .

+ +

The scissor rectangle is used as a rectangular clipping region.

See Rectangles (Direct3D 9) for further information on the use of rectangles in DirectX.

+
+ + bb174407 + HRESULT IDirect3DDevice9::GetScissorRect([Out] RECT* pRect) + IDirect3DDevice9::GetScissorRect +
+ + +

Use this method to switch between software and hardware vertex processing.

+
+

TRUE to specify software vertex processing; to specify hardware vertex processing.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

The restrictions for changing modes are as follows:

  • If a device is created with , the vertex processing will be done in software and cannot be changed.
  • If a device is created with , the vertex processing will be done in hardware and cannot be changed.
  • If a device is created with , the vertex processing will be done in hardware by default. The processing can be switched to software (or back to hardware) using .

An application can create a mixed-mode device to use both the software vertex processing and the hardware vertex processing. To switch between the two vertex processing modes in DirectX 8.x, use IDirect3DDevice8::SetRenderState with the render state D3DRS_SOFTWAREVERTEXPROCESSING and the appropriate DWORD argument. The drawback of the render state approach was the difficulty in defining the semantics for state blocks. Applications and the runtime had to do extra work and be careful while recording and playing back state blocks.

In Direct3D 9, use SetSoftwareVertexProcessing instead. This new API is not recorded by StateBlocks.

+
+ + bb174458 + HRESULT IDirect3DDevice9::SetSoftwareVertexProcessing([In] BOOL bSoftware) + IDirect3DDevice9::SetSoftwareVertexProcessing +
+ + +

Gets the vertex processing (hardware or software) mode.

+
+

Returns TRUE if software vertex processing is set. Otherwise, it returns .

+ +

An application can create a mixed-mode device to use both the software vertex processing and the hardware vertex processing. To switch between the two vertex processing modes in DirectX 8.x, use with the render state D3DRS_SOFTWAREVERTEXPROCESSING and the appropriate argument. The drawback of the render state approach was the difficulty in defining the semantics for state blocks. Applications and the runtime had to do extra work and be careful while recording and playing back state blocks.

In Direct3D 9, use instead. This new API is not recorded by StateBlocks.

+
+ + bb174408 + BOOL IDirect3DDevice9::GetSoftwareVertexProcessing() + IDirect3DDevice9::GetSoftwareVertexProcessing +
+ + +

Enable or disable N-patches.

+
+

Specifies the number of subdivision segments. If the number of segments is less than 1.0, N-patches are disabled. The default value is 0.0.

+

If the method succeeds, the return value is .

+ + bb174438 + HRESULT IDirect3DDevice9::SetNPatchMode([In] float nSegments) + IDirect3DDevice9::SetNPatchMode +
+ + +

Gets the N-patch mode segments.

+
+

Specifies the number of subdivision segments. If the number of segments is less than 1.0, N-patches are disabled. The default value is 0.0.

+ + bb174395 + float IDirect3DDevice9::GetNPatchMode() + IDirect3DDevice9::GetNPatchMode +
+ + +

Renders a sequence of nonindexed, geometric primitives of the specified type from the current set of data input streams.

+
+

Member of the enumerated type, describing the type of primitive to render.

+

Index of the first vertex to load. Beginning at StartVertex the correct number of vertices will be read out of the vertex buffer.

+

Number of primitives to render. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure. PrimitiveCount is the number of primitives as determined by the primitive type. If it is a line list, each primitive has two vertices. If it is a triangle list, each primitive has three vertices.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

When converting a legacy application to Direct3D 9, you must add a call to either to use the fixed function pipeline, or to use a vertex shader before you make any Draw calls.

+
+ + bb174371 + HRESULT IDirect3DDevice9::DrawPrimitive([In] D3DPRIMITIVETYPE PrimitiveType,[In] unsigned int StartVertex,[In] unsigned int PrimitiveCount) + IDirect3DDevice9::DrawPrimitive +
+ + +

Based on indexing, renders the specified geometric primitive into an array of vertices.

+
+

Member of the enumerated type, describing the type of primitive to render. is not supported with this method. See Remarks.

+

Offset from the start of the vertex buffer to the first vertex. See Scenario 4.

+

Minimum vertex index for vertices used during this call. This is a zero based index relative to BaseVertexIndex.

+

Number of vertices used during this call. The first vertex is located at index: BaseVertexIndex + MinIndex.

+

Index of the first index to use when accesssing the vertex buffer. Beginning at StartIndex to index vertices from the vertex buffer.

+

Number of primitives to render. The number of vertices used is a function of the primitive count and the primitive type. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure.

+

If the method succeeds, the return value is . If the method fails, the return value can be the following: .

+ +

This method draws indexed primitives from the current set of data input streams. MinIndex and all the indices in the index stream are relative to the BaseVertexIndex.

The MinIndex and NumVertices parameters specify the range of vertex indices used for each call. These are used to optimize vertex processing of indexed primitives by processing a sequential range of vertices prior to indexing into these vertices. It is invalid for any indices used during this call to reference any vertices outside of this range.

fails if no index array is set.

The member of the enumerated type is not supported and is not a valid type for this method.

When converting a legacy application to Direct3D 9, you must add a call to either to use the fixed function pipeline, or to use a vertex shader before you make any Draw calls.

+
+ + bb174369 + HRESULT IDirect3DDevice9::DrawIndexedPrimitive([In] D3DPRIMITIVETYPE arg0,[In] int BaseVertexIndex,[In] unsigned int MinVertexIndex,[In] unsigned int NumVertices,[In] unsigned int startIndex,[In] unsigned int primCount) + IDirect3DDevice9::DrawIndexedPrimitive +
+ + +

Renders data specified by a user memory reference as a sequence of geometric primitives of the specified type.

+
+

Member of the enumerated type, describing the type of primitive to render.

+

Number of primitives to render. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure.

+

User memory reference to the vertex data.

+

The number of bytes of data for each vertex. This value may not be 0.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ +

This method is intended for use in applications that are unable to store their vertex data in vertex buffers. This method supports only a single vertex stream. The effect of this call is to use the provided vertex data reference and stride for vertex stream 0. It is invalid to have the declaration of the current vertex shader refer to vertex streams other than stream 0.

Following any call, the stream 0 settings, referenced by , are set to null.

The vertex data passed to does not need to persist after the call. Direct3D completes its access to that data prior to returning from the call.

When converting a legacy application to Direct3D 9, you must add a call to either to use the fixed function pipeline, or to use a vertex shader before you make any Draw calls.

+
+ + bb174372 + HRESULT IDirect3DDevice9::DrawPrimitiveUP([In] D3DPRIMITIVETYPE PrimitiveType,[In] unsigned int PrimitiveCount,[In] const void* pVertexStreamZeroData,[In] unsigned int VertexStreamZeroStride) + IDirect3DDevice9::DrawPrimitiveUP +
+ + +

Renders the specified geometric primitive with data specified by a user memory reference.

+
+

Member of the enumerated type, describing the type of primitive to render.

+

Minimum vertex index. This is a zero-based index.

+

Number of vertices used during this call. The first vertex is located at index: MinVertexIndex.

+

Number of primitives to render. The maximum number of primitives allowed is determined by checking the MaxPrimitiveCount member of the structure (the number of indices is a function of the primitive count and the primitive type).

+

User memory reference to the index data.

+

Member of the enumerated type, describing the format of the index data. The valid settings are either:

+

User memory reference to the vertex data. The vertex data must be in stream 0.

+

The number of bytes of data for each vertex. This value may not be 0.

+

If the method succeeds, the return value is . If the method fails, the return value can be the following: .

+ +

This method is intended for use in applications that are unable to store their vertex data in vertex buffers. This method supports only a single vertex stream, which must be declared as stream 0.

Following any call, the stream 0 settings, referenced by , are set to null. Also, the index buffer setting for is set to null.

The vertex data passed to does not need to persist after the call. Direct3D completes its access to that data prior to returning from the call.

When converting a legacy application to Direct3D 9, you must add a call to either to use the fixed function pipeline, or to use a vertex shader before you make any Draw calls.

+
+ + bb174370 + HRESULT IDirect3DDevice9::DrawIndexedPrimitiveUP([In] D3DPRIMITIVETYPE PrimitiveType,[In] unsigned int MinVertexIndex,[In] unsigned int NumVertices,[In] unsigned int PrimitiveCount,[In] const void* pIndexData,[In] D3DFORMAT IndexDataFormat,[In] const void* pVertexStreamZeroData,[In] unsigned int VertexStreamZeroStride) + IDirect3DDevice9::DrawIndexedPrimitiveUP +
+ + +

Applies the vertex processing defined by the vertex shader to the set of input data streams, generating a single stream of interleaved vertex data to the destination vertex buffer.

+
+

Index of first vertex to load.

+

Index of first vertex in the destination vertex buffer into which the results are placed.

+

Number of vertices to process.

+

Pointer to an interface, the destination vertex buffer representing the stream of interleaved vertex data.

+

Pointer to an interface that represents the output vertex data declaration. When vertex shader 3.0 or above is set as the current vertex shader, the output vertex declaration must be present.

+

Processing options. Set this parameter to 0 for default processing. Set to D3DPV_DONOTCOPYDATA to prevent the system from copying vertex data not affected by the vertex operation into the destination buffer. The D3DPV_DONOTCOPYDATA value may be combined with one or more values appropriate for the destination buffer.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

The order of operations for this method is as follows:

  • Transform vertices to projection space using the world + view + projection matrix.
  • Compute screen coordinates using viewport settings.
  • If clipping is enabled, compute clipping codes and store them in an internal buffer, associated with the destination vertex buffer. If a vertex is inside the viewing frustum, its screen coordinates are computed. If the vertex is outside the viewing frustum, the vertex is stored in the destination vertex buffer in projection space coordinates.
  • Other notes: The user does not have access to the internal clip code buffer. No clipping is done on triangles or any other primitives.

The destination vertex buffer, pDestBuffer, must be created with a nonzero FVF parameter in . The FVF code specified during the call to the method specifies the vertex elements present in the destination vertex buffer.

When Direct3D generates texture coordinates, or copies or transforms input texture coordinates, and the output texture coordinate format defines more texture coordinate components than Direct3D generates, Direct3D does not change these extra components.

+
+ + bb174424 + HRESULT IDirect3DDevice9::ProcessVertices([In] unsigned int SrcStartIndex,[In] unsigned int DestIndex,[In] unsigned int VertexCount,[In] IDirect3DVertexBuffer9* pDestBuffer,[In] IDirect3DVertexDeclaration9* pVertexDecl,[In] D3DLOCK Flags) + IDirect3DDevice9::ProcessVertices +
+ + +

Create a vertex shader declaration from the device and the vertex elements.

+
+

An array of vertex elements.

+

Pointer to an reference that returns the created vertex shader declaration.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

See the Vertex Declaration (Direct3D 9) page for a detailed description of how to map vertex declarations between different versions of DirectX.

+
+ + bb174365 + HRESULT IDirect3DDevice9::CreateVertexDeclaration([In, Buffer] const D3DVERTEXELEMENT9* pVertexElements,[Out, Fast] IDirect3DVertexDeclaration9** ppDecl) + IDirect3DDevice9::CreateVertexDeclaration +
+ + +

Sets a Vertex Declaration (Direct3D 9).

+
+ No documentation. +

If the method succeeds, the return value is . The return value can be .

+ +

A vertex declaration is an object that defines the data members of a vertex (i.e. texture coordinates, colors, normals, etc.). This data can be useful for implementing vertex shaders and pixel shaders.

+
+ + bb174464 + HRESULT IDirect3DDevice9::SetVertexDeclaration([In] IDirect3DVertexDeclaration9* pDecl) + IDirect3DDevice9::SetVertexDeclaration +
+ + +

Gets a vertex shader declaration.

+
+

Pointer to an object that is returned.

+

If the method succeeds, the return value is . The return value can be .

+ + bb174415 + HRESULT IDirect3DDevice9::GetVertexDeclaration([Out] IDirect3DVertexDeclaration9** ppDecl) + IDirect3DDevice9::GetVertexDeclaration +
+ + +

Sets the current vertex stream declaration.

+
+

DWORD containing the fixed function vertex type. For more information, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ +

Here are the steps necessary to initialize and use vertices that have a position, diffuse and specular color, and texture coordinates:

  1. Define the custom vertex type and FVF code.
     struct LVertex	
    +            { FLOAT    x, y, z;  specular, diffuse; FLOAT    tu, tv;	
    +            }; const DWORD VertexFVF = ( |  |  |  );	
    +            
  2. Create a vertex buffer with enough room for four vertices using .
     g_d3dDevice->CreateVertexBuffer( 4*sizeof(LVertex),   , VertexFVF, , &pBigSquareVB, null );	
    +            
  3. Set the values for each vertex.
     LVertex * v;	
    +            pBigSquareVB->Lock( 0, 0, (BYTE**)&v, 0 ); v[0].x  = 0.0f;  v[0].y  = 10.0;  v[0].z  = 10.0f;	
    +            v[0].diffuse  = 0xffff0000;	
    +            v[0].specular = 0xff00ff00;	
    +            v[0].tu = 0.0f;  v[0].tv = 0.0f; v[1].x  = 0.0f;  v[1].y  = 0.0f;  v[1].z  = 10.0f;	
    +            v[1].diffuse  = 0xff00ff00;	
    +            v[1].specular = 0xff00ffff;	
    +            v[1].tu = 0.0f;  v[1].tv = 0.0f; v[2].x  = 10.0f; v[2].y  = 10.0f; v[2].z  = 10.0f;	
    +            v[2].diffuse  = 0xffff00ff;	
    +            v[2].specular = 0xff000000;	
    +            v[2].tu = 0.0f;  v[2].tv = 0.0f; v[3].x  = 0.0f; v[3].y  = 10.0f;  v[3].z = 10.0f;	
    +            v[3].diffuse  = 0xffffff00;	
    +            v[3].specular = 0xffff0000;	
    +            v[3].tu = 0.0f; v[3].tv = 0.0f; pBigSquareVB->Unlock();	
    +            
  4. The vertex buffer has been initialized and is ready to render. The following code example shows how to use the legacy FVF to draw a square.
     g_d3dDevice->SetFVF(VertexFVF);	
    +            g_d3dDevice->SetStreamSource(0, pBigSquareVB, 0, sizeof(LVertex));	
    +            g_d3dDevice->DrawPrimitive(, 0 ,2);	
    +            

Here are the steps necessary to initialize and use vertices that have a position, a normal, and texture coordinates:

  1. Define the custom vertex type and FVF code.
     struct Vertex	
    +            { FLOAT x, y, z; FLOAT nx, ny, nz; FLOAT tu, tv;	
    +            }; const DWORD VertexFVF = (  |  |  );	
    +            
  2. Create a vertex buffer with enough room for four vertices using (similar to the example above).
  3. Set the values for each vertex.
     Vertex * v;	
    +            pBigSquareVB->Lock(0, 0, (BYTE**)&v, 0); v[0].x  = 0.0f;  v[0].y  = 10.0;  v[0].z  = 10.0f;	
    +            v[0].nx = 0.0f;  v[0].ny = 1.0f;  v[0].nz = 0.0f;	
    +            v[0].tu = 0.0f;  v[0].tv = 0.0f; v[1].x  = 0.0f;  v[1].y  = 0.0f;  v[1].z  = 10.0f;	
    +            v[1].nx = 0.0f;  v[1].ny = 1.0f;  v[1].nz = 0.0f;	
    +            v[1].tu = 0.0f;  v[1].tv = 0.0f; v[2].x  = 10.0f; v[2].y  = 10.0f; v[2].z  = 10.0f;	
    +            v[2].nx = 0.0f;  v[2].ny = 1.0f;  v[2].nz = 0.0f;	
    +            v[2].tu = 0.0f;  v[2].tv = 0.0f; v[3].x  = 0.0f; v[3].y  = 10.0f;  v[3].z = 10.0f;	
    +            v[3].nx = 0.0f; v[3].ny = 1.0f;   v[3].nz = 0.0f;	
    +            v[3].tu = 0.0f; v[3].tv = 0.0f; pBigSquareVB->Unlock();	
    +            
  4. Draw the object (similar to the example above).
+
+ + bb174433 + HRESULT IDirect3DDevice9::SetFVF([In] D3DFVF FVF) + IDirect3DDevice9::SetFVF +
+ + +

Gets the fixed vertex function declaration.

+
+

A DWORD reference to the fixed function vertex type. For more information, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

The fixed vertex function declaration is a set of FVF flags that determine how vertices processed by the fixed function pipeline will be used.

+
+ + bb174389 + HRESULT IDirect3DDevice9::GetFVF([Out] D3DFVF* pFVF) + IDirect3DDevice9::GetFVF +
+ + +

Creates a vertex shader.

+
+

Pointer to an array of tokens that represents the vertex shader, including any embedded debug and symbol table information.

  • Use a function such as to create the array from a HLSL shader.
  • Use a function like to create the token array from an assembly language shader.
  • Use a function like to create the array from an effect.
+

Pointer to the returned vertex shader interface (see ).

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , E_OUTOFMEMORY.

+ +

When a device is created, uses the behavior flag to determine whether to process vertices in hardware or software. There are three possibilities:

  • Process vertices in hardware by setting .
  • Process vertices in software by setting .
  • Process vertices in either hardware or software by setting . To switch a mixed-mode device between software and hardware processing, use .

For an example using , see HLSLwithoutEffects Sample.

+
+ + bb174366 + HRESULT IDirect3DDevice9::CreateVertexShader([In] const void* pFunction,[Out, Fast] IDirect3DVertexShader9** ppShader) + IDirect3DDevice9::CreateVertexShader +
+ + +

Sets the vertex shader.

+
+

Vertex shader interface. For more information, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

To set a fixed-function vertex shader (after having set a programmable vertex shader), call (null) to release the programmable shader, and then call with the fixed-function vertex format.

+
+ + bb174465 + HRESULT IDirect3DDevice9::SetVertexShader([In] IDirect3DVertexShader9* pShader) + IDirect3DDevice9::SetVertexShader +
+ + +

Retrieves the currently set vertex shader.

+
+

Pointer to a vertex shader interface.

+

If the method succeeds, the return value is . If ppShader is invalid, is returned.

+ +

Typically, methods that return state will not work on a device that is created using . This method however, will work even on a pure device because it returns an interface.

+
+ + bb174416 + HRESULT IDirect3DDevice9::GetVertexShader([Out] IDirect3DVertexShader9** ppShader) + IDirect3DDevice9::GetVertexShader +
+ + +

Sets a floating-point vertex shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four float vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174467 + HRESULT IDirect3DDevice9::SetVertexShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + IDirect3DDevice9::SetVertexShaderConstantF +
+ + +

Gets a floating-point vertex shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four float vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174418 + HRESULT IDirect3DDevice9::GetVertexShaderConstantF([In] unsigned int StartRegister,[In, Buffer] float* pConstantData,[In] unsigned int Vector4fCount) + IDirect3DDevice9::GetVertexShaderConstantF +
+ + +

Sets an integer vertex shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four integer vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174468 + HRESULT IDirect3DDevice9::SetVertexShaderConstantI([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4iCount) + IDirect3DDevice9::SetVertexShaderConstantI +
+ + +

Gets an integer vertex shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four integer vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174419 + HRESULT IDirect3DDevice9::GetVertexShaderConstantI([In] unsigned int StartRegister,[In, Buffer] int* pConstantData,[In] unsigned int Vector4iCount) + IDirect3DDevice9::GetVertexShaderConstantI +
+ + +

Sets a Boolean vertex shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of boolean values in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174466 + HRESULT IDirect3DDevice9::SetVertexShaderConstantB([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int BoolCount) + IDirect3DDevice9::SetVertexShaderConstantB +
+ + +

Gets a Boolean vertex shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of Boolean values in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174417 + HRESULT IDirect3DDevice9::GetVertexShaderConstantB([In] unsigned int StartRegister,[In] void* pConstantData,[In] unsigned int BoolCount) + IDirect3DDevice9::GetVertexShaderConstantB +
+ + +

Binds a vertex buffer to a device data stream. For more information, see Setting the Stream Source (Direct3D 9).

+
+ No documentation. + No documentation. + No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

When a FVF vertex shader is used, the stride of the vertex stream must match the vertex size, computed from the FVF. When a declaration is used, the stride should be greater than or equal to the stream size computed from the declaration.

When calling SetStreamSource, the stride is normally required to be equal to the vertex size. However, there are times when you may want to draw multiple instances of the same or similar geometry (such as when using instancing to draw). For this case, use a zero stride to tell the runtime not to increment the vertex buffer offset (ie: use the same vertex data for all instances). For more information about instancing, see Efficiently Drawing Multiple Instances of Geometry (Direct3D 9).

+
+ + bb174459 + HRESULT IDirect3DDevice9::SetStreamSource([In] unsigned int StreamNumber,[In] IDirect3DVertexBuffer9* pStreamData,[In] unsigned int OffsetInBytes,[In] unsigned int Stride) + IDirect3DDevice9::SetStreamSource +
+ + +

Retrieves a vertex buffer bound to the specified data stream.

+
+

Specifies the data stream, in the range from 0 to the maximum number of streams minus one.

+

Address of a reference to an interface, representing the returned vertex buffer bound to the specified data stream.

+

Pointer containing the offset from the beginning of the stream to the beginning of the vertex data. The offset is measured in bytes. See Remarks.

+

Pointer to a returned stride of the component, in bytes. See Remarks.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A stream is defined as a uniform array of component data, where each component consists of one or more elements representing a single entity such as position, normal, color, and so on.

When a FVF vertex shader is used, the stride of the vertex stream must match the vertex size, computed from the FVF. When a declaration is used, the stride should be greater than or equal to the stream size computed from the declaration.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174409 + HRESULT IDirect3DDevice9::GetStreamSource([In] unsigned int StreamNumber,[Out] IDirect3DVertexBuffer9** ppStreamData,[Out] unsigned int* pOffsetInBytes,[Out] unsigned int* pStride) + IDirect3DDevice9::GetStreamSource +
+ + +

Sets the stream source frequency divider value. This may be used to draw several instances of geometry.

+
+

Stream source number.

+

This parameter may have two different values. See remarks.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

There are two constants defined in d3d9types.h that are designed to use with SetStreamSourceFreq: and . To see how to use the constants, see Efficiently Drawing Multiple Instances of Geometry (Direct3D 9).

+
+ + bb174460 + HRESULT IDirect3DDevice9::SetStreamSourceFreq([In] unsigned int StreamNumber,[In] unsigned int Setting) + IDirect3DDevice9::SetStreamSourceFreq +
+ + +

Gets the stream source frequency divider value.

+
+

Stream source number.

+

Returns the frequency divider value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Vertex shaders can now be invoked more than once per vertex. See Drawing Non-Indexed Geometry.

+
+ + bb174410 + HRESULT IDirect3DDevice9::GetStreamSourceFreq([In] unsigned int StreamNumber,[Out] unsigned int* pSetting) + IDirect3DDevice9::GetStreamSourceFreq +
+ + +

Sets index data.

+
+

Pointer to an interface, representing the index data to be set.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ +

When an application no longer holds a references to this interface, the interface will automatically be freed.

The method sets the current index array to an index buffer. The single set of indices is used to index all streams.

+
+ + bb174435 + HRESULT IDirect3DDevice9::SetIndices([In] IDirect3DIndexBuffer9* pIndexData) + IDirect3DDevice9::SetIndices +
+ + +

Retrieves index data.

+
+

Address of a reference to an interface, representing the returned index data.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174391 + HRESULT IDirect3DDevice9::GetIndices([Out] IDirect3DIndexBuffer9** ppIndexData) + IDirect3DDevice9::GetIndices +
+ + +

Creates a pixel shader.

+
+

Pointer to the pixel shader function token array, specifying the blending operations. This value cannot be null.

+

Pointer to the returned pixel shader interface. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , E_OUTOFMEMORY.

+ + bb174359 + HRESULT IDirect3DDevice9::CreatePixelShader([In] const void* pFunction,[Out, Fast] IDirect3DPixelShader9** ppShader) + IDirect3DDevice9::CreatePixelShader +
+ + +

Sets the current pixel shader to a previously created pixel shader.

+
+

Pixel shader interface.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174450 + HRESULT IDirect3DDevice9::SetPixelShader([In] IDirect3DPixelShader9* pShader) + IDirect3DDevice9::SetPixelShader +
+ + +

Retrieves the currently set pixel shader.

+
+

Pointer to a pixel shader interface.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method will not work on a device that is created using .

+
+ + bb174398 + HRESULT IDirect3DDevice9::GetPixelShader([Out] IDirect3DPixelShader9** ppShader) + IDirect3DDevice9::GetPixelShader +
+ + +

Sets a floating-point shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four float vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + Bb174452 + HRESULT IDirect3DDevice9::SetPixelShaderConstantF([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4fCount) + IDirect3DDevice9::SetPixelShaderConstantF +
+ + +

Gets a floating-point shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four float vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174400 + HRESULT IDirect3DDevice9::GetPixelShaderConstantF([In] unsigned int StartRegister,[In, Buffer] float* pConstantData,[In] unsigned int Vector4fCount) + IDirect3DDevice9::GetPixelShaderConstantF +
+ + +

Sets an integer shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four integer vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174453 + HRESULT IDirect3DDevice9::SetPixelShaderConstantI([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int Vector4iCount) + IDirect3DDevice9::SetPixelShaderConstantI +
+ + +

Gets an integer shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of four integer vectors in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174401 + HRESULT IDirect3DDevice9::GetPixelShaderConstantI([In] unsigned int StartRegister,[In, Buffer] int* pConstantData,[In] unsigned int Vector4iCount) + IDirect3DDevice9::GetPixelShaderConstantI +
+ + +

Sets a Boolean shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of boolean values in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174451 + HRESULT IDirect3DDevice9::SetPixelShaderConstantB([In] unsigned int StartRegister,[In] const void* pConstantData,[In] unsigned int BoolCount) + IDirect3DDevice9::SetPixelShaderConstantB +
+ + +

Gets a Boolean shader constant.

+
+

Register number that will contain the first constant value.

+

Pointer to an array of constants.

+

Number of Boolean values in the array of constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174399 + HRESULT IDirect3DDevice9::GetPixelShaderConstantB([In] unsigned int StartRegister,[In] void* pConstantData,[In] unsigned int BoolCount) + IDirect3DDevice9::GetPixelShaderConstantB +
+ + +

Draws a rectangular patch using the currently set streams.

+
+

Handle to the rectangular patch to draw.

+

Pointer to an array of four floating-point values that identify the number of segments each edge of the rectangle patch should be divided into when tessellated. See .

+

Pointer to a structure, describing the rectangular patch to draw.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For static patches: Set the vertex shader, set the appropriate streams, supply patch information in the pRectPatchInfo parameter, and specify a handle so that Direct3D can capture and cache information. Call subsequently with pRectPatchInfo set to null to efficiently draw the patch. When drawing a cached patch, the currently set streams are ignored. Override the cached pNumSegs by specifying a new value for pNumSegs. When rendering a cached patch, you must set the same vertex shader that was set when it was captured.

Calling with a handle invalidates the same handle cached by a previous call.

For dynamic patches, the patch data changes for every rendering of the patch, so it is not efficient to cache information. The application can convey this to Direct3D by setting Handle to 0. In this case, Direct3D draws the patch using the currently set streams and the pNumSegs values, and does not cache any information. It is not valid to simultaneously set Handle to 0 and pRectPatchInfo to null.

+
+ + bb174373 + HRESULT IDirect3DDevice9::DrawRectPatch([In] unsigned int Handle,[In, Buffer] const float* pNumSegs,[In] const void* pRectPatchInfo) + IDirect3DDevice9::DrawRectPatch +
+ + +

Draws a triangular patch using the currently set streams.

+
+

Handle to the triangular patch to draw.

+

Pointer to an array of three floating-point values that identify the number of segments each edge of the triangle patch should be divided into when tessellated. See .

+

Pointer to a structure, describing the triangular high-order patch to draw.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For static patches: Set the vertex shader, set the appropriate streams, supply patch information in the pTriPatchInfo parameter, and specify a handle so that Direct3D can capture and cache information. To efficiently draw the patch, call with pTriPatchInfo set to null. When drawing a cached patch, the currently set streams are ignored. Override the cached pNumSegs by specifying a new value for pNumSegs. When rendering a cached patch, you must set the same vertex shader that was set when it was captured.

Calling with a handle invalidates the same handle cached by a previous call.

For dynamic patches, the patch data changes for every rendering of the patch so it is not efficient to cache information. The application can convey this to Direct3D by setting Handle to 0. In this case, Direct3D draws the patch using the currently set streams and the pNumSegs values, and does not cache any information. It is not valid to simultaneously set Handle to 0 and pTriPatchInfo to null.

+
+ + bb174374 + HRESULT IDirect3DDevice9::DrawTriPatch([In] unsigned int Handle,[In, Buffer] const float* pNumSegs,[In] const void* pTriPatchInfo) + IDirect3DDevice9::DrawTriPatch +
+ + +

Frees a cached high-order patch.

+
+

Handle of the cached high-order patch to delete.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174368 + HRESULT IDirect3DDevice9::DeletePatch([In] unsigned int Handle) + IDirect3DDevice9::DeletePatch +
+ + +

Creates a status query.

+
+

Identifies the query type. For more information, see .

+

Returns a reference to the query interface that manages the query object. See .

This parameter can be set to null to see if a query is supported. If the query is not supported, the method returns .

+

If the method succeeds, the return value is . If the method fails, the return value can be or E_OUTOFMEMORY.

+ +

This method is provided for both synchronous and asynchronous queries. It takes the place of GetInfo, which is no longer supported in Direct3D 9.

Synchronous and asynchronous queries are created with with . When a query has been created and the API calls have been made that are being queried, use to issue a query and to get the results of the query.

+
+ + bb174360 + HRESULT IDirect3DDevice9::CreateQuery([In] D3DQUERYTYPE Type,[Out, Fast] IDirect3DQuery9** ppQuery) + IDirect3DDevice9::CreateQuery +
+ + + Gets the available texture memory. + + + + + Gets the driver level. + + + + + Gets the pixel shader profile. + + + + + Gets the vertex shader profile. + + + + + Gets or sets a value indicating whether the cursor can be displayed. + + + true if the cursor can be displayed; otherwise, false. + + + + +

Returns an interface to the instance of the Direct3D object that created the device.

+
+ +

Calling will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174386 + GetDirect3D + GetDirect3D + HRESULT IDirect3DDevice9::GetDirect3D([Out] IDirect3D9** ppD3D9) +
+ + +

Retrieves the capabilities of the rendering device.

+
+ +

retrieves the software vertex pipeline capabilities when the device is being used in software vertex processing mode.

+
+ + bb174385 + GetDeviceCaps + GetDeviceCaps + HRESULT IDirect3DDevice9::GetDeviceCaps([Out] D3DCAPS9* pCaps) +
+ + +

Retrieves the creation parameters of the device.

+
+ +

You can query the AdapterOrdinal member of the returned structure to retrieve the ordinal of the adapter represented by this device.

+
+ + bb174382 + GetCreationParameters + GetCreationParameters + HRESULT IDirect3DDevice9::GetCreationParameters([Out] D3DDEVICE_CREATION_PARAMETERS* pParameters) +
+ + +

Gets the number of implicit swap chains.

+
+ +

Implicit swap chains are created by the device during . This method returns the number of swap chains created by CreateDevice.

An application may create additional swap chains using .

+
+ + bb174396 + GetNumberOfSwapChains + GetNumberOfSwapChains + unsigned int IDirect3DDevice9::GetNumberOfSwapChains() +
+ + +

This method allows the use of GDI dialog boxes in full-screen mode applications.

+
+ +

The GDI dialog boxes must be created as child to the device window. They should also be created within the same thread that created the device because this enables the parent window to manage redrawing the child window.

The method has no effect for windowed mode applications, but this setting will be respected if the application resets the device into full-screen mode. If SetDialogBoxMode succeeds in a windowed mode application, any subsequent reset to full-screen mode will be checked against the restrictions listed above. Also, SetDialogBoxMode causes all back buffers on the swap chain to be discarded, so an application is expected to refresh its content for all back buffers after this call.

+
+ + bb174432 + SetDialogBoxMode + SetDialogBoxMode + HRESULT IDirect3DDevice9::SetDialogBoxMode([In] BOOL bEnableDialogs) +
+ + +

Gets or sets the depth-stencil surface owned by the Direct3DDevice object.

+
+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174384 + GetDepthStencilSurface / SetDepthStencilSurface + GetDepthStencilSurface + HRESULT IDirect3DDevice9::GetDepthStencilSurface([Out] IDirect3DSurface9** ppZStencilSurface) +
+ + +

Retrieves or sets the viewport parameters currently set for the device.

+
+ +

Typically, methods that return state will not work on a device that is created using . This method however, will work even on a pure device.

+
+ + bb174420 + GetViewport / SetViewport + GetViewport + HRESULT IDirect3DDevice9::GetViewport([Out] D3DVIEWPORT9* pViewport) +
+ + +

Retrieves or sets the current material properties for the device.

+
+ +

This method will not return device state for a device that is created using . If you want to use this method, you must create your device with any of the other values in .

+
+ + bb174394 + GetMaterial / SetMaterial + GetMaterial + HRESULT IDirect3DDevice9::GetMaterial([Out] D3DMATERIAL9* pMaterial) +
+ + +

Retrieves or sets the clip status.

+
+ +

When clipping is enabled during vertex processing (by , , or other drawing functions), Direct3D computes a clip code for every vertex. The clip code is a combination of D3DCS_* bits. When a vertex is outside a particular clipping plane, the corresponding bit is set in the clipping code. Direct3D maintains the clip status using , which has ClipUnion and ClipIntersection members. ClipUnion is a bitwise "OR" of all vertex clip codes and ClipIntersection is a bitwise "AND" of all vertex clip codes. Initial values are zero for ClipUnion and 0xFFFFFFFF for ClipIntersection. When is set to , ClipUnion and ClipIntersection are set to zero. Direct3D updates the clip status during drawing calls. To compute clip status for a particular object, set ClipUnion and ClipIntersection to their initial value and continue drawing.

Clip status is not updated by and because there is no software emulation for them.

Clip status is used during software vertex processing. Therefore, this method is not supported on pure or nonpure hardware processing devices. For more information about pure devices, see .

+
+ + bb174381 + GetClipStatus / SetClipStatus + GetClipStatus + HRESULT IDirect3DDevice9::GetClipStatus([Out] D3DCLIPSTATUS9* pClipStatus) +
+ + +

Retrieves or sets the current texture palette.

+
+ + bb174383 + GetCurrentTexturePalette / SetCurrentTexturePalette + GetCurrentTexturePalette + HRESULT IDirect3DDevice9::GetCurrentTexturePalette([Out] unsigned int* PaletteNumber) +
+ + +

Gets or sets the scissor rectangle.

+
+ +

The scissor rectangle is used as a rectangular clipping region.

See Rectangles (Direct3D 9) for further information on the use of rectangles in DirectX.

+
+ + bb174407 + GetScissorRect / SetScissorRect + GetScissorRect + HRESULT IDirect3DDevice9::GetScissorRect([Out] RECT* pRect) +
+ + +

Gets or sets the vertex processing (hardware or software) mode.

+
+ +

An application can create a mixed-mode device to use both the software vertex processing and the hardware vertex processing. To switch between the two vertex processing modes in DirectX 8.x, use with the render state D3DRS_SOFTWAREVERTEXPROCESSING and the appropriate argument. The drawback of the render state approach was the difficulty in defining the semantics for state blocks. Applications and the runtime had to do extra work and be careful while recording and playing back state blocks.

In Direct3D 9, use instead. This new API is not recorded by StateBlocks.

+
+ + bb174408 + GetSoftwareVertexProcessing / SetSoftwareVertexProcessing + GetSoftwareVertexProcessing + BOOL IDirect3DDevice9::GetSoftwareVertexProcessing() +
+ + +

Gets or sets the N-patch mode segments.

+
+ + bb174395 + GetNPatchMode / SetNPatchMode + GetNPatchMode + float IDirect3DDevice9::GetNPatchMode() +
+ + +

Gets or sets a vertex shader declaration.

+
+ + bb174415 + GetVertexDeclaration / SetVertexDeclaration + GetVertexDeclaration + HRESULT IDirect3DDevice9::GetVertexDeclaration([Out] IDirect3DVertexDeclaration9** ppDecl) +
+ + +

Gets or sets the fixed vertex function declaration.

+
+ +

The fixed vertex function declaration is a set of FVF flags that determine how vertices processed by the fixed function pipeline will be used.

+
+ + bb174389 + GetFVF / SetFVF + GetFVF + HRESULT IDirect3DDevice9::GetFVF([Out] D3DFVF* pFVF) +
+ + +

Retrieves or sets the currently set vertex shader.

+
+ +

Typically, methods that return state will not work on a device that is created using . This method however, will work even on a pure device because it returns an interface.

+
+ + bb174416 + GetVertexShader / SetVertexShader + GetVertexShader + HRESULT IDirect3DDevice9::GetVertexShader([Out] IDirect3DVertexShader9** ppShader) +
+ + +

Retrieves or sets index data.

+
+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb174391 + GetIndices / SetIndices + GetIndices + HRESULT IDirect3DDevice9::GetIndices([Out] IDirect3DIndexBuffer9** ppIndexData) +
+ + +

Retrieves or sets the currently set pixel shader.

+
+ +

This method will not work on a device that is created using .

+
+ + bb174398 + GetPixelShader / SetPixelShader + GetPixelShader + HRESULT IDirect3DDevice9::GetPixelShader([Out] IDirect3DPixelShader9** ppShader) +
+ + +

Applications use the methods of the interface to render primitives, create resources, work with system-level variables, adjust gamma ramp levels, work with palettes, and create shaders. The interface derives from the interface.

+
+ +

The interface is obtained by calling .

The LPDIRECT3DDEVICE9EX and PDIRECT3DDEVICE9EX types are defined as references to the interface:

 typedef struct  *LPDIRECT3DDEVICE9EX, *PDIRECT3DDEVICE9EX;	
+            
Creating a Device

Follow these two steps to initialize a Direct3D device:

  1. Call Direct3DCreate9Ex to create the Direct3D object.
  2. Call CreateDeviceEx to create the Direct3D device.

Here is an example:

  *pDirect3DEx;	
+            LPDIRECT3DDEVICE9EX pDeviceEx;	
+            DWORD behaviorFlags = ; Direct3DCreate9Ex(, &pDirect3DEx);	
+            pDirect3DEx->CreateDeviceEx(D3DADAPTER_DEFAULT, , hWnd, behaviorFlags, &d3dpp, null, &pDeviceEx);	
+            
+
+ + bb174337 + IDirect3DDevice9Ex + IDirect3DDevice9Ex +
+ + + Creates a device to represent the display adapter. + + an instance of + Ordinal number that denotes the display adapter. {{D3DADAPTER_DEFAULT}} is always the primary display adapter. + Member of the enumerated type that denotes the desired device type. If the desired device type is not available, the method will fail. + The focus window alerts Direct3D when an application switches from foreground mode to background mode. See Remarks. For full-screen mode, the window specified must be a top-level window. For windowed mode, this parameter may be NULL only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-NULL value. + Combination of one or more options that control device creation. For more information, see {{D3DCREATE}}. + Pointer to a structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies {{D3DCREATE_ADAPTERGROUP_DEVICE}}, pPresentationParameters is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created. For Windows 2000 and Windows XP, the full-screen device display refresh rate is set in the following order: User-specified nonzero ForcedRefreshRate registry key, if supported by the device. Application-specified nonzero refresh rate value in the presentation parameter. Refresh rate of the latest desktop mode, if supported by the device. 75 hertz if supported by the device. 60 hertz if supported by the device. Device default. An unsupported refresh rate will default to the closest supported refresh rate below it. For example, if the application specifies 63 hertz, 60 hertz will be used. There are no supported refresh rates below 57 hertz. pPresentationParameters is both an input and an output parameter. Calling this method may change several members including: If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns. If BackBufferFormat equals before the method is called, it will be changed when the method returns. + + This method returns a fully working device interface, set to the required display mode (or windowed), and allocated with the appropriate back buffers. To begin rendering, the application needs only to create and set a depth buffer (assuming EnableAutoDepthStencil is FALSE in ). When you create a Direct3D device, you supply two different window parameters: a focus window (hFocusWindow) and a device window (the hDeviceWindow in ). The purpose of each window is: The focus window alerts Direct3D when an application switches from foreground mode to background mode (via Alt-Tab, a mouse click, or some other method). A single focus window is shared by each device created by an application. The device window determines the location and size of the back buffer on screen. This is used by Direct3D when the back buffer contents are copied to the front buffer during {{Present}}. This method should not be run during the handling of WM_CREATE. An application should never pass a window handle to Direct3D while handling WM_CREATE. Any call to create, release, or reset the device must be done using the same thread as the window procedure of the focus window. Note that D3DCREATE_HARDWARE_VERTEXPROCESSING, D3DCREATE_MIXED_VERTEXPROCESSING, and D3DCREATE_SOFTWARE_VERTEXPROCESSING are mutually exclusive flags, and at least one of these vertex processing flags must be specified when calling this method. Back buffers created as part of the device are only lockable if D3DPRESENTFLAG_LOCKABLE_BACKBUFFER is specified in the presentation parameters. (Multisampled back buffers and depth surfaces are never lockable.) The methods {{Reset}}, , and {{TestCooperativeLevel}} must be called from the same thread that used this method to create a device. D3DFMT_UNKNOWN can be specified for the windowed mode back buffer format when calling CreateDevice, {{Reset}}, and {{CreateAdditionalSwapChain}}. This means the application does not have to query the current desktop format before calling CreateDevice for windowed mode. For full-screen mode, the back buffer format must be specified. If you attempt to create a device on a 0x0 sized window, CreateDevice will fail. + + HRESULT CreateDevice([None] UINT Adapter,[None] D3DDEVTYPE DeviceType,[None] HWND hFocusWindow,[None] int BehaviorFlags,[None] D3DPRESENT_PARAMETERS* pPresentationParameters,[None] IDirect3DDevice9** ppReturnedDeviceInterface) + + + + Creates a device to represent the display adapter. + + an instance of + Ordinal number that denotes the display adapter. {{D3DADAPTER_DEFAULT}} is always the primary display adapter. + Member of the enumerated type that denotes the desired device type. If the desired device type is not available, the method will fail. + The focus window alerts Direct3D when an application switches from foreground mode to background mode. See Remarks. For full-screen mode, the window specified must be a top-level window. For windowed mode, this parameter may be NULL only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-NULL value. + Combination of one or more options that control device creation. For more information, see {{D3DCREATE}}. + Pointer to a structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies {{D3DCREATE_ADAPTERGROUP_DEVICE}}, pPresentationParameters is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created. For Windows 2000 and Windows XP, the full-screen device display refresh rate is set in the following order: User-specified nonzero ForcedRefreshRate registry key, if supported by the device. Application-specified nonzero refresh rate value in the presentation parameter. Refresh rate of the latest desktop mode, if supported by the device. 75 hertz if supported by the device. 60 hertz if supported by the device. Device default. An unsupported refresh rate will default to the closest supported refresh rate below it. For example, if the application specifies 63 hertz, 60 hertz will be used. There are no supported refresh rates below 57 hertz. pPresentationParameters is both an input and an output parameter. Calling this method may change several members including: If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns. If BackBufferFormat equals before the method is called, it will be changed when the method returns. + + This method returns a fully working device interface, set to the required display mode (or windowed), and allocated with the appropriate back buffers. To begin rendering, the application needs only to create and set a depth buffer (assuming EnableAutoDepthStencil is FALSE in ). When you create a Direct3D device, you supply two different window parameters: a focus window (hFocusWindow) and a device window (the hDeviceWindow in ). The purpose of each window is: The focus window alerts Direct3D when an application switches from foreground mode to background mode (via Alt-Tab, a mouse click, or some other method). A single focus window is shared by each device created by an application. The device window determines the location and size of the back buffer on screen. This is used by Direct3D when the back buffer contents are copied to the front buffer during {{Present}}. This method should not be run during the handling of WM_CREATE. An application should never pass a window handle to Direct3D while handling WM_CREATE. Any call to create, release, or reset the device must be done using the same thread as the window procedure of the focus window. Note that D3DCREATE_HARDWARE_VERTEXPROCESSING, D3DCREATE_MIXED_VERTEXPROCESSING, and D3DCREATE_SOFTWARE_VERTEXPROCESSING are mutually exclusive flags, and at least one of these vertex processing flags must be specified when calling this method. Back buffers created as part of the device are only lockable if D3DPRESENTFLAG_LOCKABLE_BACKBUFFER is specified in the presentation parameters. (Multisampled back buffers and depth surfaces are never lockable.) The methods {{Reset}}, , and {{TestCooperativeLevel}} must be called from the same thread that used this method to create a device. D3DFMT_UNKNOWN can be specified for the windowed mode back buffer format when calling CreateDevice, {{Reset}}, and {{CreateAdditionalSwapChain}}. This means the application does not have to query the current desktop format before calling CreateDevice for windowed mode. For full-screen mode, the back buffer format must be specified. If you attempt to create a device on a 0x0 sized window, CreateDevice will fail. + + HRESULT CreateDevice([None] UINT Adapter,[None] D3DDEVTYPE DeviceType,[None] HWND hFocusWindow,[None] int BehaviorFlags,[None] D3DPRESENT_PARAMETERS* pPresentationParameters,[None] IDirect3DDevice9** ppReturnedDeviceInterface) + + + + Creates a device to represent the display adapter. + + an instance of + Ordinal number that denotes the display adapter. {{D3DADAPTER_DEFAULT}} is always the primary display adapter. + Member of the enumerated type that denotes the desired device type. If the desired device type is not available, the method will fail. + The focus window alerts Direct3D when an application switches from foreground mode to background mode. See Remarks. For full-screen mode, the window specified must be a top-level window. For windowed mode, this parameter may be NULL only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-NULL value. + Combination of one or more options that control device creation. For more information, see {{D3DCREATE}}. + Pointer to a structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies {{D3DCREATE_ADAPTERGROUP_DEVICE}}, pPresentationParameters is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created. For Windows 2000 and Windows XP, the full-screen device display refresh rate is set in the following order: User-specified nonzero ForcedRefreshRate registry key, if supported by the device. Application-specified nonzero refresh rate value in the presentation parameter. Refresh rate of the latest desktop mode, if supported by the device. 75 hertz if supported by the device. 60 hertz if supported by the device. Device default. An unsupported refresh rate will default to the closest supported refresh rate below it. For example, if the application specifies 63 hertz, 60 hertz will be used. There are no supported refresh rates below 57 hertz. pPresentationParameters is both an input and an output parameter. Calling this method may change several members including: If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns. If BackBufferFormat equals before the method is called, it will be changed when the method returns. + The full screen display mode. + + This method returns a fully working device interface, set to the required display mode (or windowed), and allocated with the appropriate back buffers. To begin rendering, the application needs only to create and set a depth buffer (assuming EnableAutoDepthStencil is FALSE in ). When you create a Direct3D device, you supply two different window parameters: a focus window (hFocusWindow) and a device window (the hDeviceWindow in ). The purpose of each window is: The focus window alerts Direct3D when an application switches from foreground mode to background mode (via Alt-Tab, a mouse click, or some other method). A single focus window is shared by each device created by an application. The device window determines the location and size of the back buffer on screen. This is used by Direct3D when the back buffer contents are copied to the front buffer during {{Present}}. This method should not be run during the handling of WM_CREATE. An application should never pass a window handle to Direct3D while handling WM_CREATE. Any call to create, release, or reset the device must be done using the same thread as the window procedure of the focus window. Note that D3DCREATE_HARDWARE_VERTEXPROCESSING, D3DCREATE_MIXED_VERTEXPROCESSING, and D3DCREATE_SOFTWARE_VERTEXPROCESSING are mutually exclusive flags, and at least one of these vertex processing flags must be specified when calling this method. Back buffers created as part of the device are only lockable if D3DPRESENTFLAG_LOCKABLE_BACKBUFFER is specified in the presentation parameters. (Multisampled back buffers and depth surfaces are never lockable.) The methods {{Reset}}, , and {{TestCooperativeLevel}} must be called from the same thread that used this method to create a device. D3DFMT_UNKNOWN can be specified for the windowed mode back buffer format when calling CreateDevice, {{Reset}}, and {{CreateAdditionalSwapChain}}. This means the application does not have to query the current desktop format before calling CreateDevice for windowed mode. For full-screen mode, the back buffer format must be specified. If you attempt to create a device on a 0x0 sized window, CreateDevice will fail. + + HRESULT CreateDevice([None] UINT Adapter,[None] D3DDEVTYPE DeviceType,[None] HWND hFocusWindow,[None] int BehaviorFlags,[None] D3DPRESENT_PARAMETERS* pPresentationParameters,[None] IDirect3DDevice9** ppReturnedDeviceInterface) + + + + Creates a device to represent the display adapter. + + an instance of + Ordinal number that denotes the display adapter. {{D3DADAPTER_DEFAULT}} is always the primary display adapter. + Member of the enumerated type that denotes the desired device type. If the desired device type is not available, the method will fail. + The focus window alerts Direct3D when an application switches from foreground mode to background mode. See Remarks. For full-screen mode, the window specified must be a top-level window. For windowed mode, this parameter may be NULL only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-NULL value. + Combination of one or more options that control device creation. For more information, see {{D3DCREATE}}. + Pointer to a structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies {{D3DCREATE_ADAPTERGROUP_DEVICE}}, pPresentationParameters is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created. For Windows 2000 and Windows XP, the full-screen device display refresh rate is set in the following order: User-specified nonzero ForcedRefreshRate registry key, if supported by the device. Application-specified nonzero refresh rate value in the presentation parameter. Refresh rate of the latest desktop mode, if supported by the device. 75 hertz if supported by the device. 60 hertz if supported by the device. Device default. An unsupported refresh rate will default to the closest supported refresh rate below it. For example, if the application specifies 63 hertz, 60 hertz will be used. There are no supported refresh rates below 57 hertz. pPresentationParameters is both an input and an output parameter. Calling this method may change several members including: If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns. If BackBufferFormat equals before the method is called, it will be changed when the method returns. + The full screen display mode. + + This method returns a fully working device interface, set to the required display mode (or windowed), and allocated with the appropriate back buffers. To begin rendering, the application needs only to create and set a depth buffer (assuming EnableAutoDepthStencil is FALSE in ). When you create a Direct3D device, you supply two different window parameters: a focus window (hFocusWindow) and a device window (the hDeviceWindow in ). The purpose of each window is: The focus window alerts Direct3D when an application switches from foreground mode to background mode (via Alt-Tab, a mouse click, or some other method). A single focus window is shared by each device created by an application. The device window determines the location and size of the back buffer on screen. This is used by Direct3D when the back buffer contents are copied to the front buffer during {{Present}}. This method should not be run during the handling of WM_CREATE. An application should never pass a window handle to Direct3D while handling WM_CREATE. Any call to create, release, or reset the device must be done using the same thread as the window procedure of the focus window. Note that D3DCREATE_HARDWARE_VERTEXPROCESSING, D3DCREATE_MIXED_VERTEXPROCESSING, and D3DCREATE_SOFTWARE_VERTEXPROCESSING are mutually exclusive flags, and at least one of these vertex processing flags must be specified when calling this method. Back buffers created as part of the device are only lockable if D3DPRESENTFLAG_LOCKABLE_BACKBUFFER is specified in the presentation parameters. (Multisampled back buffers and depth surfaces are never lockable.) The methods {{Reset}}, , and {{TestCooperativeLevel}} must be called from the same thread that used this method to create a device. D3DFMT_UNKNOWN can be specified for the windowed mode back buffer format when calling CreateDevice, {{Reset}}, and {{CreateAdditionalSwapChain}}. This means the application does not have to query the current desktop format before calling CreateDevice for windowed mode. For full-screen mode, the back buffer format must be specified. If you attempt to create a device on a 0x0 sized window, CreateDevice will fail. + + HRESULT CreateDevice([None] UINT Adapter,[None] D3DDEVTYPE DeviceType,[None] HWND hFocusWindow,[None] int BehaviorFlags,[None] D3DPRESENT_PARAMETERS* pPresentationParameters,[None] IDirect3DDevice9** ppReturnedDeviceInterface) + + + + Reports the current cooperative-level status of the Direct3D device for a windowed or full-screen application. + + The window handle. + State of the device + HRESULT IDirect3DDevice9Ex::CheckDeviceState([In] HWND hDestinationWindow) + + + + Checks an array of resources to determine if it is likely that they will cause a large stall at Draw time because the system must make the resources GPU-accessible. + + An array of that indicate the resources to check. + The status. + HRESULT IDirect3DDevice9Ex::CheckDeviceState([In] HWND hDestinationWindow) + + + + Retrieves the display mode's spatial resolution, color resolution, refresh frequency, and rotation settings. + + The swap chain. + structure containing data about the display mode of the adapter + HRESULT IDirect3DDevice9Ex::GetDisplayModeEx([In] unsigned int iSwapChain,[Out] D3DDISPLAYMODEEX* pMode,[In] void* pRotation) + + + + Retrieves the display mode's spatial resolution, color resolution, refresh frequency, and rotation settings. + + The swap chain. + The structure indicating the type of screen rotation the application will do. + structure containing data about the display mode of the adapter + HRESULT IDirect3DDevice9Ex::GetDisplayModeEx([In] unsigned int iSwapChain,[Out] D3DDISPLAYMODEEX* pMode,[In] void* pRotation) + + + + Swap the swapchain's next buffer with the front buffer. + + The flags. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9Ex::PresentEx([In] const void* pSourceRect,[In] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + + Swap the swapchain's next buffer with the front buffer. + + The flags. + The source rectangle. + The destination rectangle. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9Ex::PresentEx([In] const void* pSourceRect,[In] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + + Swap the swapchain's next buffer with the front buffer. + + The flags. + The source rectangle. + The destination rectangle. + The window override. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9Ex::PresentEx([In] const void* pSourceRect,[In] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + + Swap the swapchain's next buffer with the front buffer. + + The flags. + The source rectangle. + The destination rectangle. + The window override. + The region. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9Ex::PresentEx([In] const void* pSourceRect,[In] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + + Resets the type, size, and format of the swap chain with all other surfaces persistent. + + A reference describing the new presentation parameters. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9Ex::ResetEx([In] D3DPRESENT_PARAMETERS* pPresentationParameters,[In] void* pFullscreenDisplayMode) + + + + Resets the type, size, and format of the swap chain with all other surfaces persistent. + + A reference describing the new presentation parameters. + The full screen display mode. + + A object describing the result of the operation. + + HRESULT IDirect3DDevice9Ex::ResetEx([In] D3DPRESENT_PARAMETERS* pPresentationParameters,[In] void* pFullscreenDisplayMode) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Prepare the texture sampler for monochrome convolution filtering on a single-color texture.

+
+

The width of the filter kernel; ranging from 1 - D3DCONVOLUTIONMONO_MAXWIDTH. The default value is 1.

+

The height of the filter kernel; ranging from 1 - D3DCONVOLUTIONMONO_MAXHEIGHT. The default value is 1.

+

An array of weights, one weight for each kernel sub-element in the width. This parameter must be null, which will set the weights equal to the default value.

+

An array of weights, one weight for each kernel sub-element in the height. This parameter must be null, which will set the weights equal to the default value.

+

If the method succeeds, the return value is .

+ +

This method is designed to filter a single color texture. A monochrome convolution filter is a 2D box filter with all of the weights set to 1.0; the filter kernel resolution ranges from 1 x 1 to 7 x 7. When monochrome texture filtering is set to a texture sampler and texture sampling is performed at location, then Direct3D performs convolution.

Restrictions include:

  • The filter specified by this method is recorded in state blocks as a part of .
  • The only texture address mode supported is: ; the border color is always 0.
  • This method is not supported for mipmaps.
  • Using a non-monochrome texture with convolution filtering will generate a driver error.
+
+ + bb174345 + HRESULT IDirect3DDevice9Ex::SetConvolutionMonoKernel([In] unsigned int width,[In] unsigned int height,[In, Buffer] float* rows,[In, Buffer] float* columns) + IDirect3DDevice9Ex::SetConvolutionMonoKernel +
+ + +

Copy a text string to one surface using an alphabet of glyphs on another surface. Composition is done by the GPU using bitwise operations.

+
+

A reference to a source surface (prepared by ) that supplies the alphabet glyphs. This surface must be created with the flag.

+

A reference to the destination surface (prepared by ) that receives the glyph data. The surface must be part of a texture.

+

A reference to a vertex buffer (see ) containing rectangles (see D3DCOMPOSERECTDESC) that enclose the desired glyphs in the source surface.

+

The number of rectangles or glyphs that are used in the operation. The number applies to both the source and destination surfaces. The range is 0 to D3DCOMPOSERECTS_MAXNUMRECTS.

+

A reference to a vertex buffer (see ) containing rectangles (see D3DCOMPOSERECTDESTINATION) that describe the destination to which the indicated glyph from the source surface will be copied.

+

Specifies how to combine the source and destination surfaces. See .

+

A value added to the x coordinates of all destination rectangles. This value can be negative, which may cause the glyph to be rejected or clipped if the result is beyond the bounds of the surface.

+

A value added to the y coordinates of all destination rectangles. This value can be negative, which may cause the glyph to be rejected or clipped if the result is beyond the bounds of the surface.

+

If the method succeeds, the return value is .

+ +

Glyphs from a one-bit source surface are put together into another one-bit texture surface with this method. The destination surface can then be used as the source for a normal texturing operation that will filter and scale the strings of text onto some other non-monochrome surface.

This method has several constraints (which are similar to StretchRect):

  • Surfaces cannot be locked.
  • The source and destination surfaces cannot be the same surface.
  • The source and destination surfaces must be created with the format.
  • The source surface and both vertex buffers must be created with the flag.
  • The destination surface must be created with either the or flags.
  • The source rectangles must be within the source surface.

The method is not recorded in state blocks.

+
+ + bb174340 + HRESULT IDirect3DDevice9Ex::ComposeRects([In] IDirect3DSurface9* pSrc,[In] IDirect3DSurface9* pDst,[In] IDirect3DVertexBuffer9* pSrcRectDescs,[In] unsigned int NumRects,[In] IDirect3DVertexBuffer9* pDstRectDescs,[In] D3DCOMPOSERECTSOP Operation,[In] int Xoffset,[In] int Yoffset) + IDirect3DDevice9Ex::ComposeRects +
+ + +

Swap the swapchain's next buffer with the front buffer.

+
+

Pointer to a structure indicating region on the source surface to copy in window client coordinates. Only applies when the swapchain was created with the flag. If null, the entire source surface is presented. If the rectangle exceeds the source surface, it is clipped to the source surface.

+

Pointer to structure indicating the target region on the destination surface in window client coordinates. Only applies when the swapchain was created with the flag. If null, the entire client area is filled. If the rectangle exceeds the destination client area, it is clipped to the destination client area.

+

Pointer to a destination window handle whose client area is taken as the target for this presentation. If this value is null, then the hWndDeviceWindow member of is taken.

+

Pointer to a structure indicating the smallest set of pixels that need to be transferred. This value must be null unless the swapchain was created with the flag. For more information about swapchains, see Flipping Surfaces (Direct3D 9).

If this value is non-null, the contained region is expressed in back buffer coordinates. The method takes these rectangles into account when optimizing the presentation by copying only the pixels within the region, or some suitably expanded set of rectangles. This is an aid to optimization only, and the application should not rely on the region being copied exactly. The implementation can choose to copy the whole source rectangle.

+

Allows the application to request that the method return immediately when the driver reports that it cannot schedule a presentation. Valid values are 0, or any combination of flags.

  • If dwFlags = 0, this method behaves as it did prior to Direct3D 9. Present will spin until the hardware is free, without returning an error.
  • If dwFlags = the display driver is called with the front buffer as both the source and target surface. The driver responds by scheduling a frame synch, but not changing the displayed surface. This flag is only available in full-screen mode or when using in windowed mode.
  • If dwFlags = , and the hardware is busy processing or waiting for a vertical sync interval, the method will return .
  • If dwFlags = , is enforced on this Present call. This flag can only be specified when using . This behavior is the same for windowed and full-screen modes.
  • If dwFlags = , gamma correction is performed from linear space to sRGB for windowed swap chains. This flag will take effect only when the driver exposes (see Gamma (Direct3D 9)).
+

Possible return values include: , , , , or (see D3DERR). See Lost Device Behavior Changes for more information about lost, hung, and removed devices.

Differences between Direct3D 9 and Direct3D 9Ex:

is only available in Direct3D9Ex running on Windows 7 (or more current operating system).

?

+ +

Similar to the Method, PresentEx adds a dwflags parameter.

When the swapchain is created with flag, pSourceRect, pDestRect and pDirtyRegion values must be set to null.

+
+ + bb174343 + HRESULT IDirect3DDevice9Ex::PresentEx([In] const void* pSourceRect,[In] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + IDirect3DDevice9Ex::PresentEx +
+ + +

Get the priority of the GPU thread.

+
+

Current GPU priority. Valid values range from -7 to 7.

+

Possible return values include: or (see D3DERR).

+ +

Use to set the priority of a thread.

This method will retrieve the priority of the thread stored with the Direct3D device even if it was created with the flag.

+
+ + bb174341 + HRESULT IDirect3DDevice9Ex::GetGPUThreadPriority([Out] int* pPriority) + IDirect3DDevice9Ex::GetGPUThreadPriority +
+ + +

Set the priority on the GPU thread.

+
+

The thread priority, ranging from -7 to 7.

+

Possible return values include: , , or (see D3DERR).

+ +

GPU thread priority is not reset when a device is lost. The effects of calls to this method are not recorded in state blocks.

+
+ + bb174346 + HRESULT IDirect3DDevice9Ex::SetGPUThreadPriority([In] int Priority) + IDirect3DDevice9Ex::SetGPUThreadPriority +
+ + +

Suspend execution of the calling thread until the next vertical blank signal.

+
+

Swap chain index. This is an optional, zero-based index used to specify a swap chain on a multihead card.

+

This method will always return .

+ +

This method allows applications to efficiently throttle their frame rate to that of the monitor associated with the device. Following a vertical blank, the amount of time it takes for the thread to wake up is typically very short.

In some scenarios the hardware may stop generating vertical blank signals when nothing is being displayed on the monitor. In this case, the method will wait approximately 100ms and return with .

+
+ + bb174349 + HRESULT IDirect3DDevice9Ex::WaitForVBlank([In] unsigned int iSwapChain) + IDirect3DDevice9Ex::WaitForVBlank +
+ + +

Checks an array of resources to determine if it is likely that they will cause a large stall at Draw time because the system must make the resources GPU-accessible.

+
+

An array of references that indicate the resources to check (for a description of , see the DirectX SDK documentation).

+

A value indicating the number of resources passed into the pResourceArray parameter up to a maximum of 65535.

+

If all the resources are in GPU-accessible memory, the method will return . The system may need to perform a remapping operation to promote the resources, but will not have to copy data.

If no allocation that comprises the resources is on disk, but at least one allocation is not in GPU-accessible memory, the method will return . The system may need to perform a copy to promote the resource.

If at least one allocation that comprises the resources is on disk, this method will return S_NOT_RESIDENT. The system may need to perform a copy to promote the resource.

+ +

This API is no more than a reasonable guess at residency, since resources may have been demoted by the time the application uses them.

The expected usage pattern is as follows. If the application determines that a set of resources are not resident, then the application will substitute a lower-LOD version of the resource and continue with rendering. The video memory manager API, offers a feature to allow the application to express that it would like these lower-LOD resources to be made more likely to stay resident in GPU-accessible memory. It is the app's responsibility to create, fill and destroy these lower-LOD versions, if it so chooses.

The application also needs to begin promotion of the higher-LOD versions when the residency check indicates that the resource is not resident in GPU-accessible memory. Since a per-process lock exists in kernel mode, a performant implementation will spawn a separate process whose sole job is to promote resources. The application communicates resource identity between the two process by means of the Sharing Resources shared surfaces API and promotes them by means of the SetPriority.

+
+ + bb174339 + HRESULT IDirect3DDevice9Ex::CheckResourceResidency([In, Buffer] IDirect3DResource9** pResourceArray,[In] unsigned int NumResources) + IDirect3DDevice9Ex::CheckResourceResidency +
+ + +

Checks an array of resources to determine if it is likely that they will cause a large stall at Draw time because the system must make the resources GPU-accessible.

+
+

An array of references that indicate the resources to check (for a description of , see the DirectX SDK documentation).

+

A value indicating the number of resources passed into the pResourceArray parameter up to a maximum of 65535.

+

If all the resources are in GPU-accessible memory, the method will return . The system may need to perform a remapping operation to promote the resources, but will not have to copy data.

If no allocation that comprises the resources is on disk, but at least one allocation is not in GPU-accessible memory, the method will return . The system may need to perform a copy to promote the resource.

If at least one allocation that comprises the resources is on disk, this method will return S_NOT_RESIDENT. The system may need to perform a copy to promote the resource.

+ +

This API is no more than a reasonable guess at residency, since resources may have been demoted by the time the application uses them.

The expected usage pattern is as follows. If the application determines that a set of resources are not resident, then the application will substitute a lower-LOD version of the resource and continue with rendering. The video memory manager API, offers a feature to allow the application to express that it would like these lower-LOD resources to be made more likely to stay resident in GPU-accessible memory. It is the app's responsibility to create, fill and destroy these lower-LOD versions, if it so chooses.

The application also needs to begin promotion of the higher-LOD versions when the residency check indicates that the resource is not resident in GPU-accessible memory. Since a per-process lock exists in kernel mode, a performant implementation will spawn a separate process whose sole job is to promote resources. The application communicates resource identity between the two process by means of the Sharing Resources shared surfaces API and promotes them by means of the SetPriority.

+
+ + bb174339 + HRESULT IDirect3DDevice9Ex::CheckResourceResidency([In, Buffer] IDirect3DResource9** pResourceArray,[In] unsigned int NumResources) + IDirect3DDevice9Ex::CheckResourceResidency +
+ + +

Set the number of frames that the system is allowed to queue for rendering.

+
+

The maximum number of back buffer frames that a driver can queue. The value is typically 3, but can range from 1 to 20. A value of 0 will reset latency to the default. For multi-head devices, MaxLatency is specified per-head.

+

Possible return values include: or (see D3DERR).

+ +

Frame latency is the number of frames that are allowed to be stored in a queue, before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue.

It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data.

+
+ + bb174347 + HRESULT IDirect3DDevice9Ex::SetMaximumFrameLatency([In] unsigned int MaxLatency) + IDirect3DDevice9Ex::SetMaximumFrameLatency +
+ + +

Retrieves the number of frames of data that the system is allowed to queue.

+
+

Returns the number of frames that can be queued for render. The value is typically 3, but can range from 1 to 20.

+

Possible return values include: , , , , , or (see D3DERR).

+ +

Frame latency is the number of frames that are allowed to be stored in a queue, before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue.

It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data.

+
+ + bb174342 + HRESULT IDirect3DDevice9Ex::GetMaximumFrameLatency([Out] unsigned int* pMaxLatency) + IDirect3DDevice9Ex::GetMaximumFrameLatency +
+ + +

Reports the current cooperative-level status of the Direct3D device for a windowed or full-screen application.

+
+

The destination window handle to check for occlusion. When this parameter is null, is returned when another device has fullscreen ownership. When the window handle is not null, window's client area is checked for occlusion. A window is occluded if any part of it is obscured by another application.

+

Possible return values include: , , , , or (see D3DERR), or , or (see S_PRESENT).

+ +

This method replaces , which always returns in Direct3D 9Ex applications.

We recommend not to call CheckDeviceState every frame. Instead, call CheckDeviceState only if the method returns a failure code.

See Lost Device Behavior Changes for more information about lost, hung, and removed devices.

+
+ + bb174338 + HRESULT IDirect3DDevice9Ex::CheckDeviceState([In] HWND hDestinationWindow) + IDirect3DDevice9Ex::CheckDeviceState +
+ + +

Creates a render-target surface.

+
+

Width of the render-target surface, in pixels.

+

Height of the render-target surface, in pixels.

+

Member of the enumerated type, describing the format of the render target.

+

Member of the enumerated type, which describes the multisampling buffer type. This parameter specifies the antialiasing type for this render target. When this surface is passed to , its multisample type must be the same as that of the depth-stencil set by .

+

Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error, . The MultisampleQuality values of paired render targets, depth stencil surfaces, and the multisample type must all match.

+

Render targets are not lockable unless the application specifies TRUE for Lockable.

Note that lockable render targets reduce performance on some graphics hardware. The readback performance (moving data from video memory to system memory) depends on the type of hardware used (AGP vs. PCI Express) and is usually far lower than upload performance (moving data from system to video memory). If you need read access to render targets, use GetRenderTargetData instead of lockable render targets.

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

Combination of one or more constants which can be OR'd together. Value of 0 indicates no usage.

+

Address of a reference to an interface.

+ +

Render-target surfaces are placed in the memory class.

The creation of lockable, multisampled render targets is not supported.

+
+ + bb509713 + HRESULT IDirect3DDevice9Ex::CreateRenderTargetEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Lockable,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + IDirect3DDevice9Ex::CreateRenderTargetEx +
+ + +

Create an off-screen surface.

+
+

Width of the surface.

+

Height of the surface.

+

Format of the surface. See .

+

Surface pool type. See .

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

Combination of one or more constants which can be OR'd together. Value of 0 indicates no usage.

+

Pointer to the interface created.

+ +

will return a surface that has identical characteristics to a surface created by the DirectX 8.x method CreateImageSurface.

is the appropriate pool for use with the and .

is not allowed when creating an offscreen plain surface. For more information about memory pools, see .

Off-screen plain surfaces are always lockable, regardless of their pool types.

+
+ + bb509712 + HRESULT IDirect3DDevice9Ex::CreateOffscreenPlainSurfaceEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + IDirect3DDevice9Ex::CreateOffscreenPlainSurfaceEx +
+ + +

Creates a depth-stencil surface.

+
+

Width of the depth-stencil surface, in pixels.

+

Height of the depth-stencil surface, in pixels.

+

Member of the enumerated type, describing the format of the depth-stencil surface. This value must be one of the enumerated depth-stencil formats for this device.

+

Member of the enumerated type, describing the multisampling buffer type. This value must be one of the allowed multisample types. When this surface is passed to , its multisample type must be the same as that of the render target set by .

+

Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by . Passing a larger value returns the error . The MultisampleQuality values of paired render targets, depth stencil surfaces, and the MultiSample type must all match.

+

Set this flag to TRUE to enable z-buffer discarding, and otherwise. If this flag is set, the contents of the depth stencil buffer will be invalid after calling either or with a different depth surface.

This flag has the same behavior as the constant, , in .

+

Reserved. Set this parameter to null. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

+

Combination of one or more constants which can be OR'd together. Value of 0 indicates no usage.

+

Address of a reference to an interface, representing the created depth-stencil surface resource.

+ +

The memory class of the depth-stencil buffer is always .

+
+ + bb509711 + HRESULT IDirect3DDevice9Ex::CreateDepthStencilSurfaceEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Discard,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + IDirect3DDevice9Ex::CreateDepthStencilSurfaceEx +
+ + +

Resets the type, size, and format of the swap chain with all other surfaces persistent.

+
+

Pointer to a structure, describing the new presentation parameters. This value cannot be null.

When switching to full-screen mode, Direct3D will try to find a desktop format that matches the back buffer format, so that back buffer and front buffer formats will be identical (to eliminate the need for color conversion).

When this method returns:

  • BackBufferCount, BackBufferWidth, and BackBufferHeight are set to zero.
  • BackBufferFormat is set to for windowed mode only; a full-screen mode must specify a format.
+

Pointer to a structure that describes the properties of the desired display mode. This value must be provided for fullscreen applications, but can be null for windowed applications.

+

The method can return: , or (see D3DERR).

If this method returns or then the application can only call , or release the interface reference; any other API call will cause an exception.

+ +

If a call to fails, the device will be placed in the lost state (as indicated by a return value of from a call to ). Refer to and Lost Device Behavior Changes for further information concerning the use of in the context of lost devices.

Unlike previous versions of DirectX, calling does not cause surfaces, textures or state information to be lost.

Pixel shaders and vertex shaders survive calls for Direct3D 9. They do not need to be re-created explicitly by the application.

There are two different types of swap chains: full-screen or windowed. If the new swap chain is full-screen, the adapter will be placed in the display mode that matches the new size.

Applications can expect messages to be sent to them during this call (for example, before this call is returned); applications should take precautions not to call into Direct3D at this time.

A call to will fail if called on a different thread than that used to create the device being reset.

can be specified for the windowed mode back buffer format when calling , , and . This means the application does not have to query the current desktop format before calling for windowed mode. For full-screen mode, the back buffer format must be specified. Setting BackBufferCount equal to zero (BackBufferCount = 0) results in one back buffer.

When trying to reset more than one display adapter in a group, set pPresentationParameters to point to an array of structures, one for each display in the adapter group.

If a multihead device was created with , requires an array of structures wherein each structure must specify a full-screen display. To switch back to windowed mode, the application must destroy the device and re-create a non-multihead device in windowed mode.

+
+ + bb174344 + HRESULT IDirect3DDevice9Ex::ResetEx([In] D3DPRESENT_PARAMETERS* pPresentationParameters,[In] void* pFullscreenDisplayMode) + IDirect3DDevice9Ex::ResetEx +
+ + +

Retrieves the display mode's spatial resolution, color resolution, refresh frequency, and rotation settings.

+
+

An unsigned integer specifying the swap chain.

+

Pointer to a indicating the type of screen rotation the application will do. The value returned through this reference is important when the flag is used; otherwise, it can be set to null.

+

Pointer to a structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode. Can be set to null.

+ + bb509714 + HRESULT IDirect3DDevice9Ex::GetDisplayModeEx([In] unsigned int iSwapChain,[Out] D3DDISPLAYMODEEX* pMode,[In] void* pRotation) + IDirect3DDevice9Ex::GetDisplayModeEx +
+ + +

Get or sets the priority of the GPU thread.

+
+ +

Use to set the priority of a thread.

This method will retrieve the priority of the thread stored with the Direct3D device even if it was created with the flag.

+
+ + bb174341 + GetGPUThreadPriority / SetGPUThreadPriority + GetGPUThreadPriority + HRESULT IDirect3DDevice9Ex::GetGPUThreadPriority([Out] int* pPriority) +
+ + +

Retrieves or sets the number of frames of data that the system is allowed to queue.

+
+ +

Frame latency is the number of frames that are allowed to be stored in a queue, before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue.

It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data.

+
+ + bb174342 + GetMaximumFrameLatency / SetMaximumFrameLatency + GetMaximumFrameLatency + HRESULT IDirect3DDevice9Ex::GetMaximumFrameLatency([Out] unsigned int* pMaxLatency) +
+ + +

Applications use the methods of the interface to create Microsoft Direct3D objects and set up the environment. This interface includes methods for enumerating and retrieving capabilities of the device.

+
+ +

The interface is obtained by calling the Direct3DCreate9 function.

The LPDIRECT3D9 and PDIRECT3D9 types are defined as references to the interface.

typedef struct  *LPDIRECT3D9, *PDIRECT3D9;
+
+ + bb174300 + IDirect3D9 + IDirect3D9 +
+ + + Create an IDirect3D9 object and return an interface to it. + + + The Direct3D object is the first Direct3D COM object that your graphical application needs to create and the last object that your application needs to release. Functions for enumerating and retrieving capabilities of a device are accessible through the Direct3D object. This enables applications to select devices without creating them. Create an IDirect3D9 object as shown here: + LPDIRECT3D9 g_pD3D = NULL; if( NULL == (g_pD3D = Direct3DCreate9(D3D_SDK_VERSION))) return E_FAIL; + + The IDirect3D9 interface supports enumeration of active display adapters and allows the creation of objects. If the user dynamically adds adapters (either by adding devices to the desktop, or by hot-docking a laptop), those devices will not be included in the enumeration. Creating a new IDirect3D9 interface will expose the new devices. D3D_SDK_VERSION is passed to this function to ensure that the header files against which an application is compiled match the version of the runtime DLL's that are installed on the machine. D3D_SDK_VERSION is only changed in the runtime when a header change (or other code change) would require an application to be rebuilt. If this function fails, it indicates that the header file version does not match the runtime DLL version. For an example, see {{Creating a Device (Direct3D 9)}}. + + + + + Checks the version of D3DX runtime against the version of this library.. + + + + + Determines whether a depth-stencil format is compatible with a render-target format in a particular display mode. + + The adapter. + Type of the device. + The adapter format. + The render target format. + The depth stencil format. + If the depth-stencil format is compatible with the render-target format in the display mode, this method returns true + HRESULT IDirect3D9::CheckDepthStencilMatch([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT AdapterFormat,[In] D3DFORMAT RenderTargetFormat,[In] D3DFORMAT DepthStencilFormat) + + + + Determines whether a depth-stencil format is compatible with a render-target format in a particular display mode. + + The adapter. + Type of the device. + The adapter format. + The render target format. + The depth stencil format. + The result. + + If the depth-stencil format is compatible with the render-target format in the display mode, this method returns true + + HRESULT IDirect3D9::CheckDepthStencilMatch([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT AdapterFormat,[In] D3DFORMAT RenderTargetFormat,[In] D3DFORMAT DepthStencilFormat) + + + + Determines whether a surface format is available as a specified resource type and can be used as a texture, depth-stencil buffer, or render target, or any combination of the three, on a device representing this adapter. + + The adapter. + Type of the device. + The adapter format. + The usage. + Type of the resource. + The check format. + + If the format is compatible with the specified device for the requested usage, this method returns true + + HRESULT IDirect3D9::CheckDeviceFormat([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT AdapterFormat,[In] unsigned int Usage,[In] D3DRESOURCETYPE RType,[In] D3DFORMAT CheckFormat) + + + + Determines whether a surface format is available as a specified resource type and can be used as a texture, depth-stencil buffer, or render target, or any combination of the three, on a device representing this adapter. + + The adapter. + Type of the device. + The adapter format. + The usage. + Type of the resource. + The check format. + The result. + If the format is compatible with the specified device for the requested usage, this method returns true + HRESULT IDirect3D9::CheckDeviceFormat([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT AdapterFormat,[In] unsigned int Usage,[In] D3DRESOURCETYPE RType,[In] D3DFORMAT CheckFormat) + + + + Tests the device to see if it supports conversion from one display format to another. + + The adapter. + Type of the device. + The source format. + The target format. + + True if the method succeeds. + + HRESULT IDirect3D9::CheckDeviceFormatConversion([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT SourceFormat,[In] D3DFORMAT TargetFormat) + + + + Tests the device to see if it supports conversion from one display format to another. + + The adapter. + Type of the device. + The source format. + The target format. + The result. + True if the method succeeds. + HRESULT IDirect3D9::CheckDeviceFormatConversion([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT SourceFormat,[In] D3DFORMAT TargetFormat) + + + + Determines if a multisampling technique is available on this device. + + The adapter. + Type of the device. + The surface format. + if set to true [windowed]. + Type of the multisample. + + f the device can perform the specified multisampling method, this method returns true + + HRESULT IDirect3D9::CheckDeviceMultiSampleType([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT SurfaceFormat,[In] BOOL Windowed,[In] D3DMULTISAMPLE_TYPE MultiSampleType,[Out] unsigned int* pQualityLevels) + + + + Determines if a multisampling technique is available on this device. + + The adapter. + Type of the device. + The surface format. + if set to true [windowed]. + Type of the multisample. + The quality levels. + + f the device can perform the specified multisampling method, this method returns true + + HRESULT IDirect3D9::CheckDeviceMultiSampleType([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT SurfaceFormat,[In] BOOL Windowed,[In] D3DMULTISAMPLE_TYPE MultiSampleType,[Out] unsigned int* pQualityLevels) + + + + Determines if a multisampling technique is available on this device. + + The adapter. + Type of the device. + The surface format. + if set to true [windowed]. + Type of the multisample. + The quality levels. + The result. + f the device can perform the specified multisampling method, this method returns true + HRESULT IDirect3D9::CheckDeviceMultiSampleType([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT SurfaceFormat,[In] BOOL Windowed,[In] D3DMULTISAMPLE_TYPE MultiSampleType,[Out] unsigned int* pQualityLevels) + + + + Verifies whether a hardware accelerated device type can be used on this adapter. + + The adapter. + Type of the device. + The adapter format. + The back buffer format. + if set to true [windowed]. + + true if the device can be used on this adapter + + HRESULT IDirect3D9::CheckDeviceType([In] unsigned int Adapter,[In] D3DDEVTYPE DevType,[In] D3DFORMAT AdapterFormat,[In] D3DFORMAT BackBufferFormat,[In] BOOL bWindowed) + + + + Verifies whether a hardware accelerated device type can be used on this adapter. + + The adapter. + Type of the device. + The adapter format. + The back buffer format. + if set to true [windowed]. + The result. + true if the device can be used on this adapter + HRESULT IDirect3D9::CheckDeviceType([In] unsigned int Adapter,[In] D3DDEVTYPE DevType,[In] D3DFORMAT AdapterFormat,[In] D3DFORMAT BackBufferFormat,[In] BOOL bWindowed) + + + + Get the physical display adapters present in the system when this was instantiated. + + The adapter. + The physical display adapters + HRESULT IDirect3D9::GetAdapterIdentifier([In] unsigned int Adapter,[In] unsigned int Flags,[Out] D3DADAPTER_IDENTIFIER9* pIdentifier) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Registers a pluggable software device. Software devices provide software rasterization enabling applications to access a variety of software rasterizers.

+
+

Pointer to the initialization function for the software device to be registered.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: . The method call is invalid. For example, a method's parameter may have an invalid value: .

+ +

If the user's computer provides no special hardware acceleration for 3D operations, your application might emulate 3D hardware in software. Software rasterization devices emulate the functions of color 3D hardware in software. A software device runs more slowly than a hal. However, software devices take advantage of any special instructions supported by the CPU to increase performance. Instruction sets include the AMD 3DNow! instruction set on some AMD processors and the MMX instruction set supported by many Intel processors. Direct3D uses the 3D-Now! instruction set to accelerate transformation and lighting operations and the MMX instruction set to accelerate rasterization.

Software devices communicate with Direct3D through an interface similar to the hardware device driver interface (DDI).

Software devices are loaded by the application and registered with the object. Direct3D uses the software device for rendering.

The Direct3D Driver Development Kit (DDK) provides the documentation and headers for developing pluggable software devices.

+
+ + bb174321 + HRESULT IDirect3D9::RegisterSoftwareDevice([In] void* pInitializeFunction) + IDirect3D9::RegisterSoftwareDevice +
+ + +

Returns the number of adapters on the system.

+
+

A UINT value that denotes the number of adapters on the system at the time this interface was instantiated.

+ + bb174315 + unsigned int IDirect3D9::GetAdapterCount() + IDirect3D9::GetAdapterCount +
+ + +

Describes the physical display adapters present in the system when the interface was instantiated.

+
+ No documentation. + No documentation. + No documentation. + + bb174317 + HRESULT IDirect3D9::GetAdapterIdentifier([In] unsigned int Adapter,[In] unsigned int Flags,[Out] D3DADAPTER_IDENTIFIER9* pIdentifier) + IDirect3D9::GetAdapterIdentifier +
+ + +

Returns the number of display modes available on this adapter.

+
+

Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Identifies the format of the surface type using . Use EnumAdapterModes to see the valid formats.

+

This method returns the number of display modes on this adapter or zero if Adapter is greater than or equal to the number of adapters on the system.

+ + bb174318 + unsigned int IDirect3D9::GetAdapterModeCount([In] unsigned int Adapter,[In] D3DFORMAT Format) + IDirect3D9::GetAdapterModeCount +
+ + +

Queries the device to determine whether the specified adapter supports the requested format and display mode. This method could be used in a loop to enumerate all the available adapter modes.

+
+

Ordinal number denoting the display adapter to enumerate. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns when this value equals or exceeds the number of display adapters in the system.

+

Allowable pixel formats. See Remarks.

+

Represents the display-mode index which is an unsigned integer between zero and the value returned by GetAdapterModeCount minus one.

+

A reference to the available display mode of type . See Remarks.

+ +

An application supplies a display mode and a format to EnumAdapterModes which returns a display mode. This method could be used in a loop to enumerate all available display modes.

The application specifies a format and the enumeration is restricted to those display modes that exactly match the format (alpha is ignored). Allowed formats (which are members of ) are as follows:

In addition, EnumAdapterModes treats pixel formats 565 and 555 as equivalent, and returns the correct version. The difference comes into play only when the application locks the back buffer and there is an explicit flag that the application must set in order to accomplish this.

+
+ + bb174314 + HRESULT IDirect3D9::EnumAdapterModes([In] unsigned int Adapter,[In] D3DFORMAT Format,[In] unsigned int Mode,[Out] D3DDISPLAYMODE* pMode) + IDirect3D9::EnumAdapterModes +
+ + +

Retrieves the current display mode of the adapter.

+
+

Ordinal number that denotes the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Pointer to a structure, to be filled with information describing the current adapter's mode.

+ +

GetAdapterDisplayMode will not return the correct format when the display is in an extended format, such as 2:10:10:10. Instead, it returns the format X8R8G8B8.

+
+ + bb174316 + HRESULT IDirect3D9::GetAdapterDisplayMode([In] unsigned int Adapter,[Out] D3DDISPLAYMODE* pMode) + IDirect3D9::GetAdapterDisplayMode +
+ + +

Verifies whether a hardware accelerated device type can be used on this adapter.

+
+

Ordinal number denoting the display adapter to enumerate. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns when this value equals or exceeds the number of display adapters in the system.

+

Member of the enumerated type, indicating the device type to check.

+

Member of the enumerated type, indicating the format of the adapter display mode for which the device type is to be checked. For example, some devices will operate only in 16-bits-per-pixel modes.

+

Back buffer format. For more information about formats, see . This value must be one of the render-target formats. You can use GetAdapterDisplayMode to obtain the current format. For windowed applications, the back buffer format does not need to match the display mode format if the hardware supports color conversion. The set of possible back buffer formats is constrained, but the runtime will allow any valid back buffer format to be presented to any desktop format. There is the additional requirement that the device be operable in the desktop mode because devices typically do not operate in 8 bits per pixel modes. Full-screen applications cannot do color conversion. is allowed for windowed mode.

+

Value indicating whether the device type will be used in full-screen or windowed mode. If set to TRUE, the query is performed for windowed applications; otherwise, this value should be set .

+

If the device can be used on this adapter, is returned. is returned if Adapter equals or exceeds the number of display adapters in the system. is also returned if CheckDeviceType specified a device that does not exist. is returned if the requested back buffer format is not supported, or if hardware acceleration is not available for the specified formats.

+ +

A hal device type requires hardware acceleration. Applications can use CheckDeviceType to determine if the needed hardware and drivers are present to support a hal device.

Full-screen applications should not specify a DisplayFormat that contains an alpha channel. This will result in a failed call. Note that an alpha channel can be present in the back buffer but the two display formats must be identical in all other respects. For example, if DisplayFormat = , valid values for BackBufferFormat include and but exclude .

The following code fragment shows how you could use CheckDeviceType to test whether a certain device type can be used on this adapter.

 if(SUCCEEDED(pD3Device->CheckDeviceType(D3DADAPTER_DEFAULT,  ,  DisplayFormat,  BackBufferFormat,  bIsWindowed))) return ;	
+            // There is no HAL on this adapter using this render-target format. 	
+            // Try again, using another format.	
+            

This code returns if the device can be used on the default adapter with the specified surface format.

Using CheckDeviceType to test for compatibility between a back buffer that differs from the display format will return appropriate values. This means that the call will reflect device capabilities. If the device cannot render to the requested back-buffer format, the call will still return . If the device can render to the format, but cannot perform the color-converting presentation, the return value will also be . Applications can discover hardware support for the presentation itself by calling CheckDeviceFormatConversion. No software emulation for the color-converting presentation itself will be offered.

+
+ + bb174312 + HRESULT IDirect3D9::CheckDeviceType([In] unsigned int Adapter,[In] D3DDEVTYPE DevType,[In] D3DFORMAT AdapterFormat,[In] D3DFORMAT BackBufferFormat,[In] BOOL bWindowed) + IDirect3D9::CheckDeviceType +
+ + +

Determines whether a surface format is available as a specified resource type and can be used as a texture, depth-stencil buffer, or render target, or any combination of the three, on a device representing this adapter.

+
+

Ordinal number denoting the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns when this value equals or exceeds the number of display adapters in the system.

+

Member of the enumerated type, identifying the device type.

+

Member of the enumerated type, identifying the format of the display mode into which the adapter will be placed.

+

Requested usage options for the surface. Usage options are any combination of and D3DUSAGE_QUERY constants (only a subset of the constants are valid for CheckDeviceFormat; see the table on the page).

+

Resource type requested for use with the queried format. Member of .

+

Format of the surfaces which may be used, as defined by Usage. Member of .

+

If the format is compatible with the specified device for the requested usage, this method returns .

is returned if Adapter equals or exceeds the number of display adapters in the system, or if DeviceType is unsupported.

is returned if the format is not acceptable to the device for this usage.

+ +

Here are some examples using CheckDeviceFormat to check for hardware support of:

  • An off-screen plain surface format - Specify Usage = 0 and RType = .
  • A depth-stencil format - The following snippet tests for the passed in depth-stencil format:
      IsDepthFormatExisting(  DepthFormat,  AdapterFormat ) 	
    +            {  hr = pD3D->CheckDeviceFormat( D3DADAPTER_DEFAULT, , AdapterFormat, , , DepthFormat); return SUCCEEDED( hr );	
    +            }

    See Selecting a Device (Direct3D 9) for more detail on the enumeration process.

  • Can this texture be rendered in a particular format - Given the current display mode, this example shows how to verify that the texture format is compatible with the specific back-buffer format:
      IsTextureFormatOk(  TextureFormat,  AdapterFormat ) 	
    +            {  hr = pD3D->CheckDeviceFormat( D3DADAPTER_DEFAULT, , AdapterFormat, 0, , TextureFormat); return SUCCEEDED( hr );	
    +            }
  • Alpha blending in a pixel shader - Set Usage to . Expect this to fail for all floating-point render targets.
  • Autogeneration of mipmaps - Set Usage to . If the mipmap automatic generation fails, the application will get a non-mipmapped texture. Calling this method is considered a hint, so this method can return (a valid success code) if the only thing that fails is the mipmap generation. For more information about mipmap generation, see Automatic Generation of Mipmaps (Direct3D 9).

When migrating code from Direct3D 9 to Direct3D 10, the Direct3D 10 equivalent to CheckDeviceFormat is CheckFormatSupport.

+
+ + bb174309 + HRESULT IDirect3D9::CheckDeviceFormat([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT AdapterFormat,[In] unsigned int Usage,[In] D3DRESOURCETYPE RType,[In] D3DFORMAT CheckFormat) + IDirect3D9::CheckDeviceFormat +
+ + +

Determines if a multisampling technique is available on this device.

+
+

Ordinal number denoting the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns when this value equals or exceeds the number of display adapters in the system. See Remarks.

+

Member of the enumerated type, identifying the device type.

+

Member of the enumerated type that specifies the format of the surface to be multisampled. For more information, see Remarks.

+

bool value. Specify TRUE to inquire about windowed multisampling, and specify to inquire about full-screen multisampling.

+

Member of the enumerated type, identifying the multisampling technique to test.

+

pQualityLevels returns the number of device-specific sampling variations available with the given sample type. For example, if the returned value is 3, then quality levels 0, 1 and 2 can be used when creating resources with the given sample count. The meanings of these quality levels are defined by the device manufacturer and cannot be queried through D3D. For example, for a particular device different quality levels at a fixed sample count might refer to different spatial layouts of the sample locations or different methods of resolving. This can be null if it is not necessary to return the quality levels.

+

If the device can perform the specified multisampling method, this method returns . is returned if the Adapter or MultiSampleType parameters are invalid. This method returns if the queried multisampling technique is not supported by this device. is returned if DeviceType does not apply to this adapter.

+ +

This method is intended for use with both render-target and depth-stencil surfaces because you must create both surfaces multisampled if you want to use them together.

The following code fragment shows how you could use CheckDeviceMultiSampleType to test for devices that support a specific multisampling method.

 if( SUCCEEDED(pD3D->CheckDeviceMultiSampleType( pCaps->AdapterOrdinal,  pCaps->DeviceType, BackBufferFormat,  , , null ) ) && SUCCEEDED(pD3D->CheckDeviceMultiSampleType( pCaps->AdapterOrdinal,  pCaps->DeviceType, DepthBufferFormat,  , , null ) ) ) return ;	
+            

The preceding code will return if the device supports the full-screen multisampling method with the surface format.

See the remarks in for additional information on working with and setting multisample types and quality levels.

+
+ + bb174311 + HRESULT IDirect3D9::CheckDeviceMultiSampleType([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT SurfaceFormat,[In] BOOL Windowed,[In] D3DMULTISAMPLE_TYPE MultiSampleType,[Out] unsigned int* pQualityLevels) + IDirect3D9::CheckDeviceMultiSampleType +
+ + +

Determines whether a depth-stencil format is compatible with a render-target format in a particular display mode.

+
+

Ordinal number denoting the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Member of the enumerated type, identifying the device type.

+

Member of the enumerated type, identifying the format of the display mode into which the adapter will be placed.

+

Member of the enumerated type, identifying the format of the render-target surface to be tested.

+

Member of the enumerated type, identifying the format of the depth-stencil surface to be tested.

+

If the depth-stencil format is compatible with the render-target format in the display mode, this method returns . can be returned if one or more of the parameters is invalid. If a depth-stencil format is not compatible with the render target in the display mode, then this method returns .

+ +

This method is provided to enable applications to work with hardware requiring that certain depth formats can only work with certain render-target formats.

The behavior of this method has been changed for DirectX 8.1. This method now pays attention to the D24x8 and D32 depth-stencil formats. The previous version assumed that these formats would always be usable with 32- or 16-bit render targets. This method will now return for these formats only if the device is capable of mixed-depth operations.

The following code fragment shows how you could use CheckDeviceFormat to validate a depth stencil format.

  IsDepthFormatOk( DepthFormat,   AdapterFormat,   BackBufferFormat)	
+            { // Verify that the depth format exists  hr = pD3D->CheckDeviceFormat(D3DADAPTER_DEFAULT, , AdapterFormat, , , DepthFormat); if(FAILED(hr)) return ; // Verify that the depth format is compatible hr = pD3D->CheckDepthStencilMatch(D3DADAPTER_DEFAULT, , AdapterFormat, BackBufferFormat, DepthFormat); return SUCCEEDED(hr); }	
+            

The preceding call will return if DepthFormat cannot be used in conjunction with AdapterFormat and BackBufferFormat.

+
+ + bb174308 + HRESULT IDirect3D9::CheckDepthStencilMatch([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT AdapterFormat,[In] D3DFORMAT RenderTargetFormat,[In] D3DFORMAT DepthStencilFormat) + IDirect3D9::CheckDepthStencilMatch +
+ + +

Tests the device to see if it supports conversion from one display format to another.

+
+

Display adapter ordinal number. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns when this value equals or exceeds the number of display adapters in the system.

+

Device type. Member of the enumerated type.

+

Source adapter format. Member of the enumerated type.

+

Target adapter format. Member of the enumerated type.

+

If the method succeeds, the return value is . If the method fails, the return value is . The method will return when the hardware does not support conversion between the two formats.

+ +

Using CheckDeviceType to test for compatibility between a back buffer that differs from the display format will return appropriate values. This means that the call will reflect device capabilities. If the device cannot render to the requested back buffer format, the call will still return . If the device can render to the format, but cannot perform the color-converting presentation, the return value will also be . Applications can discover hardware support for the presentation itself by calling CheckDeviceFormatConversion. No software emulation for the color-converting presentation itself will be offered.

CheckDeviceFormatConversion can also be used to determine which combinations of source surface formats and destination surface formats are permissible in calls to StretchRect.

Color conversion is restricted to the following source and target formats.

  • The source format must be a FOURCC format or a valid back buffer format. For a list of these, see FourCC Formats and BackBuffer or Display Formats.
  • The target format must be one of these unsigned formats:

    ?

+
+ + bb174310 + HRESULT IDirect3D9::CheckDeviceFormatConversion([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] D3DFORMAT SourceFormat,[In] D3DFORMAT TargetFormat) + IDirect3D9::CheckDeviceFormatConversion +
+ + +

Retrieves device-specific information about a device.

+
+

Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Member of the enumerated type. Denotes the device type.

+

Pointer to a structure to be filled with information describing the capabilities of the device.

+ +

The application should not assume the persistence of vertex processing capabilities across Direct3D device objects. The particular capabilities that a physical device exposes may depend on parameters supplied to CreateDevice. For example, the capabilities may yield different vertex processing capabilities before and after creating a Direct3D Device Object with hardware vertex processing enabled. For more information see the description of .

+
+ + bb174320 + HRESULT IDirect3D9::GetDeviceCaps([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[Out] D3DCAPS9* pCaps) + IDirect3D9::GetDeviceCaps +
+ + +

Returns the handle of the monitor associated with the Direct3D object.

+
+

Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Handle of the monitor associated with the Direct3D object.

+ +

As shown in the following code fragment, which illustrates how to obtain a handle to the monitor associated with a given device, use GetDirect3D to return the Direct3D enumerator from the device and use GetCreationParameters to retrieve the value for Adapter.

 if( FAILED( pDevice->GetCreationParameters(  &Parameters ) ) ) return ; if( FAILED( pDevice->GetDirect3D(&pD3D) ) ) return ; hMonitor = pD3D->GetAdapterMonitor(Parameters.AdapterOrdinal); pD3D->Release();	
+            
+
+ + bb174319 + HMONITOR IDirect3D9::GetAdapterMonitor([In] unsigned int Adapter) + IDirect3D9::GetAdapterMonitor +
+ + +

Creates a device to represent the display adapter.

+
+

Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Member of the enumerated type that denotes the desired device type. If the desired device type is not available, the method will fail.

+

The focus window alerts Direct3D when an application switches from foreground mode to background mode. See Remarks.

  • For full-screen mode, the window specified must be a top-level window.
  • For windowed mode, this parameter may be null only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-null value.
+

Combination of one or more options that control device creation. For more information, see .

+

Pointer to a structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies , pPresentationParameters is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created.

For Windows 2000 and Windows XP, the full-screen device display refresh rate is set in the following order:

  1. User-specified nonzero ForcedRefreshRate registry key, if supported by the device.
  2. Application-specified nonzero refresh rate value in the presentation parameter.
  3. Refresh rate of the latest desktop mode, if supported by the device.
  4. 75 hertz if supported by the device.
  5. 60 hertz if supported by the device.
  6. Device default.

An unsupported refresh rate will default to the closest supported refresh rate below it. For example, if the application specifies 63 hertz, 60 hertz will be used. There are no supported refresh rates below 57 hertz.

pPresentationParameters is both an input and an output parameter. Calling this method may change several members including:

  • If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns.
  • If BackBufferFormat equals before the method is called, it will be changed when the method returns.
+

Address of a reference to the returned interface, which represents the created device.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , , .

+ +

This method returns a fully working device interface, set to the required display mode (or windowed), and allocated with the appropriate back buffers. To begin rendering, the application needs only to create and set a depth buffer (assuming EnableAutoDepthStencil is in ).

When you create a Direct3D device, you supply two different window parameters: a focus window (hFocusWindow) and a device window (the hDeviceWindow in ). The purpose of each window is:

  • The focus window alerts Direct3D when an application switches from foreground mode to background mode (via Alt-Tab, a mouse click, or some other method). A single focus window is shared by each device created by an application.
  • The device window determines the location and size of the back buffer on screen. This is used by Direct3D when the back buffer contents are copied to the front buffer during Present.

This method should not be run during the handling of WM_CREATE. An application should never pass a window handle to Direct3D while handling WM_CREATE. Any call to create, release, or reset the device must be done using the same thread as the window procedure of the focus window.

Note that , , and are mutually exclusive flags, and at least one of these vertex processing flags must be specified when calling this method.

Back buffers created as part of the device are only lockable if is specified in the presentation parameters. (Multisampled back buffers and depth surfaces are never lockable.)

The methods Reset, , and TestCooperativeLevel must be called from the same thread that used this method to create a device.

can be specified for the windowed mode back buffer format when calling CreateDevice, Reset, and CreateAdditionalSwapChain. This means the application does not have to query the current desktop format before calling CreateDevice for windowed mode. For full-screen mode, the back buffer format must be specified.

If you attempt to create a device on a 0x0 sized window, CreateDevice will fail.

+
+ + bb174313 + HRESULT IDirect3D9::CreateDevice([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] HWND hFocusWindow,[In] D3DCREATE BehaviorFlags,[In, Buffer] D3DPRESENT_PARAMETERS* pPresentationParameters,[Out, Fast] IDirect3DDevice9** ppReturnedDeviceInterface) + IDirect3D9::CreateDevice +
+ + + Gets the adapters. + + + + +

Returns the number of adapters on the system.

+
+ + bb174315 + GetAdapterCount + GetAdapterCount + unsigned int IDirect3D9::GetAdapterCount() +
+ + +

Applications use the methods of the interface (which inherits from ) to create Microsoft Direct3D 9Ex objects and set up the environment. This interface includes methods for enumerating and retrieving capabilities of the device and is available when the underlying device implementation is compliant with Windows Vista.

+
+ +

The interface is obtained by calling the Direct3DCreate9Ex function.

The LPDIRECT3D9EX and PDIRECT3D9EX types are defined as references to the interface:

 typedef struct  *LPDIRECT3D9EX, *PDIRECT3D9EX;	
+            
+
+ + bb174301 + IDirect3D9Ex + IDirect3D9Ex +
+ + + Creates an object and returns an interface to it. + + + The object is the first object that the application creates and the last object thta the application releases. Functions for enumerating and retrieving capabilities of a device are accessible through the IDirect3D9Ex object. This enables applications to select devices without creating them. The interface supports enumeration of active display adapters and allows the creation of IDirect3D9Ex objects. If the user dynamically adds adapters (either by adding devices to the desktop, or by hot-docking a laptop), these devices are not included in the enumeration. Creating a new IDirect3D9Ex interface will expose the new devices. Pass the D3D_SDK_VERSION flag to this function to ensure that header files used in the compiled application match the version of the installed runtime DLLs. D3D_SDK_VERSION is changed in the runtime only when a header or another code change would require rebuilding the application. If this function fails, it indicates that the versions of the header file and the runtime DLL do not match. Note??Direct3DCreate9Ex is supported only in Windows Vista, Windows Server 2008, and Windows 7. Earlier versions of the D3D9.dll library do not include Direct3D9Ex and Direct3DCreate9Ex. + + D3DERR_NOTAVAILABLE if Direct3DEx features are not supported (no WDDM driver is installed) or if the SDKVersion does not match the version of the DLL. D3DERR_OUTOFMEMORY if out-of-memory conditions are detected when creating the enumerator object. S_OK if the creation of the enumerator object is successful. + HRESULT Direct3DCreate9Ex([None] int SDKVersion,[None] IDirect3D9Ex** arg1) + + + + Retrieves the current display mode and rotation settings of the adapter. + + The adapter. + structure containing data about the display mode of the adapter + HRESULT IDirect3D9Ex::GetAdapterDisplayModeEx([In] unsigned int Adapter,[Out] D3DDISPLAYMODEEX* pMode,[Out] D3DDISPLAYROTATION* pRotation) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Returns the number of display modes available.

+
+

Ordinal number denoting the display adapter from which to retrieve the display mode count.

+

Specifies the characteristics of the desired display mode. See .

+

The number of display modes available. A return of value zero from this method is an indication that no such display mode is supported or simply this monitor is no longer available.

+ +

Events such as display mode changes on other heads of the same hardware, monitor change or its connection status change, and desktop extension/unextension could all affect the number of display mode available.

To fullscreen applications, returned from PresentEx or CheckDeviceState is the indication of display mode setting failure due to those events.

To increase the chance of setting a currently available display mode successfully, fullscreen applications should try to requery the available display mode list upon receiving .

+
+ + bb174306 + unsigned int IDirect3D9Ex::GetAdapterModeCountEx([In] unsigned int Adapter,[In] const D3DDISPLAYMODEFILTER* pFilter) + IDirect3D9Ex::GetAdapterModeCountEx +
+ + +

This method returns the actual display mode info based on the given mode index.

+
+

Ordinal number denoting the display adapter to enumerate. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns when this value equals or exceeds the number of display adapters in the system.

+

See .

+

Represents the display-mode index which is an unsigned integer between zero and the value returned by GetAdapterModeCount minus one.

+

A reference to the available display mode of type .

+ + bb174303 + HRESULT IDirect3D9Ex::EnumAdapterModesEx([In] unsigned int Adapter,[In] const D3DDISPLAYMODEFILTER* pFilter,[In] unsigned int Mode,[Out] D3DDISPLAYMODEEX* pMode) + IDirect3D9Ex::EnumAdapterModesEx +
+ + +

Retrieves the current display mode and rotation settings of the adapter.

+
+

Ordinal number that denotes the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Pointer to a structure indicating the type of screen rotation the application will do. The value returned through this reference is important when the flag is used; otherwise, it can be set to null.

+

Pointer to a structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode. Can be set to null.

+ +

GetAdapterDisplayModeEx does not return the correct format when the display is in an extended format, such as 2:10:10:10. Instead, it returns the format X8R8G8B8.

To windowed applications, a value of returned from PresentEx or CheckDeviceState indicates that the display mode changed and that the current display mode might have a different format. To avoid a color-converting Present blt, windowed applications can optionally get new display mode information by using this method and adjusting its swap chain format accordingly. This method returns if this head is no longer part of the desktop or if the monitor is disconnected.

+
+ + bb174304 + HRESULT IDirect3D9Ex::GetAdapterDisplayModeEx([In] unsigned int Adapter,[Out] D3DDISPLAYMODEEX* pMode,[Out] D3DDISPLAYROTATION* pRotation) + IDirect3D9Ex::GetAdapterDisplayModeEx +
+ + +

Creates a device to represent the display adapter.

+
+

Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter.

+

Specifies the type of device. See . If the desired device type is not available, the method will fail.

+

The focus window alerts Direct3D when an application switches from foreground mode to background mode. For full-screen mode, the window specified must be a top-level window. For windowed mode, this parameter may be null only if the hDeviceWindow member of pPresentationParameters is set to a valid, non-null value.

+

Combination of one or more options (see ) that control device creation.

+

Pointer to a structure, describing the presentation parameters for the device to be created. If BehaviorFlags specifies , this parameter is an array. Regardless of the number of heads that exist, only one depth/stencil surface is automatically created.

This parameter is both an input and an output parameter. Calling this method may change several members including:

  • If BackBufferCount, BackBufferWidth, and BackBufferHeight are 0 before the method is called, they will be changed when the method returns.
  • If BackBufferFormat equals before the method is called, it will be changed when the method returns.
+

The display mode for when the device is set to fullscreen. See . If BehaviorFlags specifies , this parameter is an array. This parameter must be null for windowed mode.

+

Address of a reference to the returned , which represents the created device.

+

This method returns when rendering device along with swapchain buffers are created successfully. is returned when any error other than invalid caller input is encountered.

+ + bb174302 + HRESULT IDirect3D9Ex::CreateDeviceEx([In] unsigned int Adapter,[In] D3DDEVTYPE DeviceType,[In] HWND hFocusWindow,[In] unsigned int BehaviorFlags,[In, Buffer] D3DPRESENT_PARAMETERS* pPresentationParameters,[In, Buffer] D3DDISPLAYMODEEX* pFullscreenDisplayMode,[Out, Fast] IDirect3DDevice9Ex** ppReturnedDeviceInterface) + IDirect3D9Ex::CreateDeviceEx +
+ + +

This method returns a unique identifier for the adapter that is specific to the adapter hardware. Applications can use this identifier to define robust mappings across various APIs (Direct3D 9, DXGI).

+
+

Ordinal number denoting the display adapter from which to retrieve the .

+

A unique identifier for the given adapter.

+ + bb174305 + HRESULT IDirect3D9Ex::GetAdapterLUID([In] unsigned int Adapter,[Out] LUID* pLUID) + IDirect3D9Ex::GetAdapterLUID +
+ + + Gets a collection of installed extended adapters. + + + + + A collection of + + + + + Driver levels support. + + None + + + + Supports for Direct3D7. + + + + + Supports for Direct3D8. + + + + + Supports for Direct3D9. + + + + +

Used to set and query effects, and to choose techniques. An effect object can contain multiple techniques to render the same effect.

+
+ +

The interface is obtained by calling , , or .

The LPD3DXEFFECT type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXEFFECT;	
+            
+
+ + bb205788 + ID3DXEffect + ID3DXEffect +
+ + + Starts an active technique. + + The number of passes needed to render the current technique. + HRESULT ID3DXEffect::Begin([Out] unsigned int* pPasses,[In] D3DXFX Flags) + + + + Compiles an effect from a file. + + The device. + Name of the file. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a file. + + The device. + Name of the file. + The preprocessor defines. + The include file. + The skip constants. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a file. + + The device. + Name of the file. + The preprocessor defines. + The include file. + The skip constants. + The flags. + The pool. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a memory buffer. + + The device. + The buffer. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a memory buffer. + + The device. + The buffer. + The preprocessor defines. + The include file. + The skip constants. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a memory buffer. + + The device. + The buffer. + The preprocessor defines. + The include file. + The skip constants. + The flags. + The pool. + An + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a stream. + + The device. + The stream. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a stream. + + The device. + The stream. + The preprocessor defines. + The include file. + The skip constants. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a stream. + + The device. + The stream. + The preprocessor defines. + The include file. + The skip constants. + The flags. + The pool. + An + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a string. + + The device. + The source data. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a string. + + The device. + The source data. + The preprocessor defines. + The include file. + The skip constants. + The flags. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Compiles an effect from a string. + + The device. + The source data. + The preprocessor defines. + The include file. + The skip constants. + The flags. + The pool. + + An + + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + + + + Set a contiguous range of shader constants with a memory copy. + + The handle. + The data. + + A object describing the result of the operation. + + HRESULT ID3DXEffect::SetRawValue([In] D3DXHANDLE hParameter,[In] const void* pData,[In] unsigned int ByteOffset,[In] unsigned int Bytes) + + + + Set a contiguous range of shader constants with a memory copy. + + The handle. + The data. + + A object describing the result of the operation. + + HRESULT ID3DXEffect::SetRawValue([In] D3DXHANDLE hParameter,[In] const void* pData,[In] unsigned int ByteOffset,[In] unsigned int Bytes) + + + + Set a contiguous range of shader constants with a memory copy. + + The handle. + The data. + The offset. + The count in bytes. + + A object describing the result of the operation. + + HRESULT ID3DXEffect::SetRawValue([In] D3DXHANDLE hParameter,[In] const void* pData,[In] unsigned int ByteOffset,[In] unsigned int Bytes) + + + + Set a contiguous range of shader constants with a memory copy. + + The handle. + The data. + The start index. + The count. + A object describing the result of the operation. + HRESULT ID3DXEffect::SetRawValue([In] D3DXHANDLE hParameter,[In] const void* pData,[In] unsigned int ByteOffset,[In] unsigned int Bytes) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets a reference to the pool of shared parameters.

+
+

Pointer to a object.

+

This method always returns the value .

+ +

Pools contain shared parameters between effects. See Cloning and Sharing (Direct3D 9).

+
+ + bb205827 + HRESULT ID3DXEffect::GetPool([Out] ID3DXEffectPool** ppPool) + ID3DXEffect::GetPool +
+ + +

Sets the active technique.

+
+

Unique handle to the technique. See Handles (Direct3D 9).

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205834 + HRESULT ID3DXEffect::SetTechnique([In] D3DXHANDLE hTechnique) + ID3DXEffect::SetTechnique +
+ + +

Gets the current technique.

+
+

A unique identifier to the current technique. See Handles (Direct3D 9).

+ + bb205825 + D3DXHANDLE ID3DXEffect::GetCurrentTechnique() + ID3DXEffect::GetCurrentTechnique +
+ + +

Validate a technique.

+
+

Unique identifier. See Handles (Direct3D 9).

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , , , , , , , , , , , and .

+ + bb205835 + HRESULT ID3DXEffect::ValidateTechnique([In] D3DXHANDLE hTechnique) + ID3DXEffect::ValidateTechnique +
+ + +

Searches for the next valid technique, starting at the technique after the specified technique.

+
+

Unique identifier to a technique. See Handles (Direct3D 9). Specify null for this parameter to find the first valid technique.

+

Pointer to an identifier for the next technique. null is returned if this is the last technique. See Handles (Direct3D 9).

+ + bb205824 + HRESULT ID3DXEffect::FindNextValidTechnique([In] D3DXHANDLE hTechnique,[Out] D3DXHANDLE* pTechnique) + ID3DXEffect::FindNextValidTechnique +
+ + +

Determines if a parameter is used by the technique.

+
+

Unique identifier for the parameter. See Handles (Direct3D 9).

+

Unique identifier for the technique. See Handles (Direct3D 9).

+

Returns TRUE if the parameter is being used and returns if the parameter is not being used.

+ + bb205829 + BOOL ID3DXEffect::IsParameterUsed([In] D3DXHANDLE hParameter,[In] D3DXHANDLE hTechnique) + ID3DXEffect::IsParameterUsed +
+ + +

Starts an active technique.

+
+

DWORD that determines if state modified by an effect is saved and restored. The default value 0 specifies that and will save and restore all state modified by the effect (including pixel and vertex shader constants). Valid flags can be seen at Effect State Save and Restore Flags.

+

Pointer to a value returned that indicates the number of passes needed to render the current technique.

+ +

An application sets one active technique in the effect system by calling . The effect system responds by capturing all the pipeline state that can be changed by the technique in a state block. An application signals the end of a technique by calling , which uses the state block to restore the original state. The effect system, therefore, takes care of saving state when a technique becomes active and restoring state when a technique ends. If you choose to disable this save and restore functionality, see .

Within the and pair, an application uses to set the active pass, if any state changes occurred after the pass was activated, and to end the active pass.

+
+ + bb205815 + HRESULT ID3DXEffect::Begin([Out] unsigned int* pPasses,[In] D3DXFX Flags) + ID3DXEffect::Begin +
+ + +

Begins a pass, within the active technique.

+
+

A zero-based integer index into the technique.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

An application sets one active pass (within one active technique) in the effect system by calling . An application signals the end of the active pass by calling . and must occur in a matching pair, within a matching pair of and calls.

If the application changes any effect state using any of the Effect::Setx methods inside of a / matching pair, the application must call to set the update the device with the state changes. If no state changes occur within a and matching pair, it is not necessary to call .

+
+ + bb205817 + HRESULT ID3DXEffect::BeginPass([In] unsigned int Pass) + ID3DXEffect::BeginPass +
+ + +

Propagate state changes that occur inside of an active pass to the device before rendering.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

If the application changes any effect state using any of the ID3DXEffect::Setx methods inside of an / matching pair, the application must call before any DrawxPrimitive call to propagate state changes to the device before rendering. If no state changes occur within a and matching pair, it is not necessary to call .

This is slightly different for any shared parameters in a cloned effect. When a technique is active on a cloned effect (that is, when has been called but and has not been called), updates parameters that are not shared as expected. To update a shared parameter (only for a cloned effect whose technique is active), call to deactivate the technique and to reactivate the technique before calling .

+
+ + bb205819 + HRESULT ID3DXEffect::CommitChanges() + ID3DXEffect::CommitChanges +
+ + +

End an active pass.

+
+

This method always returns the value .

+ +

An application signals the end of rendering an active pass by calling . Each must be part of a matching pair of and calls.

Each matching pair of and calls must be located within a matching pair of and calls.

If the application changes any effect state using any of the Effect::Setx methods inside of a / matching pair, the application must call before any DrawxPrimitive call to propagate state changes to the device before rendering.

+
+ + bb205823 + HRESULT ID3DXEffect::EndPass() + ID3DXEffect::EndPass +
+ + +

Ends an active technique.

+
+

This method always returns the value .

+ +

All rendering in an effect is done within a matching pair of and calls. After all passes are rendered, must be called to end the active technique. The effect system responds by using the state block created when was called, to automatically restore the pipeline state before .

By default, the effect system takes care of saving state prior to a technique, and restoring state after a technique. If you choose to disable this save and restore functionality, see .

+
+ + bb205821 + HRESULT ID3DXEffect::End() + ID3DXEffect::End +
+ + +

Retrieves the device associated with the effect.

+
+

Address of a reference to an interface, representing the device associated with the effect.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Calling this method will increase the internal reference count for the interface. Be sure to call IUnknown::Release when you are done using the interface or you will have a memory leak.

+
+ + bb205826 + HRESULT ID3DXEffect::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXEffect::GetDevice +
+ + +

Use this method to release all references to video memory resources and delete all stateblocks. This method should be called whenever a device is lost, or before resetting a device.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method should be called whenever the device is lost or before the user calls . Even if the device was not actually lost, is responsible for freeing stateblocks and other resources that may need to be released before resetting the device. As a result, the font object cannot be used again before calling and then .

+
+ + bb205830 + HRESULT ID3DXEffect::OnLostDevice() + ID3DXEffect::OnLostDevice +
+ + +

Use this method to re-acquire resources and save initial state.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

should be called each time the device is reset (using ), before any other methods are called. This is a good place to re-acquire video-memory resources and capture state blocks.

+
+ + bb205831 + HRESULT ID3DXEffect::OnResetDevice() + ID3DXEffect::OnResetDevice +
+ + +

Set the effect state manager.

+
+

A reference to the state manager. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

The is a user-implemented interface that furnishes callbacks into an application for setting device state from an effect.

+
+ + bb205833 + HRESULT ID3DXEffect::SetStateManager([In] ID3DXEffectStateManager* pManager) + ID3DXEffect::SetStateManager +
+ + +

Get the effect state manager.

+
+

Returns a reference to the state manager. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

The is a user-implemented interface that furnishes callbacks into an application for setting device state from an effect.

+
+ + bb205828 + HRESULT ID3DXEffect::GetStateManager([Out] ID3DXEffectStateManager** ppManager) + ID3DXEffect::GetStateManager +
+ + +

Start capturing state changes in a parameter block.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

Capture effect parameter state changes until EndParameterBlock is called. Effect parameters include any state changes outside of a pass. Delete parameter blocks if they are no longer needed by calling DeleteParameterBlock.

+
+ + bb205816 + HRESULT ID3DXEffect::BeginParameterBlock() + ID3DXEffect::BeginParameterBlock +
+ + +

Stop capturing effect parameter state changes.

+
+

Returns a handle to the parameter state block.

+ +

All effect parameters that change state (after calling BeginParameterBlock and before calling EndParameterBlock) will be saved in an effect parameter state block. Use ApplyParameterBlock to apply this block of state changes to the effect system. Once you are finished with a state block use DeleteParameterBlock to free the memory.

+
+ + bb205822 + D3DXHANDLE ID3DXEffect::EndParameterBlock() + ID3DXEffect::EndParameterBlock +
+ + +

Apply the values in a state block to the current effect system state.

+
+

A handle to the parameter block. This is the handle returned by .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

Capture effect parameter state changes in a parameter block by calling BeginParameterBlock; stop capturing state changes by calling EndParameterBlock. These state changes include any effect parameter changes that occur inside of a technique (including those outside of a pass). Once you are done with the parameter block, call DeleteParameterBlock to recover memory.

+
+ + bb205814 + HRESULT ID3DXEffect::ApplyParameterBlock([In] D3DXHANDLE hParameterBlock) + ID3DXEffect::ApplyParameterBlock +
+ + +

Delete a parameter block.

+
+

A handle to the parameter block. This is the handle returned by .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

Parameter blocks are blocks of effect states. Use a parameter block to record state changes so that they can be applied later on with a single API call. When no longer needed, delete the parameter block to reduce memory usage.

+
+ + bb205820 + HRESULT ID3DXEffect::DeleteParameterBlock([In] D3DXHANDLE hParameterBlock) + ID3DXEffect::DeleteParameterBlock +
+ + +

Creates a copy of an effect.

+
+

Pointer to an interface, representing the device associated with the effect.

+

Pointer to an interface, containing the cloned effect.

+ +

Note??This function will not clone an effect if the user specifies during effect creation.

To update shared and non-shared parameters in an active technique of a cloned effect, see .

+
+ + bb205818 + HRESULT ID3DXEffect::CloneEffect([In] IDirect3DDevice9* pDevice,[Out] ID3DXEffect** ppEffect) + ID3DXEffect::CloneEffect +
+ + +

Set a contiguous range of shader constants with a memory copy.

+
+

Handle to the value to set, or the name of the value passed in as a string. Passing in a handle is more efficient. See Handles (Direct3D 9).

+

Pointer to a buffer containing the data to be set. SetRawValue checks for valid memory, but does not do any checking for valid data.

+

Number of bytes between the beginning of the effect data and the beginning of the effect constants you are going to set.

+

The size of the buffer to be set, in bytes.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following:E_INVALIDCALL.

+ +

SetRawValue is a very fast way to set effect constants since it performs a memory copy without performing validation or any data conversion (like converting a row-major matrix to a column-major matrix). Use SetRawValue to set a series of contiguous effect constants. For instance, you could set an array of twenty matrices with 20 calls to or by using a single SetRawValue.

All values are expected to be either matrix4x4s or float4s and all matrices are expected to be in column-major order. Int or float values are cast into a float4; therefore, it is highly recommended that you use SetRawValue with only float4 or matrix4x4 data.

+
+ + bb205832 + HRESULT ID3DXEffect::SetRawValue([In] D3DXHANDLE hParameter,[In] const void* pData,[In] unsigned int ByteOffset,[In] unsigned int Bytes) + ID3DXEffect::SetRawValue +
+ + + Gets or sets the current technique. + + + The technique. + + D3DXHANDLE ID3DXEffect::GetCurrentTechnique() + HRESULT ID3DXEffect::SetTechnique([In] D3DXHANDLE hTechnique) + + + +

Gets a reference to the pool of shared parameters.

+
+ +

Pools contain shared parameters between effects. See Cloning and Sharing (Direct3D 9).

+
+ + bb205827 + GetPool + GetPool + HRESULT ID3DXEffect::GetPool([Out] ID3DXEffectPool** ppPool) +
+ + +

Retrieves the device associated with the effect.

+
+ +

Calling this method will increase the internal reference count for the interface. Be sure to call IUnknown::Release when you are done using the interface or you will have a memory leak.

+
+ + bb205826 + GetDevice + GetDevice + HRESULT ID3DXEffect::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Get or sets the effect state manager.

+
+ +

The is a user-implemented interface that furnishes callbacks into an application for setting device state from an effect.

+
+ + bb205828 + GetStateManager / SetStateManager + GetStateManager + HRESULT ID3DXEffect::GetStateManager([Out] ID3DXEffectStateManager** ppManager) +
+ + +

Compiles a shader from an effect that contains one or more functions.

+
+ +

Targets can be specified for vertex shaders, pixel shaders, and texture fill functions.

Vertex shader targetsvs_1_1, vs_2_0, vs_2_sw, vs_3_0
Pixel shader targetsps_1_1, ps_1_2, ps_1_3, ps_1_4, ps_2_0, ps_2_sw, ps_3_0
Texture fill targetstx_0, tx_1

?

This method compiles a shader from a function that is written in a C-like language. For more information, see HLSL.

+
+ + bb205791 + ID3DXEffectCompiler + ID3DXEffectCompiler +
+ + + Initializes a new instance of the class. + + The data. + The defines. + The include file. + The flags. + HRESULT D3DXCreateEffectCompiler([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + + + + Compile an effect. + + The flags. + If a compilation errors occurs + Buffer containing the compiled effect. + HRESULT ID3DXEffectCompiler::CompileEffect([In] unsigned int Flags,[In] ID3DXBuffer** ppEffect,[In] ID3DXBuffer** ppErrorMsgs) + + + + Compiles a shader from an effect that contains one or more functions. + + The function handle. + The target. + The flags. + If a compilation errors occurs + The bytecode of the effect. + HRESULT ID3DXEffectCompiler::CompileShader([In] D3DXHANDLE hFunction,[In] const char* pTarget,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles a shader from an effect that contains one or more functions. + + The function handle. + The target. + The flags. + The constant table. + If a compilation errors occurs + The bytecode of the effect. + HRESULT ID3DXEffectCompiler::CompileShader([In] D3DXHANDLE hFunction,[In] const char* pTarget,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Creates an effect compiler from a file on disk containing an ASCII effect description . + + Name of the file. + The flags. + + An instance of + + HRESULT D3DXCreateEffectCompiler([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[Out, Fast] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + + + + Creates an effect compiler from a file on disk containing an ASCII effect description . + + Name of the file. + The defines. + The include file. + The flags. + + An instance of + + HRESULT D3DXCreateEffectCompiler([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[Out, Fast] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + + + + Creates an effect compiler from a memory buffer containing an ASCII effect description . + + The data. + The flags. + + An instance of + + HRESULT D3DXCreateEffectCompiler([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[Out, Fast] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + + + + Creates an effect compiler from a memory buffer containing an ASCII effect description . + + The data. + The defines. + The include file. + The flags. + + An instance of + + HRESULT D3DXCreateEffectCompiler([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[Out, Fast] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + + + + Creates an effect compiler from a stream containing an ASCII effect description . + + The stream. + The flags. + + An instance of + + HRESULT D3DXCreateEffectCompiler([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[Out, Fast] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + + + + Creates an effect compiler from a stream containing an ASCII effect description . + + The stream. + The defines. + The include file. + The flags. + An instance of + HRESULT D3DXCreateEffectCompiler([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[Out, Fast] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Toggles the literal status of a parameter. A literal parameter has a value that doesn't change during the lifetime of an effect.

+
+

Unique identifier to a parameter. See Handles (Direct3D 9).

+

Set to TRUE to make the parameter a literal, and if the parameter can change value during the shader lifetime.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This methods only changes whether the parameter is a literal or not. To change the value of a parameter, use a method like or .

This function must be called before the effect is compiled. Here is an example of how one might use this function:

 LPD3DXEFFECTCOMPILER pEffectCompiler; char errors[1000];  hr; hr = ("shader.fx", null, null, 0, &pEffectCompiler,  &errors); //In the fx file, literalInt is declared as an int. //By calling this function, the compiler will treat //it as a literal (i.e. #define) hr = pEffectCompiler->SetLiteral("literalInt", TRUE); //create ten different variations of the same effect LPD3DXBUFFER pEffects[10]; LPD3DXBUFFER pErrors; for(int i = 0; i < 10; ++i) { hr = pEffectCompiler->SetInt("literalInt", i); hr = pEffectCompiler->CompileEffect(0, &pEffects[i], &pErrors); }	
+            
+
+ + bb205793 + HRESULT ID3DXEffectCompiler::SetLiteral([In] D3DXHANDLE hParameter,[In] BOOL Literal) + ID3DXEffectCompiler::SetLiteral +
+ + +

Gets a literal status of a parameter. A literal parameter has a value that doesn't change during the lifetime of an effect.

+
+

Unique identifier to a parameter. See Handles (Direct3D 9).

+

Returns True if the parameter is a literal, and False otherwise.

+ +

This methods only changes whether the parameter is a literal or not. To change the value of a parameter, use a method like or .

+
+ + bb205792 + HRESULT ID3DXEffectCompiler::GetLiteral([In] D3DXHANDLE hParameter,[Out] BOOL* pLiteral) + ID3DXEffectCompiler::GetLiteral +
+ + +

Compile an effect.

+
+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Buffer containing the compiled effect. For more information about accessing the buffer, see .

+

Buffer containing at least the first compile error message that occurred. This includes effect compiler errors and high-level language compile errors. For more information about accessing the buffer, see .

+

If the method succeeds, the return value is .

If the arguments are invalid, the method will return .

If the method fails, the return value will be E_FAIL.

+ + bb205790 + HRESULT ID3DXEffectCompiler::CompileEffect([In] unsigned int Flags,[In] ID3DXBuffer** ppEffect,[In] ID3DXBuffer** ppErrorMsgs) + ID3DXEffectCompiler::CompileEffect +
+ + +

Compiles a shader from an effect that contains one or more functions.

+
+

Unique identifier to the function to be compiled. This value must not be null. See Handles (Direct3D 9).

+

Pointer to a shader profile which determines the shader instruction set. See or for a list of the profiles available.

+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Buffer containing the compiled shader. The compiler shader is an array of DWORDs. For more information about accessing the buffer, see .

+

Buffer containing at least the first compile error message that occurred. This includes effect compiler errors and high-level language compile errors. For more information about accessing the buffer, see .

+

Returns an interface, which can be used to access shader constants. This value can be null. If you compile your application as large address aware (that is, you use the /LARGEADDRESSAWARE linker option to handle addresses larger than 2 GB), you cannot use this parameter and must set it to null. Instead, you must use the function to retrieve the shader-constant table that is embedded inside the shader. In this call, you must pass the D3DXCONSTTABLE_LARGEADDRESSAWARE flag to the Flags parameter to specify to access up to 4 GB of virtual address space.

+

If the method succeeds, the return value is .

If the arguments are invalid, the method will return .

If the method fails, the return value will be E_FAIL.

+ +

Targets can be specified for vertex shaders, pixel shaders, and texture fill functions.

Vertex shader targetsvs_1_1, vs_2_0, vs_2_sw, vs_3_0
Pixel shader targetsps_1_1, ps_1_2, ps_1_3, ps_1_4, ps_2_0, ps_2_sw, ps_3_0
Texture fill targetstx_0, tx_1

?

This method compiles a shader from a function that is written in a C-like language. For more information, see HLSL.

+
+ + bb205791 + HRESULT ID3DXEffectCompiler::CompileShader([In] D3DXHANDLE hFunction,[In] const char* pTarget,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + ID3DXEffectCompiler::CompileShader +
+ + +

Effect default parameters.

+
+ + bb172821 + D3DXEFFECTDEFAULT + D3DXEFFECTDEFAULT +
+ + +

Parameter name.

+
+ + bb172821 + char* pParamName + char pParamName +
+ + +

Data type in pValue. For more information, see

+
+ + bb172821 + D3DXEFFECTDEFAULTTYPE Type + D3DXEFFECTDEFAULTTYPE Type +
+ + +

Size, in bytes, of the data pointed to by pValue.

+
+ + bb172821 + unsigned int NumBytes + unsigned int NumBytes +
+ + +

Pointer to the memory location that contains the data.

+
+ + bb172821 + void* pValue + void pValue +
+ + + Gets the value. + + + + +

Data type for managing a set of default effect parameters.

+
+ + bb172823 + D3DXEFFECTINSTANCE + D3DXEFFECTINSTANCE +
+ + +

Name of the effect file.

+
+ + bb172823 + char* pEffectFilename + char pEffectFilename +
+ + +

Number of default parameters.

+
+ + bb172823 + unsigned int NumDefaults + unsigned int NumDefaults +
+ + +

Pointer to an array of elements, each of which contains an effect parameter.

+
+ + bb172823 + D3DXEFFECTDEFAULT* pDefaults + D3DXEFFECTDEFAULT pDefaults +
+ + +

Applications use the interface to identify parameters that are going to be shared across effects. See parameter sharing in Cloning and Sharing (Direct3D 9). This interface has no methods.

+
+ +

The interface is obtained by calling .

The LPD3DXEFFECTPOOL type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXEFFECTPOOL;	
+            
+
+ + bb205794 + ID3DXEffectPool + ID3DXEffectPool +
+ + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + A callback function used to fill 2D texture. + + Texture coordinate being sampled. + Dimensions of the texel. + The desired color of the specified texel. + typedef VOID (WINAPI *LPD3DXFILL2D)(D3DXVECTOR4 *pOut, CONST D3DXVECTOR2 *pTexCoord, CONST D3DXVECTOR2 *pTexelSize, LPVOID pData); + + + + A callback function used to fill 3D texture. + + Texture coordinate being sampled. + Dimensions of the texel. + The desired color of the specified texel. + typedef VOID (WINAPI *LPD3DXFILL2D)(D3DXVECTOR4 *pOut, CONST D3DXVECTOR2 *pTexCoord, CONST D3DXVECTOR2 *pTexelSize, LPVOID pData); + + + + Fill callback helper class. + + + + + Pointer to the native callback for 2D function + + + + + Pointer to the native callback for 3D function + + + + + EffectHandle used to identify a shader parameter. + + + + + Defines the behaviour for caching strings. True by default. + + + + + Cache of allocated strings. + + + + + Pointer to the handle or the allocated string. + + + + + If the is a custom string not cached that needs to be released by this instance. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + The pointer. + + + + + Initializes a new instance of the class. + + + The pointer. + + + + + Initializes a new instance of the class. + + + The name. + + + + + Clears the cache. + + + By default, this class is caching all strings that are implicitly used as an effect handle. + Use this method in order to deallocate all strings that were previously cached. + + + + + marshal free. + + The __from. + The @ref. + + + + Method to marshal from native to managed struct + + The __from. + The @ref. + + + + Method to marshal from managed struct tot native + + The __from. + The @ref. + + + + + + + Allocates a string. + + + The name. + + + Pointer to the allocated string + + + + + Performs an implicit conversion from to . + + The value. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The value. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The value. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The value. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The name. + + The result of the conversion. + + + + +

The interface encapsulates the textures and resources needed to render a specific font on a specific device.

+
+ +

The interface is obtained by calling or .

The LPD3DXFONT type is defined as a reference to the interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXFONT;	
+            
+
+ + bb173961 + ID3DXFont + ID3DXFont +
+ + + Initializes a new instance of the class. + + The device. + The font description. + + + + Initializes a new instance of the class from a + + The device. + The font. + + + + Initializes a new instance of the class. + + The device. + The height. + The width. + The weight. + The mip levels. + if set to true [is italic]. + The character set. + The precision. + The quality. + The pitch and family. + Name of the face. + + + + Load formatted text into video memory to improve the efficiency of rendering to the device. This method supports ANSI and Unicode strings. + + + The compiler setting also determines the function version. If Unicode is defined, the function call resolves to PreloadTextW. Otherwise, the function call resolves to PreloadTextA because ANSI strings are being used. This method generates textures that contain glyphs that represent the input text. The glyphs are drawn as a series of triangles. Text will not be rendered to the device; ID3DX10Font::DrawText must still be called to render the text. However, by preloading text into video memory, ID3DX10Font::DrawText will use substantially fewer CPU resources. This method internally converts characters to glyphs using the GDI function {{GetCharacterPlacement}}. + + Pointer to a string of characters to be loaded into video memory. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR; otherwise, the data type resolves to LPCSTR. See Remarks. + If the method succeeds, the return value is S_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DXERR_INVALIDDATA. + HRESULT ID3DX10Font::PreloadTextW([None] const wchar_t* pString,[None] int Count) + + + + + Draws formatted text. + + Pointer to an object that contains the string. Can be null, in which case Direct3D will render the string with its own sprite object. To improve efficiency, a sprite object should be specified if DrawText is to be called more than once in a row. + Pointer to a string to draw. If the Count parameter is -1, the string must be null-terminated. + The x position to draw the text. + The y position to draw the text. + Color of the text. For more information, see . + + If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from pRect (top to the bottom) of the drawn text. If the function fails, the return value is zero. + + int ID3DXFont::DrawTextW([In] ID3DXSprite* pSprite,[In] const wchar_t* pString,[In] int Count,[In] void* pRect,[In] unsigned int Format,[In] D3DCOLOR Color) + + The parameters of this method are very similar to those of the GDI DrawText function.This method supports both ANSI and Unicode strings.This method must be called inside a BeginScene ... EndScene block. The only exception is when an application calls DrawText with DT_CALCRECT to calculate the size of a given block of text.Unless the DT_NOCLIP format is used, this method clips the text so that it does not appear outside the specified rectangle. All formatting is assumed to have multiple lines unless the DT_SINGLELINE format is specified.If the selected font is too large for the rectangle, this method does not attempt to substitute a smaller font.This method supports only fonts whose escapement and orientation are both zero. + + + + + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the Direct3D device associated with the font object.

+
+

Address of a reference to an interface, representing the Direct3D device object associated with the font object.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

Note??Calling this method will increase the internal reference count on the interface. Be sure to call when you are done using this interface or you will have a memory leak.

+
+ + bb173965 + HRESULT ID3DXFont::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXFont::GetDevice +
+ + +

Gets a description of the current font object. GetDescW and GetDescA are identical to this method, except that a reference is returned to a or D3DXFONT_DESCA structure, respectively.

+
+ No documentation. +

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

This method describes Unicode font objects if UNICODE is defined. Otherwise GetDescA is called, which returns a reference to the D3DXFONT_DESCA structure.

+
+ + bb173964 + HRESULT ID3DXFont::GetDescW([Out] D3DXFONT_DESCW* pDesc) + ID3DXFont::GetDescW +
+ + +

Retrieves font characteristics that are identified in a structure. This method supports ANSI and Unicode compiler settings.

+
+ No documentation. +

Nonzero if the function is successful; otherwise 0.

+ +

The compiler setting also determines the structure type. If Unicode is defined, the function returns a structure. Otherwise, the function call returns a structure.

+
+ + bb173967 + BOOL ID3DXFont::GetTextMetricsW([Out] TEXTMETRICW* pTextMetrics) + ID3DXFont::GetTextMetricsW +
+ + +

Returns a handle to a display device context (DC) that has the font set.

+
+

Handle to a display DC.

+ + bb173963 + HDC ID3DXFont::GetDC() + ID3DXFont::GetDC +
+ + +

Returns information about the placement and orientation of a glyph in a character cell.

+
+

Glyph identifier.

+

Address of a reference to a object that contains the glyph.

+

Pointer to the smallest rectangle object that completely encloses the glyph.

+

Pointer to the two-dimensional vector that connects the origin of the current character cell to the origin of the next character cell. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb173966 + HRESULT ID3DXFont::GetGlyphData([In] unsigned int Glyph,[Out] IDirect3DTexture9** ppTexture,[Out] RECT* pBlackBox,[Out] POINT* pCellInc) + ID3DXFont::GetGlyphData +
+ + +

Loads a series of characters into video memory to improve the efficiency of rendering to the device.

+
+

ID of the first character to be loaded into video memory.

+

ID of the last character to be loaded into video memory.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

This method generates textures containing glyphs that represent the input characters. The glyphs are drawn as a series of triangles.

Characters will not be rendered to the device; DrawText must still be called to render the characters. However, by pre-loading characters into video memory, DrawText will use substantially fewer CPU resources.

This method internally converts characters to glyphs using the GDI function GetCharacterPlacement.

+
+ + bb173970 + HRESULT ID3DXFont::PreloadCharacters([In] unsigned int First,[In] unsigned int Last) + ID3DXFont::PreloadCharacters +
+ + +

Loads a series of glyphs into video memory to improve the efficiency of rendering to the device.

+
+

ID of the first glyph to be loaded into video memory.

+

ID of the last glyph to be loaded into video memory.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

This method generates textures that contain the input glyphs. The glyphs are drawn as a series of triangles.

Glyphs will not be rendered to the device; DrawText must still be called to render the glyphs. However, by pre-loading glyphs into video memory, DrawText will use substantially fewer CPU resources.

+
+ + bb173971 + HRESULT ID3DXFont::PreloadGlyphs([In] unsigned int First,[In] unsigned int Last) + ID3DXFont::PreloadGlyphs +
+ + +

Loads formatted text into video memory to improve the efficiency of rendering to the device. This method supports ANSI and Unicode strings.

+
+

Pointer to a string of characters to be loaded into video memory. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR; otherwise, the data type resolves to LPCSTR. See Remarks.

+

Number of characters in the text string.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to PreloadTextW. Otherwise, the function call resolves to PreloadTextA because ANSI strings are being used.

This method generates textures that contain glyphs that represent the input text. The glyphs are drawn as a series of triangles.

Text will not be rendered to the device; DrawText must still be called to render the text. However, by preloading text into video memory, DrawText will use substantially fewer CPU resources.

This method internally converts characters to glyphs using the GDI function GetCharacterPlacement.

+
+ + bb173972 + HRESULT ID3DXFont::PreloadTextW([In] const wchar_t* pString,[In] int Count) + ID3DXFont::PreloadTextW +
+ + +

Draws formatted text. This method supports ANSI and Unicode strings.

+
+

Pointer to an object that contains the string. Can be null, in which case Direct3D will render the string with its own sprite object. To improve efficiency, a sprite object should be specified if DrawText is to be called more than once in a row.

+

Pointer to a string to draw. If the Count parameter is -1, the string must be null-terminated.

+

Specifies the number of characters in the string. If Count is -1, then the pString parameter is assumed to be a reference to a null-terminated string and DrawText computes the character count automatically.

+

Pointer to a structure that contains the rectangle, in logical coordinates, in which the text is to be formatted. The coordinate value of the rectangle's right side must be greater than that of its left side. Likewise, the coordinate value of the bottom must be greater than that of the top.

+

Specifies the method of formatting the text. It can be any combination of the following values:

ValueMeaning
DT_BOTTOM

Justifies the text to the bottom of the rectangle. This value must be combined with DT_SINGLELINE.

DT_CALCRECT

Determines the width and height of the rectangle. If there are multiple lines of text, DrawText uses the width of the rectangle pointed to by the pRect parameter and extends the base of the rectangle to bound the last line of text. If there is only one line of text, DrawText modifies the right side of the rectangle so that it bounds the last character in the line. In either case, DrawText returns the height of the formatted text but does not draw the text.

DT_CENTER

Centers text horizontally in the rectangle.

DT_EXPANDTABS

Expands tab characters. The default number of characters per tab is eight.

DT_LEFT

Aligns text to the left.

DT_NOCLIP

Draws without clipping. DrawText is somewhat faster when DT_NOCLIP is used.

DT_RIGHT

Aligns text to the right.

DT_RTLREADING

Displays text in right-to-left reading order for bidirectional text when a Hebrew or Arabic font is selected. The default reading order for all text is left-to-right.

DT_SINGLELINE

Displays text on a single line only. Carriage returns and line feeds do not break the line.

DT_TOP

Top-justifies text.

DT_VCENTER

Centers text vertically (single line only).

DT_WORDBREAK

Breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the pRect parameter. A carriage return/line feed sequence also breaks the line.

?

+

Color of the text. For more information, see .

+

If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from pRect (top to the bottom) of the drawn text. If the function fails, the return value is zero.

+ +

The parameters of this method are very similar to those of the GDI DrawText function.

This method supports both ANSI and Unicode strings.

This method must be called inside a BeginScene ... EndScene block. The only exception is when an application calls DrawText with DT_CALCRECT to calculate the size of a given block of text.

Unless the DT_NOCLIP format is used, this method clips the text so that it does not appear outside the specified rectangle. All formatting is assumed to have multiple lines unless the DT_SINGLELINE format is specified.

If the selected font is too large for the rectangle, this method does not attempt to substitute a smaller font.

This method supports only fonts whose escapement and orientation are both zero.

+
+ + bb173962 + int ID3DXFont::DrawTextW([In] ID3DXSprite* pSprite,[In] const wchar_t* pString,[In] int Count,[In] void* pRect,[In] unsigned int Format,[In] D3DCOLOR Color) + ID3DXFont::DrawTextW +
+ + +

Use this method to release all references to video memory resources and delete all stateblocks. This method should be called whenever a device is lost, or before resetting a device.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method should be called whenever the device is lost or before the user calls Reset. Even if the device was not actually lost, OnLostDevice is responsible for freeing stateblocks and other resources that may need to be released before resetting the device. As a result, the font object cannot be used again before calling Reset and then OnResetDevice.

+
+ + bb173968 + HRESULT ID3DXFont::OnLostDevice() + ID3DXFont::OnLostDevice +
+ + +

Use this method to re-acquire resources and save initial state.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

OnResetDevice should be called each time the device is reset (using Reset), before any other methods are called. This is a good place to re-acquire video-memory resources and capture state blocks.

+
+ + bb173969 + HRESULT ID3DXFont::OnResetDevice() + ID3DXFont::OnResetDevice +
+ + +

Retrieves the Direct3D device associated with the font object.

+
+ +

Note??Calling this method will increase the internal reference count on the interface. Be sure to call when you are done using this interface or you will have a memory leak.

+
+ + bb173965 + GetDevice + GetDevice + HRESULT ID3DXFont::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Gets a description of the current font object. GetDescW and GetDescA are identical to this method, except that a reference is returned to a or D3DXFONT_DESCA structure, respectively.

+
+ +

This method describes Unicode font objects if UNICODE is defined. Otherwise GetDescA is called, which returns a reference to the D3DXFONT_DESCA structure.

+
+ + bb173964 + GetDescW + GetDescW + HRESULT ID3DXFont::GetDescW([Out] D3DXFONT_DESCW* pDesc) +
+ + +

Returns a handle to a display device context (DC) that has the font set.

+
+ + bb173963 + GetDC + GetDC + HDC ID3DXFont::GetDC() +
+ + + Defines possible character sets for fonts. + + CHARSET + + + + The ANSI character set. + + + + + The Arabic character set. + + + + + The Baltic character set. + + + + + The Chinese character set. + + + + + The default system character set. + + + + + The East Europe character set. + + + + + The GB2312 character set. + + + + + The Greek character set. + + + + + The Hangul character set. + + + + + The Hebrew character set. + + + + + The Johab character set. + + + + + The Mac character set. + + + + + The OEM character set. + + + + + The Russian character set. + + + + + The ShiftJIS character set. + + + + + The symbol character set. + + + + + The Thai character set. + + + + + The Turkish character set. + + + + + The Vietnamese character set. + + + + + Specifies formatting options for text rendering. + + DT + + + + Align the text to the bottom. + + + + + Align the text to the center. + + + + + Expand tab characters. + + + + + Align the text to the left. + + + + + Don't clip the text. + + + + + Align the text to the right. + + + + + Rendering the text in right-to-left reading order. + + + + + Force all text to a single line. + + + + + Align the text to the top. + + + + + Vertically align the text to the center. + + + + + Allow word breaks. + + + + + Defines pitch and family settings for fonts. + + + + + Use the Decorative family. + + + + + Default pitch. + + + + + The font family doesn't matter. + + + + + Fixed pitch. + + + + + Use the Modern family. + + + + + Mono pitch. + + + + + Use the Roman family. + + + + + Use the Script family. + + + + + Use the Swiss family. + + + + + Variable pitch. + + + + + Defines precision levels for font rendering. + + OutPrecision + + + + Default + + + + + String + + + + + Character + + + + + Stroke + + + + + TrueType + + + + + Device + + + + + Raster + + + + + TrueTypeOnly + + + + + Outline + + + + + ScreenOutline + + + + + PostScriptOnly + + + + + Specifies quality options for font rendering. + + QUALITY + + + + Default + + + + + Draft + + + + + Proof + + + + + Non antialiased + + + + + Antialiased + + + + + ClearType + + + + + ClearTypeNatural + + + + + Specifies weights for font rendering. + + FW + + + + Use a black weight. + + + + + Use a bold weight. + + + + + Use a demi-bold weight. + + + + + The font weight doesn't matter. + + + + + Use an extra bold weight. + + + + + Make the font extra light. + + + + + Use a heavy weight. + + + + + Make the font light. + + + + + Use a medium weight. + + + + + Use a normal weight. + + + + + Use a regular weight. + + + + + Use a semi-bold weight. + + + + + Make the font thin. + + + + + Use an ultra bold weight. + + + + + Make the font ultra light. + + + + +

Defines constants that describe the type of back buffer.

+
+ +

Direct3D 9 does not support stereo view, so Direct3D does not use the and values of this enumerated type.

+
+ + bb172506 + D3DBACKBUFFER_TYPE + D3DBACKBUFFER_TYPE +
+ + +

Specifies a nonstereo swap chain.

+
+ + bb172506 + D3DBACKBUFFER_TYPE_MONO + D3DBACKBUFFER_TYPE_MONO +
+ + +

Specifies the left side of a stereo pair in a swap chain.

+
+ + bb172506 + D3DBACKBUFFER_TYPE_LEFT + D3DBACKBUFFER_TYPE_LEFT +
+ + +

Specifies the right side of a stereo pair in a swap chain.

+
+ + bb172506 + D3DBACKBUFFER_TYPE_RIGHT + D3DBACKBUFFER_TYPE_RIGHT +
+ + +

Defines the basis type of a high-order patch surface.

+
+ +

The members of specify the formulation to be used in evaluating the high-order patch surface primitive during tessellation.

+
+ + bb172507 + D3DBASISTYPE + D3DBASISTYPE +
+ + +

Input vertices are treated as a series of B?zier patches. The number of vertices specified must be divisible by 4. Portions of the mesh beyond this criterion will not be rendered. Full continuity is assumed between sub-patches in the interior of the surface rendered by each call. Only the vertices at the corners of each sub-patch are guaranteed to lie on the resulting surface.

+
+ + bb172507 + D3DBASIS_BEZIER + D3DBASIS_BEZIER +
+ + +

Input vertices are treated as control points of a B-spline surface. The number of apertures rendered is two fewer than the number of apertures in that direction. In general, the generated surface does not contain the control vertices specified.

+
+ + bb172507 + D3DBASIS_BSPLINE + D3DBASIS_BSPLINE +
+ + +

An interpolating basis defines the surface so that the surface goes through all the input vertices specified. In DirectX 8, this was D3DBASIS_INTERPOLATE.

+
+ + bb172507 + D3DBASIS_CATMULL_ROM + D3DBASIS_CATMULL_ROM +
+ + +

Defines the supported blend mode.

+
+ +

In the preceding member descriptions, the RGBA values of the source and destination are indicated by the s and d subscripts.

The values in this enumerated type are used by the following render states:

See

Render Target Blending

Direct3D 9Ex has improved text rendering capabilities. Rendering clear-type fonts would normally require two passes. To eliminate the second pass, a pixel shader can be used to output two colors, which we can call PSOutColor[0] and PSOutColor[1]. The first color would contain the standard 3 color components (RGB). The second color would contain 3 alpha components (one for each component of the first color).

These new blending modes are only used for text rendering on the first render target.

+
+ + bb172508 + D3DBLEND + D3DBLEND +
+ + +

Blend factor is (0, 0, 0, 0).

+
+ + bb172508 + D3DBLEND_ZERO + D3DBLEND_ZERO +
+ + +

Blend factor is (1, 1, 1, 1).

+
+ + bb172508 + D3DBLEND_ONE + D3DBLEND_ONE +
+ + +

Blend factor is (Rs, Gs, Bs, As).

+
+ + bb172508 + D3DBLEND_SRCCOLOR + D3DBLEND_SRCCOLOR +
+ + +

Blend factor is (1 - Rs, 1 - Gs, 1 - Bs, 1 - As).

+
+ + bb172508 + D3DBLEND_INVSRCCOLOR + D3DBLEND_INVSRCCOLOR +
+ + +

Blend factor is (As, As, As, As).

+
+ + bb172508 + D3DBLEND_SRCALPHA + D3DBLEND_SRCALPHA +
+ + +

Blend factor is ( 1 - As, 1 - As, 1 - As, 1 - As).

+
+ + bb172508 + D3DBLEND_INVSRCALPHA + D3DBLEND_INVSRCALPHA +
+ + +

Blend factor is (Ad Ad Ad Ad).

+
+ + bb172508 + D3DBLEND_DESTALPHA + D3DBLEND_DESTALPHA +
+ + +

Blend factor is (1 - Ad 1 - Ad 1 - Ad 1 - Ad).

+
+ + bb172508 + D3DBLEND_INVDESTALPHA + D3DBLEND_INVDESTALPHA +
+ + +

Blend factor is (Rd, Gd, Bd, Ad).

+
+ + bb172508 + D3DBLEND_DESTCOLOR + D3DBLEND_DESTCOLOR +
+ + +

Blend factor is (1 - Rd, 1 - Gd, 1 - Bd, 1 - Ad).

+
+ + bb172508 + D3DBLEND_INVDESTCOLOR + D3DBLEND_INVDESTCOLOR +
+ + +

Blend factor is (f, f, f, 1); where f = min(As, 1 - Ad).

+
+ + bb172508 + D3DBLEND_SRCALPHASAT + D3DBLEND_SRCALPHASAT +
+ + +

Obsolete. Starting with DirectX 6, you can achieve the same effect by setting the source and destination blend factors to and in separate calls.

+
+ + bb172508 + D3DBLEND_BOTHSRCALPHA + D3DBLEND_BOTHSRCALPHA +
+ + +

Source blend factor is (1 - As, 1 - As, 1 - As, 1 - As), and destination blend factor is (As, As, As, As); the destination blend selection is overridden. This blend mode is supported only for the render state.

+
+ + bb172508 + D3DBLEND_BOTHINVSRCALPHA + D3DBLEND_BOTHINVSRCALPHA +
+ + +

Constant color blending factor used by the frame-buffer blender. This blend mode is supported only if is set in the SrcBlendCaps or DestBlendCaps members of .

+
+ + bb172508 + D3DBLEND_BLENDFACTOR + D3DBLEND_BLENDFACTOR +
+ + +

Inverted constant color-blending factor used by the frame-buffer blender. This blend mode is supported only if the bit is set in the SrcBlendCaps or DestBlendCaps members of .

+
+ + bb172508 + D3DBLEND_INVBLENDFACTOR + D3DBLEND_INVBLENDFACTOR +
+ + +

Blend factor is (PSOutColor[1]r, PSOutColor[1]g, PSOutColor[1]b, not used). See Render.

Differences between Direct3D 9 and Direct3D 9Ex:

This flag is available in Direct3D 9Ex only.

?

+
+ + bb172508 + D3DBLEND_SRCCOLOR2 + D3DBLEND_SRCCOLOR2 +
+ + +

Blend factor is (1 - PSOutColor[1]r, 1 - PSOutColor[1]g, 1 - PSOutColor[1]b, not used)). See Render.

Differences between Direct3D 9 and Direct3D 9Ex:

This flag is available in Direct3D 9Ex only.

?

+
+ + bb172508 + D3DBLEND_INVSRCCOLOR2 + D3DBLEND_INVSRCCOLOR2 +
+ + + No documentation. + + + D3DPBLENDCAPS + D3DPBLENDCAPS + + + + No documentation. + + + D3DPBLENDCAPS_ZERO + D3DPBLENDCAPS_ZERO + + + + No documentation. + + + D3DPBLENDCAPS_ONE + D3DPBLENDCAPS_ONE + + + + No documentation. + + + D3DPBLENDCAPS_SRCCOLOR + D3DPBLENDCAPS_SRCCOLOR + + + + No documentation. + + + D3DPBLENDCAPS_INVSRCCOLOR + D3DPBLENDCAPS_INVSRCCOLOR + + + + No documentation. + + + D3DPBLENDCAPS_SRCALPHA + D3DPBLENDCAPS_SRCALPHA + + + + No documentation. + + + D3DPBLENDCAPS_INVSRCALPHA + D3DPBLENDCAPS_INVSRCALPHA + + + + No documentation. + + + D3DPBLENDCAPS_DESTALPHA + D3DPBLENDCAPS_DESTALPHA + + + + No documentation. + + + D3DPBLENDCAPS_INVDESTALPHA + D3DPBLENDCAPS_INVDESTALPHA + + + + No documentation. + + + D3DPBLENDCAPS_DESTCOLOR + D3DPBLENDCAPS_DESTCOLOR + + + + No documentation. + + + D3DPBLENDCAPS_INVDESTCOLOR + D3DPBLENDCAPS_INVDESTCOLOR + + + + No documentation. + + + D3DPBLENDCAPS_SRCALPHASAT + D3DPBLENDCAPS_SRCALPHASAT + + + + No documentation. + + + D3DPBLENDCAPS_BOTHSRCALPHA + D3DPBLENDCAPS_BOTHSRCALPHA + + + + No documentation. + + + D3DPBLENDCAPS_BOTHINVSRCALPHA + D3DPBLENDCAPS_BOTHINVSRCALPHA + + + + No documentation. + + + D3DPBLENDCAPS_BLENDFACTOR + D3DPBLENDCAPS_BLENDFACTOR + + + + No documentation. + + + D3DPBLENDCAPS_SRCCOLOR2 + D3DPBLENDCAPS_SRCCOLOR2 + + + + No documentation. + + + D3DPBLENDCAPS_INVSRCCOLOR2 + D3DPBLENDCAPS_INVSRCCOLOR2 + + + +

Defines the supported blend operations. See Remarks for definitions of terms.

+
+ +

Source, Destination, and Result are defined as:

TermTypeDescription
SourceInputColor of the source pixel before the operation.
DestinationInputColor of the pixel in the destination buffer before the operation.
ResultOutputReturned value that is the blended color resulting from the operation.

?

This enumerated type defines values used by the following render states:

+
+ + bb172509 + D3DBLENDOP + D3DBLENDOP +
+ + +

The result is the destination added to the source. Result = Source + Destination

+
+ + bb172509 + D3DBLENDOP_ADD + D3DBLENDOP_ADD +
+ + +

The result is the destination subtracted from to the source. Result = Source - Destination

+
+ + bb172509 + D3DBLENDOP_SUBTRACT + D3DBLENDOP_SUBTRACT +
+ + +

The result is the source subtracted from the destination. Result = Destination - Source

+
+ + bb172509 + D3DBLENDOP_REVSUBTRACT + D3DBLENDOP_REVSUBTRACT +
+ + +

The result is the minimum of the source and destination. Result = MIN(Source, Destination)

+
+ + bb172509 + D3DBLENDOP_MIN + D3DBLENDOP_MIN +
+ + +

The result is the maximum of the source and destination. Result = MAX(Source, Destination)

+
+ + bb172509 + D3DBLENDOP_MAX + D3DBLENDOP_MAX +
+ + +

Flags used to obtain callback information.

+
+ + bb172714 + D3DXCALLBACK_SEARCH_FLAGS + D3DXCALLBACK_SEARCH_FLAGS +
+ + +

Exclude callbacks located at the initial position from the search.

+
+ + bb172714 + D3DXCALLBACK_SEARCH_EXCLUDING_INITIAL_POSITION + D3DXCALLBACK_SEARCH_EXCLUDING_INITIAL_POSITION +
+ + +

Reverse the callback search direction.

+
+ + bb172714 + D3DXCALLBACK_SEARCH_BEHIND_INITIAL_POSITION + D3DXCALLBACK_SEARCH_BEHIND_INITIAL_POSITION +
+ + + No documentation. + + + D3DCAPS + D3DCAPS + + + + No documentation. + + + D3DCAPS_OVERLAY + D3DCAPS_OVERLAY + + + + No documentation. + + + D3DCAPS_READ_SCANLINE + D3DCAPS_READ_SCANLINE + + + + None. + + + None + None + + + +

Driver capability flags.

+
+ + bb172511 + D3DCAPS2 + D3DCAPS2 +
+ + + No documentation. + + + D3DCAPS2_FULLSCREENGAMMA + D3DCAPS2_FULLSCREENGAMMA + + + + No documentation. + + + D3DCAPS2_CANCALIBRATEGAMMA + D3DCAPS2_CANCALIBRATEGAMMA + + + + No documentation. + + + D3DCAPS2_CANMANAGERESOURCE + D3DCAPS2_CANMANAGERESOURCE + + + + No documentation. + + + D3DCAPS2_DYNAMICTEXTURES + D3DCAPS2_DYNAMICTEXTURES + + + + No documentation. + + + D3DCAPS2_CANAUTOGENMIPMAP + D3DCAPS2_CANAUTOGENMIPMAP + + + + No documentation. + + + D3DCAPS2_CANSHARERESOURCE + D3DCAPS2_CANSHARERESOURCE + + + + None. + + + None + None + + + +

Driver capability flags.

+
+ + bb172512 + D3DCAPS3 + D3DCAPS3 +
+ + + No documentation. + + + D3DCAPS3_ALPHA_FULLSCREEN_FLIP_OR_DISCARD + D3DCAPS3_ALPHA_FULLSCREEN_FLIP_OR_DISCARD + + + + No documentation. + + + D3DCAPS3_LINEAR_TO_SRGB_PRESENTATION + D3DCAPS3_LINEAR_TO_SRGB_PRESENTATION + + + + No documentation. + + + D3DCAPS3_COPY_TO_VIDMEM + D3DCAPS3_COPY_TO_VIDMEM + + + + No documentation. + + + D3DCAPS3_COPY_TO_SYSTEMMEM + D3DCAPS3_COPY_TO_SYSTEMMEM + + + + No documentation. + + + D3DCAPS3_DXVAHD + D3DCAPS3_DXVAHD + + + + None. + + + None + None + + + +

The following flags are used to specify which channels in a texture to operate on.

+
+ + bb205563 + D3DX_CHANNEL + D3DX_CHANNEL +
+ + + No documentation. + + + D3DX_CHANNEL_RED + D3DX_CHANNEL_RED + + + + No documentation. + + + D3DX_CHANNEL_BLUE + D3DX_CHANNEL_BLUE + + + + No documentation. + + + D3DX_CHANNEL_GREEN + D3DX_CHANNEL_GREEN + + + + No documentation. + + + D3DX_CHANNEL_ALPHA + D3DX_CHANNEL_ALPHA + + + + No documentation. + + + D3DX_CHANNEL_LUMINANCE + D3DX_CHANNEL_LUMINANCE + + + +

Defines operations to perform on vertices in preparation for mesh cleaning.

+
+ + bb172720 + D3DXCLEANTYPE + D3DXCLEANTYPE +
+ + +

Merge triangles that share the same vertex indices but have face normals pointing in opposite directions (back-facing triangles). Unless the triangles are not split by adding a replicated vertex, mesh adjacency data from the two triangles may conflict.

+
+ + bb172720 + D3DXCLEAN_BACKFACING + D3DXCLEAN_BACKFACING +
+ + +

If a vertex is the apex of two triangle fans (a bowtie) and mesh operations will affect one of the fans, then split the shared vertex into two new vertices. Bowties can cause problems for operations such as mesh simplification that remove vertices, because removing one vertex affects two distinct sets of triangles.

+
+ + bb172720 + D3DXCLEAN_BOWTIES + D3DXCLEAN_BOWTIES +
+ + +

Use this flag to prevent infinite loops during skinning setup mesh operations.

+
+ + bb172720 + D3DXCLEAN_SKINNING + D3DXCLEAN_SKINNING +
+ + +

Use this flag to prevent infinite loops during mesh optimization operations.

+
+ + bb172720 + D3DXCLEAN_OPTIMIZATION + D3DXCLEAN_OPTIMIZATION +
+ + +

Use this flag to prevent infinite loops during mesh simplification operations.

+
+ + bb172720 + D3DXCLEAN_SIMPLIFICATION + D3DXCLEAN_SIMPLIFICATION +
+ + +

These flags identify a surface to reset when calling Clear.

+
+ + bb172514 + D3DCLEAR + D3DCLEAR +
+ + + No documentation. + + + D3DCLEAR_TARGET + D3DCLEAR_TARGET + + + + No documentation. + + + D3DCLEAR_ZBUFFER + D3DCLEAR_ZBUFFER + + + + No documentation. + + + D3DCLEAR_STENCIL + D3DCLEAR_STENCIL + + + + No documentation. + + + D3DCLEAR_ALL + D3DCLEAR_ALL + + + + None. + + + None + None + + + + No documentation. + + + D3DCS + D3DCS + + + + No documentation. + + + D3DCS_LEFT + D3DCS_LEFT + + + + No documentation. + + + D3DCS_RIGHT + D3DCS_RIGHT + + + + No documentation. + + + D3DCS_TOP + D3DCS_TOP + + + + No documentation. + + + D3DCS_BOTTOM + D3DCS_BOTTOM + + + + No documentation. + + + D3DCS_FRONT + D3DCS_FRONT + + + + No documentation. + + + D3DCS_BACK + D3DCS_BACK + + + + No documentation. + + + D3DCS_PLANE0 + D3DCS_PLANE0 + + + + No documentation. + + + D3DCS_PLANE1 + D3DCS_PLANE1 + + + + No documentation. + + + D3DCS_PLANE2 + D3DCS_PLANE2 + + + + No documentation. + + + D3DCS_PLANE3 + D3DCS_PLANE3 + + + + No documentation. + + + D3DCS_PLANE4 + D3DCS_PLANE4 + + + + No documentation. + + + D3DCS_PLANE5 + D3DCS_PLANE5 + + + + No documentation. + + + D3DCS_ALL + D3DCS_ALL + + + + No documentation. + + + D3DMATERIALCOLORSOURCE + D3DMATERIALCOLORSOURCE + + + + No documentation. + + + D3DMCS_MATERIAL + D3DMCS_MATERIAL + + + + No documentation. + + + D3DMCS_COLOR1 + D3DMCS_COLOR1 + + + + No documentation. + + + D3DMCS_COLOR2 + D3DMCS_COLOR2 + + + + No documentation. + + + D3DCOLORWRITEENABLE + D3DCOLORWRITEENABLE + + + + No documentation. + + + D3DCOLORWRITEENABLE_RED + D3DCOLORWRITEENABLE_RED + + + + No documentation. + + + D3DCOLORWRITEENABLE_GREEN + D3DCOLORWRITEENABLE_GREEN + + + + No documentation. + + + D3DCOLORWRITEENABLE_BLUE + D3DCOLORWRITEENABLE_BLUE + + + + No documentation. + + + D3DCOLORWRITEENABLE_ALPHA + D3DCOLORWRITEENABLE_ALPHA + + + +

Defines the supported compare functions.

+
+ +

The values in this enumerated type define the supported compare functions for the , , and render states.

+
+ + bb172517 + D3DCMPFUNC + D3DCMPFUNC +
+ + +

Always fail the test.

+
+ + bb172517 + D3DCMP_NEVER + D3DCMP_NEVER +
+ + +

Accept the new pixel if its value is less than the value of the current pixel.

+
+ + bb172517 + D3DCMP_LESS + D3DCMP_LESS +
+ + +

Accept the new pixel if its value equals the value of the current pixel.

+
+ + bb172517 + D3DCMP_EQUAL + D3DCMP_EQUAL +
+ + +

Accept the new pixel if its value is less than or equal to the value of the current pixel.

+
+ + bb172517 + D3DCMP_LESSEQUAL + D3DCMP_LESSEQUAL +
+ + +

Accept the new pixel if its value is greater than the value of the current pixel.

+
+ + bb172517 + D3DCMP_GREATER + D3DCMP_GREATER +
+ + +

Accept the new pixel if its value does not equal the value of the current pixel.

+
+ + bb172517 + D3DCMP_NOTEQUAL + D3DCMP_NOTEQUAL +
+ + +

Accept the new pixel if its value is greater than or equal to the value of the current pixel.

+
+ + bb172517 + D3DCMP_GREATEREQUAL + D3DCMP_GREATEREQUAL +
+ + +

Always pass the test.

+
+ + bb172517 + D3DCMP_ALWAYS + D3DCMP_ALWAYS +
+ + + No documentation. + + + D3DPCMPCAPS + D3DPCMPCAPS + + + + No documentation. + + + D3DPCMPCAPS_NEVER + D3DPCMPCAPS_NEVER + + + + No documentation. + + + D3DPCMPCAPS_LESS + D3DPCMPCAPS_LESS + + + + No documentation. + + + D3DPCMPCAPS_EQUAL + D3DPCMPCAPS_EQUAL + + + + No documentation. + + + D3DPCMPCAPS_LESSEQUAL + D3DPCMPCAPS_LESSEQUAL + + + + No documentation. + + + D3DPCMPCAPS_GREATER + D3DPCMPCAPS_GREATER + + + + No documentation. + + + D3DPCMPCAPS_NOTEQUAL + D3DPCMPCAPS_NOTEQUAL + + + + No documentation. + + + D3DPCMPCAPS_GREATEREQUAL + D3DPCMPCAPS_GREATEREQUAL + + + + No documentation. + + + D3DPCMPCAPS_ALWAYS + D3DPCMPCAPS_ALWAYS + + + +

Specifies how to combine the glyph data from the source and destination surfaces in a call to ComposeRects.

+
+ + bb509546 + D3DCOMPOSERECTSOP + D3DCOMPOSERECTSOP +
+ + + No documentation. + + + D3DCOMPOSERECTS_COPY + D3DCOMPOSERECTS_COPY + + + + No documentation. + + + D3DCOMPOSERECTS_OR + D3DCOMPOSERECTS_OR + + + + No documentation. + + + D3DCOMPOSERECTS_AND + D3DCOMPOSERECTS_AND + + + + No documentation. + + + D3DCOMPOSERECTS_NEG + D3DCOMPOSERECTS_NEG + + + +

Defines the compression mode used for storing compressed animation set data.

+
+ + bb172734 + D3DXCOMPRESSION_FLAGS + D3DXCOMPRESSION_FLAGS +
+ + +

Implements fast compression.

+
+ + bb172734 + D3DXCOMPRESS_DEFAULT + D3DXCOMPRESS_DEFAULT +
+ + +

A combination of one or more flags that control the device create behavior.

+
+ + bb172527 + D3DCREATE + D3DCREATE +
+ + + No documentation. + + + D3DCREATE_FPU_PRESERVE + D3DCREATE_FPU_PRESERVE + + + + No documentation. + + + D3DCREATE_MULTITHREADED + D3DCREATE_MULTITHREADED + + + + No documentation. + + + D3DCREATE_PUREDEVICE + D3DCREATE_PUREDEVICE + + + + No documentation. + + + D3DCREATE_SOFTWARE_VERTEXPROCESSING + D3DCREATE_SOFTWARE_VERTEXPROCESSING + + + + No documentation. + + + D3DCREATE_HARDWARE_VERTEXPROCESSING + D3DCREATE_HARDWARE_VERTEXPROCESSING + + + + No documentation. + + + D3DCREATE_MIXED_VERTEXPROCESSING + D3DCREATE_MIXED_VERTEXPROCESSING + + + + No documentation. + + + D3DCREATE_DISABLE_DRIVER_MANAGEMENT + D3DCREATE_DISABLE_DRIVER_MANAGEMENT + + + + No documentation. + + + D3DCREATE_ADAPTERGROUP_DEVICE + D3DCREATE_ADAPTERGROUP_DEVICE + + + + No documentation. + + + D3DCREATE_DISABLE_DRIVER_MANAGEMENT_EX + D3DCREATE_DISABLE_DRIVER_MANAGEMENT_EX + + + + No documentation. + + + D3DCREATE_NOWINDOWCHANGES + D3DCREATE_NOWINDOWCHANGES + + + + No documentation. + + + D3DCREATE_DISABLE_PSGP_THREADING + D3DCREATE_DISABLE_PSGP_THREADING + + + + No documentation. + + + D3DCREATE_ENABLE_PRESENTSTATS + D3DCREATE_ENABLE_PRESENTSTATS + + + + No documentation. + + + D3DCREATE_DISABLE_PRINTSCREEN + D3DCREATE_DISABLE_PRINTSCREEN + + + + No documentation. + + + D3DCREATE_SCREENSAVER + D3DCREATE_SCREENSAVER + + + + None. + + + None + None + + + +

Defines the faces of a cubemap.

+
+ + bb172528 + D3DCUBEMAP_FACES + D3DCUBEMAP_FACES +
+ + +

Positive x-face of the cubemap.

+
+ + bb172528 + D3DCUBEMAP_FACE_POSITIVE_X + D3DCUBEMAP_FACE_POSITIVE_X +
+ + +

Negative x-face of the cubemap.

+
+ + bb172528 + D3DCUBEMAP_FACE_NEGATIVE_X + D3DCUBEMAP_FACE_NEGATIVE_X +
+ + +

Positive y-face of the cubemap.

+
+ + bb172528 + D3DCUBEMAP_FACE_POSITIVE_Y + D3DCUBEMAP_FACE_POSITIVE_Y +
+ + +

Negative y-face of the cubemap.

+
+ + bb172528 + D3DCUBEMAP_FACE_NEGATIVE_Y + D3DCUBEMAP_FACE_NEGATIVE_Y +
+ + +

Positive z-face of the cubemap.

+
+ + bb172528 + D3DCUBEMAP_FACE_POSITIVE_Z + D3DCUBEMAP_FACE_POSITIVE_Z +
+ + +

Negative z-face of the cubemap.

+
+ + bb172528 + D3DCUBEMAP_FACE_NEGATIVE_Z + D3DCUBEMAP_FACE_NEGATIVE_Z +
+ + + No documentation. + + + D3DCULL + D3DCULL + + + + No documentation. + + + D3DCULL_NONE + D3DCULL_NONE + + + + No documentation. + + + D3DCULL_CW + D3DCULL_CW + + + + No documentation. + + + D3DCULL_CCW + D3DCULL_CCW + + + +

Driver cursor capability flags.

+
+ + bb172530 + D3DCURSORCAPS + D3DCURSORCAPS +
+ + + No documentation. + + + D3DCURSORCAPS_COLOR + D3DCURSORCAPS_COLOR + + + + No documentation. + + + D3DCURSORCAPS_LOWRES + D3DCURSORCAPS_LOWRES + + + + No documentation. + + + D3DDEBUGMONITORTOKENS + D3DDEBUGMONITORTOKENS + + + + No documentation. + + + D3DDMT_ENABLE + D3DDMT_ENABLE + + + + No documentation. + + + D3DDMT_DISABLE + D3DDMT_DISABLE + + + +

Defines the vertex declaration method which is a predefined operation performed by the tessellator (or any procedural geometry routine on the vertex data during tessellation).

+
+ +

The tessellator looks at the method to determine what data to calculate from the vertex data during tessellation. Mesh data should use the default value. Patches can use any of the other implemented types.

Vertex data is declared with an array of structures. Each element in the array contains a vertex declaration method.

In addition to using , a normal mesh can use and methods when N-patches are enabled.

+
+ + bb172532 + D3DDECLMETHOD + D3DDECLMETHOD +
+ + +

Default value. The tessellator copies the vertex data (spline data for patches) as is, with no additional calculations. When the tessellator is used, this element is interpolated. Otherwise vertex data is copied into the input register. The input and output type can be any value, but are always the same type.

+
+ + bb172532 + D3DDECLMETHOD_DEFAULT + D3DDECLMETHOD_DEFAULT +
+ + +

Computes the tangent at a point on the rectangle or triangle patch in the U direction. The input type can be one of the following: +

The output type is always .

+
+ + bb172532 + D3DDECLMETHOD_PARTIALU + D3DDECLMETHOD_PARTIALU +
+ + +

Computes the tangent at a point on the rectangle or triangle patch in the V direction. The input type can be one of the following: +

The output type is always .

+
+ + bb172532 + D3DDECLMETHOD_PARTIALV + D3DDECLMETHOD_PARTIALV +
+ + +

Computes the normal at a point on the rectangle or triangle patch by taking the cross product of two tangents. The input type can be one of the following: +

The output type is always .

+
+ + bb172532 + D3DDECLMETHOD_CROSSUV + D3DDECLMETHOD_CROSSUV +
+ + +

Copy out the U, V values at a point on the rectangle or triangle patch. This results in a 2D float. The input type must be set to . The output data type is always . The input stream and offset are also unused (but must be set to 0).

+
+ + bb172532 + D3DDECLMETHOD_UV + D3DDECLMETHOD_UV +
+ + +

Look up a displacement map. The input type can be one of the following: +

Only the .x and .y components are used for the texture map lookup. The output type is always . The device must support displacement mapping. For more information about displacement mapping, see Displacement Mapping (Direct3D 9). This constant is supported only by the programmable pipeline on N-patch data, if N-patches are enabled.

+
+ + bb172532 + D3DDECLMETHOD_LOOKUP + D3DDECLMETHOD_LOOKUP +
+ + +

Look up a presampled displacement map. The input type must be set to ; the stream index and the stream offset must be set to 0. The output type for this operation is always . The device must support displacement mapping. For more information about displacement mapping, see Displacement Mapping (Direct3D 9). This constant is supported only by the programmable pipeline on N-patch data, if N-patches are enabled. This method can be used only with .

+
+ + bb172532 + D3DDECLMETHOD_LOOKUPPRESAMPLED + D3DDECLMETHOD_LOOKUPPRESAMPLED +
+ + +

Defines a vertex declaration data type.

+
+ +

Vertex data is declared with an array of structures. Each element in the array contains a vertex declaration data type.

Use the DirectX Caps Viewer Tool tool to see which types are supported on your device.

+
+ + bb172533 + D3DDECLTYPE + D3DDECLTYPE +
+ + +

One-component float expanded to (float, 0, 0, 1).

+
+ + bb172533 + D3DDECLTYPE_FLOAT1 + D3DDECLTYPE_FLOAT1 +
+ + +

Two-component float expanded to (float, float, 0, 1).

+
+ + bb172533 + D3DDECLTYPE_FLOAT2 + D3DDECLTYPE_FLOAT2 +
+ + +

Three-component float expanded to (float, float, float, 1).

+
+ + bb172533 + D3DDECLTYPE_FLOAT3 + D3DDECLTYPE_FLOAT3 +
+ + +

Four-component float expanded to (float, float, float, float).

+
+ + bb172533 + D3DDECLTYPE_FLOAT4 + D3DDECLTYPE_FLOAT4 +
+ + +

Four-component, packed, unsigned bytes mapped to 0 to 1 range. Input is a and is expanded to RGBA order.

+
+ + bb172533 + D3DDECLTYPE_D3DCOLOR + D3DDECLTYPE_D3DCOLOR +
+ + +

Four-component, unsigned byte.

+
+ + bb172533 + D3DDECLTYPE_UBYTE4 + D3DDECLTYPE_UBYTE4 +
+ + +

Two-component, signed short expanded to (value, value, 0, 1).

+
+ + bb172533 + D3DDECLTYPE_SHORT2 + D3DDECLTYPE_SHORT2 +
+ + +

Four-component, signed short expanded to (value, value, value, value).

+
+ + bb172533 + D3DDECLTYPE_SHORT4 + D3DDECLTYPE_SHORT4 +
+ + +

Four-component byte with each byte normalized by dividing with 255.0f.

+
+ + bb172533 + D3DDECLTYPE_UBYTE4N + D3DDECLTYPE_UBYTE4N +
+ + +

Normalized, two-component, signed short, expanded to (first short/32767.0, second short/32767.0, 0, 1).

+
+ + bb172533 + D3DDECLTYPE_SHORT2N + D3DDECLTYPE_SHORT2N +
+ + +

Normalized, four-component, signed short, expanded to (first short/32767.0, second short/32767.0, third short/32767.0, fourth short/32767.0).

+
+ + bb172533 + D3DDECLTYPE_SHORT4N + D3DDECLTYPE_SHORT4N +
+ + +

Normalized, two-component, unsigned short, expanded to (first short/65535.0, short short/65535.0, 0, 1).

+
+ + bb172533 + D3DDECLTYPE_USHORT2N + D3DDECLTYPE_USHORT2N +
+ + +

Normalized, four-component, unsigned short, expanded to (first short/65535.0, second short/65535.0, third short/65535.0, fourth short/65535.0).

+
+ + bb172533 + D3DDECLTYPE_USHORT4N + D3DDECLTYPE_USHORT4N +
+ + +

Three-component, unsigned, 10 10 10 format expanded to (value, value, value, 1).

+
+ + bb172533 + D3DDECLTYPE_UDEC3 + D3DDECLTYPE_UDEC3 +
+ + +

Three-component, signed, 10 10 10 format normalized and expanded to (v[0]/511.0, v[1]/511.0, v[2]/511.0, 1).

+
+ + bb172533 + D3DDECLTYPE_DEC3N + D3DDECLTYPE_DEC3N +
+ + +

Two-component, 16-bit, floating point expanded to (value, value, 0, 1).

+
+ + bb172533 + D3DDECLTYPE_FLOAT16_2 + D3DDECLTYPE_FLOAT16_2 +
+ + +

Four-component, 16-bit, floating point expanded to (value, value, value, value).

+
+ + bb172533 + D3DDECLTYPE_FLOAT16_4 + D3DDECLTYPE_FLOAT16_4 +
+ + +

Type field in the declaration is unused. This is designed for use with and .

+
+ + bb172533 + D3DDECLTYPE_UNUSED + D3DDECLTYPE_UNUSED +
+ + +

Constants describing the vertex data types supported by a device.

+
+ + bb172552 + D3DDTCAPS + D3DDTCAPS +
+ + + No documentation. + + + D3DDTCAPS_UBYTE4 + D3DDTCAPS_UBYTE4 + + + + No documentation. + + + D3DDTCAPS_UBYTE4N + D3DDTCAPS_UBYTE4N + + + + No documentation. + + + D3DDTCAPS_SHORT2N + D3DDTCAPS_SHORT2N + + + + No documentation. + + + D3DDTCAPS_SHORT4N + D3DDTCAPS_SHORT4N + + + + No documentation. + + + D3DDTCAPS_USHORT2N + D3DDTCAPS_USHORT2N + + + + No documentation. + + + D3DDTCAPS_USHORT4N + D3DDTCAPS_USHORT4N + + + + No documentation. + + + D3DDTCAPS_UDEC3 + D3DDTCAPS_UDEC3 + + + + No documentation. + + + D3DDTCAPS_DEC3N + D3DDTCAPS_DEC3N + + + + No documentation. + + + D3DDTCAPS_FLOAT16_2 + D3DDTCAPS_FLOAT16_2 + + + + No documentation. + + + D3DDTCAPS_FLOAT16_4 + D3DDTCAPS_FLOAT16_4 + + + +

Identifies the intended use of vertex data.

+
+ +

Vertex data is declared with an array of structures. Each element in the array contains a usage type.

For more information about vertex declarations, see Vertex Declaration (Direct3D 9).

+
+ + bb172534 + D3DDECLUSAGE + D3DDECLUSAGE +
+ + +

Position data ranging from (-1,-1) to (1,1). Use with a usage index of 0 to specify untransformed position for fixed function vertex processing and the n-patch tessellator. Use with a usage index of 1 to specify untransformed position in the fixed function vertex shader for vertex tweening.

+
+ + bb172534 + D3DDECLUSAGE_POSITION + D3DDECLUSAGE_POSITION +
+ + +

Blending weight data. Use with a usage index of 0 to specify the blend weights used in indexed and nonindexed vertex blending.

+
+ + bb172534 + D3DDECLUSAGE_BLENDWEIGHT + D3DDECLUSAGE_BLENDWEIGHT +
+ + +

Blending indices data. Use with a usage index of 0 to specify matrix indices for indexed paletted skinning.

+
+ + bb172534 + D3DDECLUSAGE_BLENDINDICES + D3DDECLUSAGE_BLENDINDICES +
+ + +

Vertex normal data. Use with a usage index of 0 to specify vertex normals for fixed function vertex processing and the n-patch tessellator. Use with a usage index of 1 to specify vertex normals for fixed function vertex processing for vertex tweening.

+
+ + bb172534 + D3DDECLUSAGE_NORMAL + D3DDECLUSAGE_NORMAL +
+ + +

Point size data. Use with a usage index of 0 to specify the point-size attribute used by the setup engine of the rasterizer to expand a point into a quad for the point-sprite functionality.

+
+ + bb172534 + D3DDECLUSAGE_PSIZE + D3DDECLUSAGE_PSIZE +
+ + +

Texture coordinate data. Use , n to specify texture coordinates in fixed function vertex processing and in pixel shaders prior to ps_3_0. These can be used to pass user defined data.

+
+ + bb172534 + D3DDECLUSAGE_TEXCOORD + D3DDECLUSAGE_TEXCOORD +
+ + +

Vertex tangent data.

+
+ + bb172534 + D3DDECLUSAGE_TANGENT + D3DDECLUSAGE_TANGENT +
+ + +

Vertex binormal data.

+
+ + bb172534 + D3DDECLUSAGE_BINORMAL + D3DDECLUSAGE_BINORMAL +
+ + +

Single positive floating point value. Use with a usage index of 0 to specify a tessellation factor used in the tessellation unit to control the rate of tessellation. For more information about the data type, see .

+
+ + bb172534 + D3DDECLUSAGE_TESSFACTOR + D3DDECLUSAGE_TESSFACTOR +
+ + +

Vertex data contains transformed position data ranging from (0,0) to (viewport width, viewport height). Use with a usage index of 0 to specify transformed position. When a declaration containing this is set, the pipeline does not perform vertex processing.

+
+ + bb172534 + D3DDECLUSAGE_POSITIONT + D3DDECLUSAGE_POSITIONT +
+ + +

Vertex data contains diffuse or specular color. Use with a usage index of 0 to specify the diffuse color in the fixed function vertex shader and pixel shaders prior to ps_3_0. Use with a usage index of 1 to specify the specular color in the fixed function vertex shader and pixel shaders prior to ps_3_0.

+
+ + bb172534 + D3DDECLUSAGE_COLOR + D3DDECLUSAGE_COLOR +
+ + +

Vertex data contains fog data. Use with a usage index of 0 to specify a fog blend value used after pixel shading finishes. This applies to pixel shaders prior to version ps_3_0.

+
+ + bb172534 + D3DDECLUSAGE_FOG + D3DDECLUSAGE_FOG +
+ + +

Vertex data contains depth data.

+
+ + bb172534 + D3DDECLUSAGE_DEPTH + D3DDECLUSAGE_DEPTH +
+ + +

Vertex data contains sampler data. Use with a usage index of 0 to specify the displacement value to look up. It can be used only with D3DDECLUSAGE_LOOKUPPRESAMPLED or D3DDECLUSAGE_LOOKUP.

+
+ + bb172534 + D3DDECLUSAGE_SAMPLE + D3DDECLUSAGE_SAMPLE +
+ + +

Defines the degree of the variables in the equation that describes a curve.

+
+ +

The values in this enumeration are used to describe the curves used by rectangle and triangle patches. For more information, see .

+
+ + bb172536 + D3DDEGREETYPE + D3DDEGREETYPE +
+ + +

Curve is described by variables of first order.

+
+ + bb172536 + D3DDEGREE_LINEAR + D3DDEGREE_LINEAR +
+ + +

Curve is described by variables of second order.

+
+ + bb172536 + D3DDEGREE_QUADRATIC + D3DDEGREE_QUADRATIC +
+ + +

Curve is described by variables of third order.

+
+ + bb172536 + D3DDEGREE_CUBIC + D3DDEGREE_CUBIC +
+ + +

Curve is described by variables of fourth order.

+
+ + bb172536 + D3DDEGREE_QUINTIC + D3DDEGREE_QUINTIC +
+ + + No documentation. + + + D3DDEVCAPS + D3DDEVCAPS + + + + No documentation. + + + D3DDEVCAPS_EXECUTESYSTEMMEMORY + D3DDEVCAPS_EXECUTESYSTEMMEMORY + + + + No documentation. + + + D3DDEVCAPS_EXECUTEVIDEOMEMORY + D3DDEVCAPS_EXECUTEVIDEOMEMORY + + + + No documentation. + + + D3DDEVCAPS_TLVERTEXSYSTEMMEMORY + D3DDEVCAPS_TLVERTEXSYSTEMMEMORY + + + + No documentation. + + + D3DDEVCAPS_TLVERTEXVIDEOMEMORY + D3DDEVCAPS_TLVERTEXVIDEOMEMORY + + + + No documentation. + + + D3DDEVCAPS_TEXTURESYSTEMMEMORY + D3DDEVCAPS_TEXTURESYSTEMMEMORY + + + + No documentation. + + + D3DDEVCAPS_TEXTUREVIDEOMEMORY + D3DDEVCAPS_TEXTUREVIDEOMEMORY + + + + No documentation. + + + D3DDEVCAPS_DRAWPRIMTLVERTEX + D3DDEVCAPS_DRAWPRIMTLVERTEX + + + + No documentation. + + + D3DDEVCAPS_CANRENDERAFTERFLIP + D3DDEVCAPS_CANRENDERAFTERFLIP + + + + No documentation. + + + D3DDEVCAPS_TEXTURENONLOCALVIDMEM + D3DDEVCAPS_TEXTURENONLOCALVIDMEM + + + + No documentation. + + + D3DDEVCAPS_DRAWPRIMITIVES2 + D3DDEVCAPS_DRAWPRIMITIVES2 + + + + No documentation. + + + D3DDEVCAPS_SEPARATETEXTUREMEMORIES + D3DDEVCAPS_SEPARATETEXTUREMEMORIES + + + + No documentation. + + + D3DDEVCAPS_DRAWPRIMITIVES2EX + D3DDEVCAPS_DRAWPRIMITIVES2EX + + + + No documentation. + + + D3DDEVCAPS_HWTRANSFORMANDLIGHT + D3DDEVCAPS_HWTRANSFORMANDLIGHT + + + + No documentation. + + + D3DDEVCAPS_CANBLTSYSTONONLOCAL + D3DDEVCAPS_CANBLTSYSTONONLOCAL + + + + No documentation. + + + D3DDEVCAPS_HWRASTERIZATION + D3DDEVCAPS_HWRASTERIZATION + + + + No documentation. + + + D3DDEVCAPS_PUREDEVICE + D3DDEVCAPS_PUREDEVICE + + + + No documentation. + + + D3DDEVCAPS_QUINTICRTPATCHES + D3DDEVCAPS_QUINTICRTPATCHES + + + + No documentation. + + + D3DDEVCAPS_RTPATCHES + D3DDEVCAPS_RTPATCHES + + + + No documentation. + + + D3DDEVCAPS_RTPATCHHANDLEZERO + D3DDEVCAPS_RTPATCHHANDLEZERO + + + + No documentation. + + + D3DDEVCAPS_NPATCHES + D3DDEVCAPS_NPATCHES + + + +

driver capability flags.

+
+ + bb172537 + D3DDEVCAPS2 + D3DDEVCAPS2 +
+ + + No documentation. + + + D3DDEVCAPS2_STREAMOFFSET + D3DDEVCAPS2_STREAMOFFSET + + + + No documentation. + + + D3DDEVCAPS2_DMAPNPATCH + D3DDEVCAPS2_DMAPNPATCH + + + + No documentation. + + + D3DDEVCAPS2_ADAPTIVETESSRTPATCH + D3DDEVCAPS2_ADAPTIVETESSRTPATCH + + + + No documentation. + + + D3DDEVCAPS2_ADAPTIVETESSNPATCH + D3DDEVCAPS2_ADAPTIVETESSNPATCH + + + + No documentation. + + + D3DDEVCAPS2_CAN_STRETCHRECT_FROM_TEXTURES + D3DDEVCAPS2_CAN_STRETCHRECT_FROM_TEXTURES + + + + No documentation. + + + D3DDEVCAPS2_PRESAMPLEDDMAPNPATCH + D3DDEVCAPS2_PRESAMPLEDDMAPNPATCH + + + + No documentation. + + + D3DDEVCAPS2_VERTEXELEMENTSCANSHARESTREAMOFFSET + D3DDEVCAPS2_VERTEXELEMENTSCANSHARESTREAMOFFSET + + + +

Defines device types.

+
+ +

All methods of the interface that take a device type will fail if is specified. To use these methods, substitute in the method call.

A device should be created in memory, unless vertex and index buffers are required. To support vertex and index buffers, create the device in memory.

If D3dref9.dll is installed, Direct3D will use the reference rasterizer to create a device type, even if is specified. If D3dref9.dll is not available and is specified, Direct3D will neither render nor present the scene.

+
+ + bb172547 + D3DDEVTYPE + D3DDEVTYPE +
+ + +

Hardware rasterization. Shading is done with software, hardware, or mixed transform and lighting.

+
+ + bb172547 + D3DDEVTYPE_HAL + D3DDEVTYPE_HAL +
+ + +

Initialize Direct3D on a computer that has neither hardware nor reference rasterization available, and enable resources for 3D content creation. See Remarks.

+
+ + bb172547 + D3DDEVTYPE_REF + D3DDEVTYPE_REF +
+ + +

Direct3D features are implemented in software; however, the reference rasterizer does make use of special CPU instructions whenever it can.

+
+ + bb172547 + D3DDEVTYPE_SW + D3DDEVTYPE_SW +
+ + +

A pluggable software device that has been registered with .

+
+ + bb172547 + D3DDEVTYPE_NULLREF + D3DDEVTYPE_NULLREF +
+ + +

Specifies how the monitor being used to display a full-screen application is rotated.

+
+ +

This enumeration is used in , , and .

Applications may choose to handle monitor rotation themselves by using the , in which case, the application will need to know how the monitor is rotated so that it may adjust its rendering accordingly.

+
+ + bb172551 + D3DDISPLAYROTATION + D3DDISPLAYROTATION +
+ + +

Display is not rotated.

+
+ + bb172551 + D3DDISPLAYROTATION_IDENTITY + D3DDISPLAYROTATION_IDENTITY +
+ + +

Display is rotated 90 degrees.

+
+ + bb172551 + D3DDISPLAYROTATION_90 + D3DDISPLAYROTATION_90 +
+ + +

Display is rotated 180 degrees.

+
+ + bb172551 + D3DDISPLAYROTATION_180 + D3DDISPLAYROTATION_180 +
+ + +

Display is rotated 270 degrees.

+
+ + bb172551 + D3DDISPLAYROTATION_270 + D3DDISPLAYROTATION_270 +
+ + +

Effect data types. The data is contained in the pValue member of .

+
+ + bb172822 + D3DXEFFECTDEFAULTTYPE + D3DXEFFECTDEFAULTTYPE +
+ + + No documentation. + + + D3DXEDT_STRING + D3DXEDT_STRING + + + + No documentation. + + + D3DXEDT_FLOATS + D3DXEDT_FLOATS + + + + No documentation. + + + D3DXEDT_DWORD + D3DXEDT_DWORD + + + + No documentation. + + + D3DXEDT_FORCEDWORD + D3DXEDT_FORCEDWORD + + + +

Describes the type of events that can be keyed by the animation controller.

+
+ + bb172827 + D3DXEVENT_TYPE + D3DXEVENT_TYPE +
+ + +

Track speed.

+
+ + bb172827 + D3DXEVENT_TRACKSPEED + D3DXEVENT_TRACKSPEED +
+ + +

Track weight.

+
+ + bb172827 + D3DXEVENT_TRACKWEIGHT + D3DXEVENT_TRACKWEIGHT +
+ + +

Track position.

+
+ + bb172827 + D3DXEVENT_TRACKPOSITION + D3DXEVENT_TRACKPOSITION +
+ + +

Enable flag.

+
+ + bb172827 + D3DXEVENT_TRACKENABLE + D3DXEVENT_TRACKENABLE +
+ + +

Priority blend value.

+
+ + bb172827 + D3DXEVENT_PRIORITYBLEND + D3DXEVENT_PRIORITYBLEND +
+ + + No documentation. + + + D3DFILLMODE + D3DFILLMODE + + + + No documentation. + + + D3DFILL_POINT + D3DFILL_POINT + + + + No documentation. + + + D3DFILL_WIREFRAME + D3DFILL_WIREFRAME + + + + No documentation. + + + D3DFILL_SOLID + D3DFILL_SOLID + + + +

The following flags are used to specify which channels in a texture to operate on.

+
+ + bb205565 + D3DX_FILTER + D3DX_FILTER +
+ + + No documentation. + + + D3DX_FILTER_NONE + D3DX_FILTER_NONE + + + + No documentation. + + + D3DX_FILTER_POINT + D3DX_FILTER_POINT + + + + No documentation. + + + D3DX_FILTER_LINEAR + D3DX_FILTER_LINEAR + + + + No documentation. + + + D3DX_FILTER_TRIANGLE + D3DX_FILTER_TRIANGLE + + + + No documentation. + + + D3DX_FILTER_BOX + D3DX_FILTER_BOX + + + + No documentation. + + + D3DX_FILTER_MIRROR_U + D3DX_FILTER_MIRROR_U + + + + No documentation. + + + D3DX_FILTER_MIRROR_V + D3DX_FILTER_MIRROR_V + + + + No documentation. + + + D3DX_FILTER_MIRROR_W + D3DX_FILTER_MIRROR_W + + + + No documentation. + + + D3DX_FILTER_MIRROR + D3DX_FILTER_MIRROR + + + + No documentation. + + + D3DX_FILTER_DITHER + D3DX_FILTER_DITHER + + + + No documentation. + + + D3DX_FILTER_DITHER_DIFFUSION + D3DX_FILTER_DITHER_DIFFUSION + + + + No documentation. + + + D3DX_FILTER_SRGB_IN + D3DX_FILTER_SRGB_IN + + + + No documentation. + + + D3DX_FILTER_SRGB_OUT + D3DX_FILTER_SRGB_OUT + + + + No documentation. + + + D3DX_FILTER_SRGB + D3DX_FILTER_SRGB + + + + No documentation. + + + D3DX_FILTER_DEFAULT + D3DX_FILTER_DEFAULT + + + +

Texture filtering constants.

+
+ + Bb172593 + D3DPTFILTERCAPS + D3DPTFILTERCAPS +
+ + + No documentation. + + + D3DPTFILTERCAPS_MINFPOINT + D3DPTFILTERCAPS_MINFPOINT + + + + No documentation. + + + D3DPTFILTERCAPS_MINFLINEAR + D3DPTFILTERCAPS_MINFLINEAR + + + + No documentation. + + + D3DPTFILTERCAPS_MINFANISOTROPIC + D3DPTFILTERCAPS_MINFANISOTROPIC + + + + No documentation. + + + D3DPTFILTERCAPS_MINFPYRAMIDALQUAD + D3DPTFILTERCAPS_MINFPYRAMIDALQUAD + + + + No documentation. + + + D3DPTFILTERCAPS_MINFGAUSSIANQUAD + D3DPTFILTERCAPS_MINFGAUSSIANQUAD + + + + No documentation. + + + D3DPTFILTERCAPS_MIPFPOINT + D3DPTFILTERCAPS_MIPFPOINT + + + + No documentation. + + + D3DPTFILTERCAPS_MIPFLINEAR + D3DPTFILTERCAPS_MIPFLINEAR + + + + No documentation. + + + D3DPTFILTERCAPS_CONVOLUTIONMONO + D3DPTFILTERCAPS_CONVOLUTIONMONO + + + + No documentation. + + + D3DPTFILTERCAPS_MAGFPOINT + D3DPTFILTERCAPS_MAGFPOINT + + + + No documentation. + + + D3DPTFILTERCAPS_MAGFLINEAR + D3DPTFILTERCAPS_MAGFLINEAR + + + + No documentation. + + + D3DPTFILTERCAPS_MAGFANISOTROPIC + D3DPTFILTERCAPS_MAGFANISOTROPIC + + + + No documentation. + + + D3DPTFILTERCAPS_MAGFPYRAMIDALQUAD + D3DPTFILTERCAPS_MAGFPYRAMIDALQUAD + + + + No documentation. + + + D3DPTFILTERCAPS_MAGFGAUSSIANQUAD + D3DPTFILTERCAPS_MAGFGAUSSIANQUAD + + + + No documentation. + + + D3DFOGMODE + D3DFOGMODE + + + + No documentation. + + + D3DFOG_NONE + D3DFOG_NONE + + + + No documentation. + + + D3DFOG_EXP + D3DFOG_EXP + + + + No documentation. + + + D3DFOG_EXP2 + D3DFOG_EXP2 + + + + No documentation. + + + D3DFOG_LINEAR + D3DFOG_LINEAR + + + +

Defines the various types of surface formats.

typedef enum _D3DFORMAT { = 0, = 20, = 21, = 22, = 23, = 24, = 25, = 26, = 27, = 28, = 29, = 30, = 31, = 32, = 33, = 34, = 35, = 36, = 40, = 41, = 50, = 51, = 52, = 60, = 61, = 62, = 63, = 64, = 67, = MAKEFOURCC('U', 'Y', 'V', 'Y'), = MAKEFOURCC('R', 'G', 'B', 'G'), = MAKEFOURCC('Y', 'U', 'Y', '2'), = MAKEFOURCC('G', 'R', 'G', 'B'), = MAKEFOURCC('D', 'X', 'T', '1'), = MAKEFOURCC('D', 'X', 'T', '2'), = MAKEFOURCC('D', 'X', 'T', '3'), = MAKEFOURCC('D', 'X', 'T', '4'), = MAKEFOURCC('D', 'X', 'T', '5'), = 70, = 71, = 73, = 75, = 77, = 79, = 80, = 82, = 83, #if !defined(D3D_DISABLE_9EX) = 84, = 85, + #endif // !D3D_DISABLE_9EX = 81, =100, =101, =102, =110, = MAKEFOURCC('M','E','T','1'), = 111, = 112, = 113, = 114, = 115, = 116, = 117, #if !defined(D3D_DISABLE_9EX) = 118, = 119, = 199, + #endif // !D3D_DISABLE_9EX D3DFMT_FORCE_DWORD =0x7fffffff + } ; +
+ +

There are several types of formats:

  • BackBuffer
  • Buffer
  • DXTn
  • Floating-Point
  • FOURCC
  • IEEE
  • Mixed
  • Signed
  • Unsigned
  • Other
  • Constant

All formats are listed from left to right, most-significant bit to least-significant bit. For example, D3DFORMAT_ARGB is ordered from the most-significant bit channel A (alpha), to the least-significant bit channel B (blue). When traversing surface data, the data is stored in memory from least-significant bit to most-significant bit, which means that the channel order in memory is from least-significant bit (blue) to most-significant bit (alpha).

The default value for formats that contain undefined channels (G16R16, A8, and so on) is 1. The only exception is the A8 format, which is initialized to 000 for the three color channels.

The order of the bits is from the most significant byte first, so indicates that the high byte of this 2-byte format is alpha. indicates a 16-bit integer value and an application-lockable surface.

Pixel formats have been chosen to enable the expression of hardware-vendor-defined extension formats, as well as to include the well-established FOURCC method. The set of formats understood by the Direct3D runtime is defined by .

Note that formats are supplied by independent hardware vendors (IHVs) and many FOURCC codes are not listed. The formats in this enumeration are unique in that they are sanctioned by the runtime, meaning that the reference rasterizer will operate on all these types. IHV-supplied formats will be supported by the individual IHVs on a card-by-card basis.

BackBuffer or Display Formats

These formats are the only valid formats for a back buffer or a display.

FormatBack bufferDisplay
A2R10G10B10xx (full-screen mode only)
A8R8G8B8x
X8R8G8B8xx
A1R5G5B5x
X1R5G5B5xx
R5G6B5xx

?

Buffer Formats

Depth, stencil, vertex, and index buffers each have unique formats.

Buffer flagsValueFormat
7016-bit z-buffer bit depth.
7132-bit z-buffer bit depth.
7316-bit z-buffer bit depth where 15 bits are reserved for the depth channel and 1 bit is reserved for the stencil channel.
7532-bit z-buffer bit depth using 24 bits for the depth channel and 8 bits for the stencil channel.
7732-bit z-buffer bit depth using 24 bits for the depth channel.
7932-bit z-buffer bit depth using 24 bits for the depth channel and 4 bits for the stencil channel.
82A lockable format where the depth value is represented as a standard IEEE floating-point number.
83A non-lockable format that contains 24 bits of depth (in a 24-bit floating point format - 20e4) and 8 bits of stencil.
84A lockable 32-bit depth buffer. + Differences between Direct3D 9 and Direct3D 9Ex:??This flag is available in Direct3D 9Ex only.
84A lockable 8-bit stencil buffer. + Differences between Direct3D 9 and Direct3D 9Ex:??This flag is available in Direct3D 9Ex only.
8016-bit z-buffer bit depth.
100Describes a vertex buffer surface.
10116-bit index buffer bit depth.
10232-bit index buffer bit depth.

?

All depth-stencil formats except indicate no particular bit ordering per pixel, and the driver is allowed to consume more than the indicated number of bits-per-depth channel (but not stencil channel).

DXTn Compressed Texture Formats

These flags are used for compressed textures:

DXTn Compressed Texture flagsValueFormat
MAKEFOURCC('D', 'X', 'T', '1')DXT1 compression texture format
MAKEFOURCC('D', 'X', 'T', '2')DXT2 compression texture format
MAKEFOURCC('D', 'X', 'T', '3')DXT3 compression texture format
MAKEFOURCC('D', 'X', 'T', '4')DXT4 compression texture format
MAKEFOURCC('D', 'X', 'T', '5')DXT5 compression texture format

?

The runtime will not allow an application to create a surface using a DXTn format unless the surface dimensions are multiples of 4. This applies to offscreen-plain surfaces, render targets, 2D textures, cube textures, and volume textures.

Floating-Point Formats

These flags are used for floating-point surface formats. These 16-bits-per-channel formats are also known as s10e5 formats.

Floating-point flagsValueFormat
11116-bit float format using 16 bits for the red channel.
11232-bit float format using 16 bits for the red channel and 16 bits for the green channel.
11364-bit float format using 16 bits for the each channel (alpha, blue, green, red).

?

FOURCC Formats

Data in a FOURCC format is compressed data.

MAKEFOURCC

A macro for generating four-character codes follows:

#define MAKEFOURCC(ch0, ch1, ch2, ch3) \ ((DWORD)(BYTE)(ch0) | ((DWORD)(BYTE)(ch1) << 8) | \ ((DWORD)(BYTE)(ch2) << 16) | ((DWORD)(BYTE)(ch3) << 24 ))

Here are the defined FOURCC formats:

FOURCC flagsValueFormat
MAKEFOURCC('M','E','T','1')MultiElement texture (not compressed)
MAKEFOURCC('G', 'R', 'G', 'B')A 16-bit packed RGB format analogous to YUY2 (Y0U0, Y1V0, Y2U2, and so on). It requires a pixel pair in order to properly represent the color value. The first pixel in the pair contains 8 bits of green (in the high 8 bits) and 8 bits of red (in the low 8 bits). The second pixel contains 8 bits of green (in the high 8 bits) and 8 bits of blue (in the low 8 bits). Together, the two pixels share the red and blue components, while each has a unique green component (G0R0, G1B0, G2R2, and so on). The texture sampler does not normalize the colors when looking up into a pixel shader; they remain in the range of 0.0f to 255.0f. This is true for all programmable pixel shader models. For the fixed function pixel shader, the hardware should normalize to the 0.f to 1.f range and essentially treat it as the YUY2 texture. Hardware that exposes this format must have the PixelShader1xMaxValue member of set to a value capable of handling that range.
MAKEFOURCC('R', 'G', 'B', 'G')A 16-bit packed RGB format analogous to UYVY (U0Y0, V0Y1, U2Y2, and so on). It requires a pixel pair in order to properly represent the color value. The first pixel in the pair contains 8 bits of green (in the low 8 bits) and 8 bits of red (in the high 8 bits). The second pixel contains 8 bits of green (in the low 8 bits) and 8 bits of blue (in the high 8 bits). Together, the two pixels share the red and blue components, while each has a unique green component (R0G0, B0G1, R2G2, and so on). The texture sampler does not normalize the colors when looking up into a pixel shader; they remain in the range of 0.0f to 255.0f. This is true for all programmable pixel shader models. For the fixed function pixel shader, the hardware should normalize to the 0.f to 1.f range and essentially treat it as the YUY2 texture. Hardware that exposes this format must have PixelShader1xMaxValue member of set to a value capable of handling that range.
MAKEFOURCC('U', 'Y', 'V', 'Y')UYVY format (PC98 compliance)
MAKEFOURCC('Y', 'U', 'Y', '2')YUY2 format (PC98 compliance)

?

IEEE Formats

These flags are used for floating-point surface formats. These 32-bits-per-channel formats are also known as s23e8 formats.

Floating-point flagsValueFormat
11432-bit float format using 32 bits for the red channel.
11564-bit float format using 32 bits for the red channel and 32 bits for the green channel.
116128-bit float format using 32 bits for the each channel (alpha, blue, green, red).

?

Mixed Formats

Data in mixed formats can contain a combination of unsigned data and signed data.

Mixed format flagsValueFormat
6116-bit bump-map format with luminance using 6 bits for luminance, and 5 bits each for v and u.
6232-bit bump-map format with luminance using 8 bits for each channel.
6732-bit bump-map format using 2 bits for alpha and 10 bits each for w, v, and u.

?

Signed Formats

Data in a signed format can be both positive and negative. Signed formats use combinations of (U), (V), (W), and (Q) data.

Signed format flagsValueFormat
6016-bit bump-map format using 8 bits each for u and v data.
6332-bit bump-map format using 8 bits for each channel.
6432-bit bump-map format using 16 bits for each channel.
11064-bit bump-map format using 16 bits for each component.
11716-bit normal compression format. The texture sampler computes the C channel from: C = sqrt(1 - U2 - V2).

?

Unsigned Formats

Data in an unsigned format must be positive. Unsigned formats use combinations of (R)ed, (G)reen, (B)lue, (A)lpha, (L)uminance, and (P)alette data. Palette data is also referred to as color indexed data because the data is used to index a color palette.

Unsigned format flagsValueFormat
2024-bit RGB pixel format with 8 bits per channel.
2132-bit ARGB pixel format with alpha, using 8 bits per channel.
2232-bit RGB pixel format, where 8 bits are reserved for each color.
2316-bit RGB pixel format with 5 bits for red, 6 bits for green, and 5 bits for blue.
2416-bit pixel format where 5 bits are reserved for each color.
2516-bit pixel format where 5 bits are reserved for each color and 1 bit is reserved for alpha.
2616-bit ARGB pixel format with 4 bits for each channel.
278-bit RGB texture format using 3 bits for red, 3 bits for green, and 2 bits for blue.
288-bit alpha only.
2916-bit ARGB texture format using 8 bits for alpha, 3 bits each for red and green, and 2 bits for blue.
3016-bit RGB pixel format using 4 bits for each color.
3132-bit pixel format using 10 bits for each color and 2 bits for alpha.
3232-bit ARGB pixel format with alpha, using 8 bits per channel.
3332-bit RGB pixel format, where 8 bits are reserved for each color.
3432-bit pixel format using 16 bits each for green and red.
3532-bit pixel format using 10 bits each for red, green, and blue, and 2 bits for alpha.
3664-bit pixel format using 16 bits for each component.
408-bit color indexed with 8 bits of alpha.
418-bit color indexed.
508-bit luminance only.
8116-bit luminance only.
5116-bit using 8 bits each for alpha and luminance.
528-bit using 4 bits each for alpha and luminance.
1181-bit monochrome. + Differences between Direct3D 9 and Direct3D 9Ex:??This flag is available in Direct3D 9Ex only.
1192.8-biased fixed point. + Differences between Direct3D 9 and Direct3D 9Ex:??This flag is available in Direct3D 9Ex only.
199Binary format indicating that the data has no inherent type. + Differences between Direct3D 9 and Direct3D 9Ex:??This flag is available in Direct3D 9Ex only.

?

Other

This flag is used for undefined formats.

Other flagsValueFormat
0Surface format is unknown

?

+
+ + bb172558 + D3DFORMAT + D3DFORMAT +
+ + + No documentation. + + + D3DFMT_UNKNOWN + D3DFMT_UNKNOWN + + + + No documentation. + + + D3DFMT_R8G8B8 + D3DFMT_R8G8B8 + + + + No documentation. + + + D3DFMT_A8R8G8B8 + D3DFMT_A8R8G8B8 + + + + No documentation. + + + D3DFMT_X8R8G8B8 + D3DFMT_X8R8G8B8 + + + + No documentation. + + + D3DFMT_R5G6B5 + D3DFMT_R5G6B5 + + + + No documentation. + + + D3DFMT_X1R5G5B5 + D3DFMT_X1R5G5B5 + + + + No documentation. + + + D3DFMT_A1R5G5B5 + D3DFMT_A1R5G5B5 + + + + No documentation. + + + D3DFMT_A4R4G4B4 + D3DFMT_A4R4G4B4 + + + + No documentation. + + + D3DFMT_R3G3B2 + D3DFMT_R3G3B2 + + + + No documentation. + + + D3DFMT_A8 + D3DFMT_A8 + + + + No documentation. + + + D3DFMT_A8R3G3B2 + D3DFMT_A8R3G3B2 + + + + No documentation. + + + D3DFMT_X4R4G4B4 + D3DFMT_X4R4G4B4 + + + + No documentation. + + + D3DFMT_A2B10G10R10 + D3DFMT_A2B10G10R10 + + + + No documentation. + + + D3DFMT_A8B8G8R8 + D3DFMT_A8B8G8R8 + + + + No documentation. + + + D3DFMT_X8B8G8R8 + D3DFMT_X8B8G8R8 + + + + No documentation. + + + D3DFMT_G16R16 + D3DFMT_G16R16 + + + + No documentation. + + + D3DFMT_A2R10G10B10 + D3DFMT_A2R10G10B10 + + + + No documentation. + + + D3DFMT_A16B16G16R16 + D3DFMT_A16B16G16R16 + + + + No documentation. + + + D3DFMT_A8P8 + D3DFMT_A8P8 + + + + No documentation. + + + D3DFMT_P8 + D3DFMT_P8 + + + + No documentation. + + + D3DFMT_L8 + D3DFMT_L8 + + + + No documentation. + + + D3DFMT_A8L8 + D3DFMT_A8L8 + + + + No documentation. + + + D3DFMT_A4L4 + D3DFMT_A4L4 + + + + No documentation. + + + D3DFMT_V8U8 + D3DFMT_V8U8 + + + + No documentation. + + + D3DFMT_L6V5U5 + D3DFMT_L6V5U5 + + + + No documentation. + + + D3DFMT_X8L8V8U8 + D3DFMT_X8L8V8U8 + + + + No documentation. + + + D3DFMT_Q8W8V8U8 + D3DFMT_Q8W8V8U8 + + + + No documentation. + + + D3DFMT_V16U16 + D3DFMT_V16U16 + + + + No documentation. + + + D3DFMT_A2W10V10U10 + D3DFMT_A2W10V10U10 + + + + No documentation. + + + D3DFMT_UYVY + D3DFMT_UYVY + + + + No documentation. + + + D3DFMT_R8G8_B8G8 + D3DFMT_R8G8_B8G8 + + + + No documentation. + + + D3DFMT_YUY2 + D3DFMT_YUY2 + + + + No documentation. + + + D3DFMT_G8R8_G8B8 + D3DFMT_G8R8_G8B8 + + + + No documentation. + + + D3DFMT_DXT1 + D3DFMT_DXT1 + + + + No documentation. + + + D3DFMT_DXT2 + D3DFMT_DXT2 + + + + No documentation. + + + D3DFMT_DXT3 + D3DFMT_DXT3 + + + + No documentation. + + + D3DFMT_DXT4 + D3DFMT_DXT4 + + + + No documentation. + + + D3DFMT_DXT5 + D3DFMT_DXT5 + + + + No documentation. + + + D3DFMT_D16_LOCKABLE + D3DFMT_D16_LOCKABLE + + + + No documentation. + + + D3DFMT_D32 + D3DFMT_D32 + + + + No documentation. + + + D3DFMT_D15S1 + D3DFMT_D15S1 + + + + No documentation. + + + D3DFMT_D24S8 + D3DFMT_D24S8 + + + + No documentation. + + + D3DFMT_D24X8 + D3DFMT_D24X8 + + + + No documentation. + + + D3DFMT_D24X4S4 + D3DFMT_D24X4S4 + + + + No documentation. + + + D3DFMT_D16 + D3DFMT_D16 + + + + No documentation. + + + D3DFMT_D32F_LOCKABLE + D3DFMT_D32F_LOCKABLE + + + + No documentation. + + + D3DFMT_D24FS8 + D3DFMT_D24FS8 + + + + No documentation. + + + D3DFMT_D32_LOCKABLE + D3DFMT_D32_LOCKABLE + + + + No documentation. + + + D3DFMT_S8_LOCKABLE + D3DFMT_S8_LOCKABLE + + + + No documentation. + + + D3DFMT_L16 + D3DFMT_L16 + + + + No documentation. + + + D3DFMT_VERTEXDATA + D3DFMT_VERTEXDATA + + + + No documentation. + + + D3DFMT_INDEX16 + D3DFMT_INDEX16 + + + + No documentation. + + + D3DFMT_INDEX32 + D3DFMT_INDEX32 + + + + No documentation. + + + D3DFMT_Q16W16V16U16 + D3DFMT_Q16W16V16U16 + + + + No documentation. + + + D3DFMT_MULTI2_ARGB8 + D3DFMT_MULTI2_ARGB8 + + + + No documentation. + + + D3DFMT_R16F + D3DFMT_R16F + + + + No documentation. + + + D3DFMT_G16R16F + D3DFMT_G16R16F + + + + No documentation. + + + D3DFMT_A16B16G16R16F + D3DFMT_A16B16G16R16F + + + + No documentation. + + + D3DFMT_R32F + D3DFMT_R32F + + + + No documentation. + + + D3DFMT_G32R32F + D3DFMT_G32R32F + + + + No documentation. + + + D3DFMT_A32B32G32R32F + D3DFMT_A32B32G32R32F + + + + No documentation. + + + D3DFMT_CxV8U8 + D3DFMT_CxV8U8 + + + + No documentation. + + + D3DFMT_A1 + D3DFMT_A1 + + + + No documentation. + + + D3DFMT_A2B10G10R10_XR_BIAS + D3DFMT_A2B10G10R10_XR_BIAS + + + + No documentation. + + + D3DFMT_BINARYBUFFER + D3DFMT_BINARYBUFFER + + + +

Options for saving and creating effects.

The constants in the following table are defined in d3dx9effect.h.

+
+ + bb172855 + D3DXFX + D3DXFX +
+ + + No documentation. + + + D3DXFX_DONOTSAVESTATE + D3DXFX_DONOTSAVESTATE + + + + No documentation. + + + D3DXFX_DONOTSAVESHADERSTATE + D3DXFX_DONOTSAVESHADERSTATE + + + + No documentation. + + + D3DXFX_DONOTSAVESAMPLERSTATE + D3DXFX_DONOTSAVESAMPLERSTATE + + + + No documentation. + + + D3DXFX_NOT_CLONEABLE + D3DXFX_NOT_CLONEABLE + + + + No documentation. + + + D3DXFX_LARGEADDRESSAWARE + D3DXFX_LARGEADDRESSAWARE + + + + None. + + + None + None + + + +

Describes the supported image file formats. See Remarks for descriptions of these formats.

+
+ +

Functions that begin with D3DXLoadxxx support all of the formats listed. Functions that begin with D3DXSavexxx support all of the formats listed except the Truevision (.tga) and portable pixmap (.ppm) formats.

The following table lists the available input and output formats.

File ExtensionDescription
.bmpWindows bitmap format. Contains a header that describes the resolution of the device on which the rectangle of pixels was created, the dimensions of the rectangle, the size of the array of bits, a logical palette, and an array of bits that defines the relationship between pixels in the bitmapped image and entries in the logical palette.
.ddsDirectDraw Surface file format. Stores textures, volume textures, and cubic environment maps, with or without mipmap levels, and with or without pixel compression. See DDS.
.dibWindows DIB. Contains an array of bits combined with structures that specify width and height of the bitmapped image, color format of the device where the image was created, and resolution of the device used to create that image.
.hdrHDR format. Encodes each pixel as an RGBE 32-bit color, with 8 bits of mantissa for red, green, and blue, and a shared 8-bit exponent. Each channel is separately compressed with run-length encoding (RLE).
.jpgJPEG standard. Specifies variable compression of 24-bit RGB color and 8-bit gray-scale Tagged Image File Format (TIFF) image document files.
.pfmPortable float map format. A raw floating point image format, without any compression. The file header specifies image width, height, monochrome or color, and machine word order. Pixel data is stored as 32-bit floating point values, with 3 values per pixel for color, and one value per pixel for monochrome.
.pngPNG format. A non-proprietary bitmap format using lossless compression.
.ppmPortable Pixmap format. A binary or ASCII file format for color images that includes image height and width and the maximum color component value.
.tgaTarga or Truevision Graphics Adapter format. Supports depths of 8, 15, 16, 24, and 32 bits, including 8-bit gray scale, and contains optional color palette data, image (x, y) origin and size data, and pixel data.

?

See Types of Bitmaps for more information on some of these formats.

+
+ + bb172878 + D3DXIMAGE_FILEFORMAT + D3DXIMAGE_FILEFORMAT +
+ + +

Windows bitmap (BMP) file format.

+
+ + bb172878 + D3DXIFF_BMP + D3DXIFF_BMP +
+ + +

Joint Photographics Experts Group (JPEG) compressed file format.

+
+ + bb172878 + D3DXIFF_JPG + D3DXIFF_JPG +
+ + +

Truevision (Targa, or TGA) image file format.

+
+ + bb172878 + D3DXIFF_TGA + D3DXIFF_TGA +
+ + +

Portable Network Graphics (PNG) file format.

+
+ + bb172878 + D3DXIFF_PNG + D3DXIFF_PNG +
+ + +

DirectDraw surface (DDS) file format.

+
+ + bb172878 + D3DXIFF_DDS + D3DXIFF_DDS +
+ + +

Portable pixmap (PPM) file format.

+
+ + bb172878 + D3DXIFF_PPM + D3DXIFF_PPM +
+ + +

Windows device-independent bitmap (DIB) file format.

+
+ + bb172878 + D3DXIFF_DIB + D3DXIFF_DIB +
+ + +

High dynamic range (HDR) file format.

+
+ + bb172878 + D3DXIFF_HDR + D3DXIFF_HDR +
+ + +

Portable float map file format.

+
+ + bb172878 + D3DXIFF_PFM + D3DXIFF_PFM +
+ + +

Describes the location for the include file.

+
+ + bb172881 + D3DXINCLUDE_TYPE + D3DXINCLUDE_TYPE +
+ + +

Look in the local project for the include file.

+
+ + bb172881 + D3DXINC_LOCAL + D3DXINC_LOCAL +
+ + +

Look in the system path for the include file.

+
+ + bb172881 + D3DXINC_SYSTEM + D3DXINC_SYSTEM +
+ + +

This macro creates a value used by Issue to issue a query end.

#define (1 << 0) +
+ +

This macro changes the query state to nonsignaled.

is valid for the following query types.

  • D3DQUERYTYPE_ResourceManager
+
+ + bb172565 + D3DISSUE + D3DISSUE +
+ + + No documentation. + + + D3DISSUE_END + D3DISSUE_END + + + + No documentation. + + + D3DISSUE_BEGIN + D3DISSUE_BEGIN + + + + No documentation. + + + D3DLIGHTTYPE + D3DLIGHTTYPE + + + + No documentation. + + + D3DLIGHT_POINT + D3DLIGHT_POINT + + + + No documentation. + + + D3DLIGHT_SPOT + D3DLIGHT_SPOT + + + + No documentation. + + + D3DLIGHT_DIRECTIONAL + D3DLIGHT_DIRECTIONAL + + + + No documentation. + + + D3DLINECAPS + D3DLINECAPS + + + + No documentation. + + + D3DLINECAPS_TEXTURE + D3DLINECAPS_TEXTURE + + + + No documentation. + + + D3DLINECAPS_ZTEST + D3DLINECAPS_ZTEST + + + + No documentation. + + + D3DLINECAPS_BLEND + D3DLINECAPS_BLEND + + + + No documentation. + + + D3DLINECAPS_ALPHACMP + D3DLINECAPS_ALPHACMP + + + + No documentation. + + + D3DLINECAPS_FOG + D3DLINECAPS_FOG + + + + No documentation. + + + D3DLINECAPS_ANTIALIAS + D3DLINECAPS_ANTIALIAS + + + +

A combination of zero or more locking options that describe the type of lock to perform.

+
+ + bb172568 + D3DLOCK + D3DLOCK +
+ + + No documentation. + + + D3DLOCK_READONLY + D3DLOCK_READONLY + + + + No documentation. + + + D3DLOCK_DISCARD + D3DLOCK_DISCARD + + + + No documentation. + + + D3DLOCK_NOOVERWRITE + D3DLOCK_NOOVERWRITE + + + + No documentation. + + + D3DLOCK_NOSYSLOCK + D3DLOCK_NOSYSLOCK + + + + No documentation. + + + D3DLOCK_DONOTWAIT + D3DLOCK_DONOTWAIT + + + + No documentation. + + + D3DLOCK_NO_DIRTY_UPDATE + D3DLOCK_NO_DIRTY_UPDATE + + + + No documentation. + + + D3DLOCK_DONOTCOPYDATA + D3DLOCK_DONOTCOPYDATA + + + + None. + + + None + None + + + +

Defines the type of mesh data present in .

+
+ + bb205373 + D3DXMESHDATATYPE + D3DXMESHDATATYPE +
+ + + No documentation. + + + D3DXMESHTYPE_MESH + D3DXMESHTYPE_MESH + + + + No documentation. + + + D3DXMESHTYPE_PMESH + D3DXMESHTYPE_PMESH + + + + No documentation. + + + D3DXMESHTYPE_PATCHMESH + D3DXMESHTYPE_PATCHMESH + + + +

Flags used to specify creation options for a mesh.

+
+ +

A 32-bit mesh () can theoretically support (2^32)-1 faces and vertices. However, allocating memory for a mesh that large on a 32-bit operating system is not practical.

+
+ + bb205370 + _D3DXMESH + _D3DXMESH +
+ + +

The mesh has 32-bit indices instead of 16-bit indices. See Remarks.

+
+ + bb205370 + D3DXMESH_32BIT + D3DXMESH_32BIT +
+ + +

Use the usage flag for vertex and index buffers.

+
+ + bb205370 + D3DXMESH_DONOTCLIP + D3DXMESH_DONOTCLIP +
+ + +

Use the usage flag for vertex and index buffers.

+
+ + bb205370 + D3DXMESH_POINTS + D3DXMESH_POINTS +
+ + +

Use the usage flag for vertex and index buffers.

+
+ + bb205370 + D3DXMESH_RTPATCHES + D3DXMESH_RTPATCHES +
+ + +

Specifying this flag causes the vertex and index buffer of the mesh to be created with flag. This is required if the mesh object is to be rendered using N-patch enhancement using Direct3D.

+
+ + bb205370 + D3DXMESH_NPATCHES + D3DXMESH_NPATCHES +
+ + +

Use the usage flag for vertex buffers.

+
+ + bb205370 + D3DXMESH_VB_SYSTEMMEM + D3DXMESH_VB_SYSTEMMEM +
+ + +

Use the usage flag for vertex buffers.

+
+ + bb205370 + D3DXMESH_VB_MANAGED + D3DXMESH_VB_MANAGED +
+ + +

Use the usage flag for vertex buffers.

+
+ + bb205370 + D3DXMESH_VB_WRITEONLY + D3DXMESH_VB_WRITEONLY +
+ + +

Use the usage flag for vertex buffers.

+
+ + bb205370 + D3DXMESH_VB_DYNAMIC + D3DXMESH_VB_DYNAMIC +
+ + +

Use the usage flag for vertex buffers.

+
+ + bb205370 + D3DXMESH_VB_SOFTWAREPROCESSING + D3DXMESH_VB_SOFTWAREPROCESSING +
+ + +

Use the usage flag for index buffers.

+
+ + bb205370 + D3DXMESH_IB_SYSTEMMEM + D3DXMESH_IB_SYSTEMMEM +
+ + +

Use the usage flag for index buffers.

+
+ + bb205370 + D3DXMESH_IB_MANAGED + D3DXMESH_IB_MANAGED +
+ + +

Use the usage flag for index buffers.

+
+ + bb205370 + D3DXMESH_IB_WRITEONLY + D3DXMESH_IB_WRITEONLY +
+ + +

Use the usage flag for index buffers.

+
+ + bb205370 + D3DXMESH_IB_DYNAMIC + D3DXMESH_IB_DYNAMIC +
+ + +

Use the usage flag for index buffers.

+
+ + bb205370 + D3DXMESH_IB_SOFTWAREPROCESSING + D3DXMESH_IB_SOFTWAREPROCESSING +
+ + +

Forces the cloned meshes to share vertex buffers.

+
+ + bb205370 + D3DXMESH_VB_SHARE + D3DXMESH_VB_SHARE +
+ + +

Use hardware processing only. For mixed-mode device, this flag will cause the system to use hardware (if supported in hardware) or will default to software processing.

+
+ + bb205370 + D3DXMESH_USEHWONLY + D3DXMESH_USEHWONLY +
+ + +

Equivalent to specifying both and .

+
+ + bb205370 + D3DXMESH_SYSTEMMEM + D3DXMESH_SYSTEMMEM +
+ + +

Equivalent to specifying both and .

+
+ + bb205370 + D3DXMESH_MANAGED + D3DXMESH_MANAGED +
+ + +

Equivalent to specifying both and .

+
+ + bb205370 + D3DXMESH_WRITEONLY + D3DXMESH_WRITEONLY +
+ + +

Equivalent to specifying both and .

+
+ + bb205370 + D3DXMESH_DYNAMIC + D3DXMESH_DYNAMIC +
+ + +

Equivalent to specifying both and .

+
+ + bb205370 + D3DXMESH_SOFTWAREPROCESSING + D3DXMESH_SOFTWAREPROCESSING +
+ + +

Specifies the type of mesh optimization to be performed.

+
+ +

The and optimization flags are mutually exclusive.

The D3DXMESHOPT_SHAREVB flag has been removed from this enumeration. Use instead, in D3DXMESH.

+
+ + bb205374 + _D3DXMESHOPT + _D3DXMESHOPT +
+ + +

Reorders faces to remove unused vertices and faces.

+
+ + bb205374 + D3DXMESHOPT_COMPACT + D3DXMESHOPT_COMPACT +
+ + +

Reorders faces to optimize for fewer attribute bundle state changes and enhanced performance.

+
+ + bb205374 + D3DXMESHOPT_ATTRSORT + D3DXMESHOPT_ATTRSORT +
+ + +

Reorders faces to increase the cache hit rate of vertex caches.

+
+ + bb205374 + D3DXMESHOPT_VERTEXCACHE + D3DXMESHOPT_VERTEXCACHE +
+ + +

Reorders faces to maximize length of adjacent triangles.

+
+ + bb205374 + D3DXMESHOPT_STRIPREORDER + D3DXMESHOPT_STRIPREORDER +
+ + +

Optimize the faces only; do not optimize the vertices.

+
+ + bb205374 + D3DXMESHOPT_IGNOREVERTS + D3DXMESHOPT_IGNOREVERTS +
+ + +

While attribute sorting, do not split vertices that are shared between attribute groups.

+
+ + bb205374 + D3DXMESHOPT_DONOTSPLIT + D3DXMESHOPT_DONOTSPLIT +
+ + +

Affects the vertex cache size. Using this flag specifies a default vertex cache size that works well on legacy hardware.

+
+ + bb205374 + D3DXMESHOPT_DEVICEINDEPENDENT + D3DXMESHOPT_DEVICEINDEPENDENT +
+ + +

Specifies simplification options for a mesh.

+
+ + Bb205375 + _D3DXMESHSIMP + _D3DXMESHSIMP +
+ + +

The mesh will be simplified by the number of vertices specified in the MinValue parameter.

+
+ + Bb205375 + D3DXMESHSIMP_VERTEX + D3DXMESHSIMP_VERTEX +
+ + +

The mesh will be simplified by the number of faces specified in the MinValue parameter.

+
+ + Bb205375 + D3DXMESHSIMP_FACE + D3DXMESHSIMP_FACE +
+ + +

Defines the levels of full-scene multisampling that the device can apply.

+
+ +

In addition to enabling full-scene multisampling at time, there will be render states that turn various aspects on and off at fine-grained levels.

Multisampling is valid only on a swap chain that is being created or reset with the swap effect.

The multisample antialiasing value can be set with the parameters (or sub-parameters) in the following methods.

MethodParametersSub-parameters
MultiSampleType and pQualityLevels
pPresentationParametersMultiSampleType and pQualityLevels
pPresentationParametersMultiSampleType and pQualityLevels
MultiSampleType and pQualityLevels
MultiSampleType and pQualityLevels
pPresentationParametersMultiSampleType and pQualityLevels

?

It is not good practice to switch from one multisample type to another to raise the quality of the antialiasing.

enables swap effects other than discarding, locking, and so on.

Whether the display device supports maskable multisampling (more than one sample for a multiple-sample render-target format plus antialias support) or just non-maskable multisampling (only antialias support), the driver for the device provides the number of quality levels for the multiple-sample type. Applications that just use multisampling for antialiasing purposes only need to query for the number of non-maskable multiple-sample quality levels that the driver supports.

The quality levels supported by the device can be obtained with the pQualityLevels parameter of . Quality levels used by the application are set with the MultiSampleQuality parameter of and .

See for discussion of maskable multisampling.

+
+ + bb172574 + D3DMULTISAMPLE_TYPE + D3DMULTISAMPLE_TYPE +
+ + +

No level of full-scene multisampling is available.

+
+ + bb172574 + D3DMULTISAMPLE_NONE + D3DMULTISAMPLE_NONE +
+ + +

Enables the multisample quality value. See Remarks.

+
+ + bb172574 + D3DMULTISAMPLE_NONMASKABLE + D3DMULTISAMPLE_NONMASKABLE +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_2_SAMPLES + D3DMULTISAMPLE_2_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_3_SAMPLES + D3DMULTISAMPLE_3_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_4_SAMPLES + D3DMULTISAMPLE_4_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_5_SAMPLES + D3DMULTISAMPLE_5_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_6_SAMPLES + D3DMULTISAMPLE_6_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_7_SAMPLES + D3DMULTISAMPLE_7_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_8_SAMPLES + D3DMULTISAMPLE_8_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_9_SAMPLES + D3DMULTISAMPLE_9_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_10_SAMPLES + D3DMULTISAMPLE_10_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_11_SAMPLES + D3DMULTISAMPLE_11_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_12_SAMPLES + D3DMULTISAMPLE_12_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_13_SAMPLES + D3DMULTISAMPLE_13_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_14_SAMPLES + D3DMULTISAMPLE_14_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_15_SAMPLES + D3DMULTISAMPLE_15_SAMPLES +
+ + +

Level of full-scene multisampling available.

+
+ + bb172574 + D3DMULTISAMPLE_16_SAMPLES + D3DMULTISAMPLE_16_SAMPLES +
+ + +

Normal maps generation constants.

+
+ + bb205566 + D3DX_NORMALMAP + D3DX_NORMALMAP +
+ + + No documentation. + + + D3DX_NORMALMAP_MIRROR_U + D3DX_NORMALMAP_MIRROR_U + + + + No documentation. + + + D3DX_NORMALMAP_MIRROR_V + D3DX_NORMALMAP_MIRROR_V + + + + No documentation. + + + D3DX_NORMALMAP_MIRROR + D3DX_NORMALMAP_MIRROR + + + + No documentation. + + + D3DX_NORMALMAP_INVERTSIGN + D3DX_NORMALMAP_INVERTSIGN + + + + No documentation. + + + D3DX_NORMALMAP_COMPUTE_OCCLUSION + D3DX_NORMALMAP_COMPUTE_OCCLUSION + + + +

The type of object.

+
+ + bb205378 + D3DXPARAMETER_CLASS + D3DXPARAMETER_CLASS +
+ + +

Constant is a scalar.

+
+ + bb205378 + D3DXPC_SCALAR + D3DXPC_SCALAR +
+ + +

Constant is a vector.

+
+ + bb205378 + D3DXPC_VECTOR + D3DXPC_VECTOR +
+ + +

Constant is a row major matrix.

+
+ + bb205378 + D3DXPC_MATRIX_ROWS + D3DXPC_MATRIX_ROWS +
+ + +

Constant is a column major matrix.

+
+ + bb205378 + D3DXPC_MATRIX_COLUMNS + D3DXPC_MATRIX_COLUMNS +
+ + +

Constant is either a texture, shader, or a string.

+
+ + bb205378 + D3DXPC_OBJECT + D3DXPC_OBJECT +
+ + +

Constant is a structure.

+
+ + bb205378 + D3DXPC_STRUCT + D3DXPC_STRUCT +
+ + +

These flags provide additional information about effect parameters.

Effect parameter constants are used by .

+
+ + bb205567 + D3DX_PARAMETER + D3DX_PARAMETER +
+ + + No documentation. + + + D3DX_PARAMETER_SHARED + D3DX_PARAMETER_SHARED + + + + No documentation. + + + D3DX_PARAMETER_LITERAL + D3DX_PARAMETER_LITERAL + + + + No documentation. + + + D3DX_PARAMETER_ANNOTATION + D3DX_PARAMETER_ANNOTATION + + + + None. + + + None + None + + + +

Describes the data contained by the enumeration.

+
+ + bb205380 + D3DXPARAMETER_TYPE + D3DXPARAMETER_TYPE +
+ + +

Parameter is a void reference.

+
+ + bb205380 + D3DXPT_VOID + D3DXPT_VOID +
+ + +

Parameter is a Boolean. Any non-zero value passed into , , , , or will be mapped to 1 (TRUE) before being written into the constant table; otherwise, the value will be set to 0 in the constant table.

+
+ + bb205380 + D3DXPT_BOOL + D3DXPT_BOOL +
+ + +

Parameter is an integer. Any floating-point values passed into , , or will be rounded off (to zero decimal places) before being written into the constant table.

+
+ + bb205380 + D3DXPT_INT + D3DXPT_INT +
+ + +

Parameter is a floating-point number.

+
+ + bb205380 + D3DXPT_FLOAT + D3DXPT_FLOAT +
+ + +

Parameter is a string.

+
+ + bb205380 + D3DXPT_STRING + D3DXPT_STRING +
+ + +

Parameter is a texture.

+
+ + bb205380 + D3DXPT_TEXTURE + D3DXPT_TEXTURE +
+ + +

Parameter is a 1D texture.

+
+ + bb205380 + D3DXPT_TEXTURE1D + D3DXPT_TEXTURE1D +
+ + +

Parameter is a 2D texture.

+
+ + bb205380 + D3DXPT_TEXTURE2D + D3DXPT_TEXTURE2D +
+ + +

Parameter is a 3D texture.

+
+ + bb205380 + D3DXPT_TEXTURE3D + D3DXPT_TEXTURE3D +
+ + +

Parameter is a cube texture.

+
+ + bb205380 + D3DXPT_TEXTURECUBE + D3DXPT_TEXTURECUBE +
+ + +

Parameter is a sampler.

+
+ + bb205380 + D3DXPT_SAMPLER + D3DXPT_SAMPLER +
+ + +

Parameter is a 1D sampler.

+
+ + bb205380 + D3DXPT_SAMPLER1D + D3DXPT_SAMPLER1D +
+ + +

Parameter is a 2D sampler.

+
+ + bb205380 + D3DXPT_SAMPLER2D + D3DXPT_SAMPLER2D +
+ + +

Parameter is a 3D sampler.

+
+ + bb205380 + D3DXPT_SAMPLER3D + D3DXPT_SAMPLER3D +
+ + +

Parameter is a cube sampler.

+
+ + bb205380 + D3DXPT_SAMPLERCUBE + D3DXPT_SAMPLERCUBE +
+ + +

Parameter is a pixel shader.

+
+ + bb205380 + D3DXPT_PIXELSHADER + D3DXPT_PIXELSHADER +
+ + +

Parameter is a vertex shader.

+
+ + bb205380 + D3DXPT_VERTEXSHADER + D3DXPT_VERTEXSHADER +
+ + +

Parameter is a pixel shader fragment.

+
+ + bb205380 + D3DXPT_PIXELFRAGMENT + D3DXPT_PIXELFRAGMENT +
+ + +

Parameter is a vertex shader fragment.

+
+ + bb205380 + D3DXPT_VERTEXFRAGMENT + D3DXPT_VERTEXFRAGMENT +
+ + +

Parameter is not supported.

+
+ + bb205380 + D3DXPT_UNSUPPORTED + D3DXPT_UNSUPPORTED +
+ + +

Defines whether the current tessellation mode is discrete or continuous.

+
+ +

Note that continuous tessellation produces a completely different tessellation pattern from the discrete one for the same tessellation values (this is more apparent in wireframe mode). Thus, 4.0 continuous is not the same as 4 discrete.

+
+ + bb172575 + D3DPATCHEDGESTYLE + D3DPATCHEDGESTYLE +
+ + +

Discrete edge style. In discrete mode, you can specify float tessellation but it will be truncated to integers.

+
+ + bb172575 + D3DPATCHEDGE_DISCRETE + D3DPATCHEDGE_DISCRETE +
+ + +

Continuous edge style. In continuous mode, tessellation is specified as float values that can be smoothly varied to reduce "popping" artifacts.

+
+ + bb172575 + D3DPATCHEDGE_CONTINUOUS + D3DPATCHEDGE_CONTINUOUS +
+ + +

Mesh patch types.

+
+ +

Triangle patches have three sides and are described in . Rectangle patches are four-sided and are described in .

+
+ + bb205384 + D3DXPATCHMESHTYPE + D3DXPATCHMESHTYPE +
+ + +

Rectangle patch mesh type.

+
+ + bb205384 + D3DXPATCHMESH_RECT + D3DXPATCHMESH_RECT +
+ + +

Triangle patch mesh type.

+
+ + bb205384 + D3DXPATCHMESH_TRI + D3DXPATCHMESH_TRI +
+ + +

N-patch mesh type.

+
+ + bb205384 + D3DXPATCHMESH_NPATCH + D3DXPATCHMESH_NPATCH +
+ + + No documentation. + + + D3DPS20CAPS + D3DPS20CAPS + + + + No documentation. + + + D3DPS20CAPS_ARBITRARYSWIZZLE + D3DPS20CAPS_ARBITRARYSWIZZLE + + + + No documentation. + + + D3DPS20CAPS_GRADIENTINSTRUCTIONS + D3DPS20CAPS_GRADIENTINSTRUCTIONS + + + + No documentation. + + + D3DPS20CAPS_PREDICATION + D3DPS20CAPS_PREDICATION + + + + No documentation. + + + D3DPS20CAPS_NODEPENDENTREADLIMIT + D3DPS20CAPS_NODEPENDENTREADLIMIT + + + + No documentation. + + + D3DPS20CAPS_NOTEXINSTRUCTIONLIMIT + D3DPS20CAPS_NOTEXINSTRUCTIONLIMIT + + + + None. + + + None + None + + + +

Defines the type of animation set looping modes used for playback.

+
+ + bb205397 + D3DXPLAYBACK_TYPE + D3DXPLAYBACK_TYPE +
+ + +

The animation repeats endlessly.

+
+ + bb205397 + D3DXPLAY_LOOP + D3DXPLAY_LOOP +
+ + +

The animation plays once, and then it stops on the last frame.

+
+ + bb205397 + D3DXPLAY_ONCE + D3DXPLAY_ONCE +
+ + +

The animation alternates endlessly between playing forward and playing backward.

+
+ + bb205397 + D3DXPLAY_PINGPONG + D3DXPLAY_PINGPONG +
+ + +

Defines the memory class that holds the buffers for a resource.

+
+ +

All pool types are valid with all resources including: vertex buffers, index buffers, textures, and surfaces.

The following tables indicate restrictions on pool types for render targets, depth stencils, and dynamic and mipmap usages. An x indicates a compatible combination; lack of an x indicates incompatibility.

Pool
xx

?

Pool
xx
x
x

?

For more information about usage types, see .

Pools cannot be mixed for different objects contained within one resource (mip levels in a mipmap) and, when a pool is chosen, it cannot be changed.

Applications should use for most static resources because this saves the application from having to deal with lost devices. (Managed resources are restored by the runtime.) This is especially beneficial for unified memory architecture (UMA) systems. Other dynamic resources are not a good match for . In fact, index buffers and vertex buffers cannot be created using together with .

For dynamic textures, it is sometimes desirable to use a pair of video memory and system memory textures, allocating the video memory using and the system memory using . You can lock and modify the bits of the system memory texture using a locking method. Then you can update the video memory texture using .

+
+ + bb172584 + D3DPOOL + D3DPOOL +
+ + +

Resources are placed in the memory pool most appropriate for the set of usages requested for the given resource. This is usually video memory, including both local video memory and AGP memory. The pool is separate from and , and it specifies that the resource is placed in the preferred memory for device access. Note that never indicates that either or should be chosen as the memory pool type for this resource. Textures placed in the pool cannot be locked unless they are dynamic textures or they are private, FOURCC, driver formats. To access unlockable textures, you must use functions such as , , , and . is probably a better choice than for most applications. Note that some textures created in driver-proprietary pixel formats, unknown to the Direct3D runtime, can be locked. Also note that - unlike textures - swap chain back buffers, render targets, vertex buffers, and index buffers can be locked. When a device is lost, resources created using must be released before calling . For more information, see Lost Devices (Direct3D 9).

When creating resources with , if video card memory is already committed, managed resources will be evicted to free enough memory to satisfy the request.

+
+ + bb172584 + D3DPOOL_DEFAULT + D3DPOOL_DEFAULT +
+ + +

Resources are copied automatically to device-accessible memory as needed. Managed resources are backed by system memory and do not need to be recreated when a device is lost. See Managing Resources (Direct3D 9) for more information. Managed resources can be locked. Only the system-memory copy is directly modified. Direct3D copies your changes to driver-accessible memory as needed.

Differences between Direct3D 9 and Direct3D 9Ex:

is valid with ; however, it is not valid with .

?

+
+ + bb172584 + D3DPOOL_MANAGED + D3DPOOL_MANAGED +
+ + +

Resources are placed in memory that is not typically accessible by the Direct3D device. This memory allocation consumes system RAM but does not reduce pageable RAM. These resources do not need to be recreated when a device is lost. Resources in this pool can be locked and can be used as the source for a or operation to a memory resource created with .

+
+ + bb172584 + D3DPOOL_SYSTEMMEM + D3DPOOL_SYSTEMMEM +
+ + +

Resources are placed in system RAM and do not need to be recreated when a device is lost. These resources are not bound by device size or format restrictions. Because of this, these resources cannot be accessed by the Direct3D device nor set as textures or render targets. However, these resources can always be created, locked, and copied.

+
+ + bb172584 + D3DPOOL_SCRATCH + D3DPOOL_SCRATCH +
+ + +

Describes the relationship between the adapter refresh rate and the rate at which Present or Present operations are completed. These values also serve as flag values for the PresentationIntervals field of .

+
+ +

Windowed mode supports , , and . and the are nearly equivalent (see the information regarding timer resolution below). They perform similarly to COPY_VSYNC in that there is only one present per frame, and they prevent tearing with beam-following. In contrast, will attempt to provide an unlimited presentation rate.

Full-screen mode supports similar usage as windowed mode by supporting regardless of the refresh rate or swap effect. uses the default system timer resolution whereas the calls timeBeginPeriod to enhance system timer resolution. This improves the quality of vertical sync, but consumes slightly more processing time. Both parameters attempt to synchronize vertically.

+
+ + bb172585 + D3DPRESENT + D3DPRESENT +
+ + + No documentation. + + + D3DPRESENT_BACK_BUFFERS_MAX + D3DPRESENT_BACK_BUFFERS_MAX + + + + No documentation. + + + D3DPRESENT_BACK_BUFFERS_MAX_EX + D3DPRESENT_BACK_BUFFERS_MAX_EX + + + + No documentation. + + + D3DPRESENT_DONOTWAIT + D3DPRESENT_DONOTWAIT + + + + No documentation. + + + D3DPRESENT_LINEAR_CONTENT + D3DPRESENT_LINEAR_CONTENT + + + + No documentation. + + + D3DPRESENT_DONOTFLIP + D3DPRESENT_DONOTFLIP + + + + No documentation. + + + D3DPRESENT_FLIPRESTART + D3DPRESENT_FLIPRESTART + + + + No documentation. + + + D3DPRESENT_VIDEO_RESTRICT_TO_MONITOR + D3DPRESENT_VIDEO_RESTRICT_TO_MONITOR + + + + No documentation. + + + D3DPRESENT_UPDATEOVERLAYONLY + D3DPRESENT_UPDATEOVERLAYONLY + + + + No documentation. + + + D3DPRESENT_HIDEOVERLAY + D3DPRESENT_HIDEOVERLAY + + + + No documentation. + + + D3DPRESENT_UPDATECOLORKEY + D3DPRESENT_UPDATECOLORKEY + + + + No documentation. + + + D3DPRESENT_FORCEIMMEDIATE + D3DPRESENT_FORCEIMMEDIATE + + + + No documentation. + + + D3DPRESENT_RATE_DEFAULT + D3DPRESENT_RATE_DEFAULT + + + + None. + + + None + None + + + +

Constants used by .

+
+ + bb172586 + D3DPRESENTFLAG + D3DPRESENTFLAG +
+ + + No documentation. + + + D3DPRESENTFLAG_LOCKABLE_BACKBUFFER + D3DPRESENTFLAG_LOCKABLE_BACKBUFFER + + + + No documentation. + + + D3DPRESENTFLAG_DISCARD_DEPTHSTENCIL + D3DPRESENTFLAG_DISCARD_DEPTHSTENCIL + + + + No documentation. + + + D3DPRESENTFLAG_DEVICECLIP + D3DPRESENTFLAG_DEVICECLIP + + + + No documentation. + + + D3DPRESENTFLAG_VIDEO + D3DPRESENTFLAG_VIDEO + + + + No documentation. + + + D3DPRESENTFLAG_NOAUTOROTATE + D3DPRESENTFLAG_NOAUTOROTATE + + + + No documentation. + + + D3DPRESENTFLAG_UNPRUNEDMODE + D3DPRESENTFLAG_UNPRUNEDMODE + + + + No documentation. + + + D3DPRESENTFLAG_OVERLAY_LIMITEDRGB + D3DPRESENTFLAG_OVERLAY_LIMITEDRGB + + + + No documentation. + + + D3DPRESENTFLAG_OVERLAY_YCbCr_BT709 + D3DPRESENTFLAG_OVERLAY_YCbCr_BT709 + + + + No documentation. + + + D3DPRESENTFLAG_OVERLAY_YCbCr_xvYCC + D3DPRESENTFLAG_OVERLAY_YCbCr_xvYCC + + + + No documentation. + + + D3DPRESENTFLAG_RESTRICTED_CONTENT + D3DPRESENTFLAG_RESTRICTED_CONTENT + + + + No documentation. + + + D3DPRESENTFLAG_RESTRICT_SHARED_RESOURCE_DRIVER + D3DPRESENTFLAG_RESTRICT_SHARED_RESOURCE_DRIVER + + + + None. + + + None + None + + + + No documentation. + + + D3DPRESENT_INTERVAL + D3DPRESENT_INTERVAL + + + + No documentation. + + + D3DPRESENT_INTERVAL_DEFAULT + D3DPRESENT_INTERVAL_DEFAULT + + + + No documentation. + + + D3DPRESENT_INTERVAL_ONE + D3DPRESENT_INTERVAL_ONE + + + + No documentation. + + + D3DPRESENT_INTERVAL_TWO + D3DPRESENT_INTERVAL_TWO + + + + No documentation. + + + D3DPRESENT_INTERVAL_THREE + D3DPRESENT_INTERVAL_THREE + + + + No documentation. + + + D3DPRESENT_INTERVAL_FOUR + D3DPRESENT_INTERVAL_FOUR + + + + No documentation. + + + D3DPRESENT_INTERVAL_IMMEDIATE + D3DPRESENT_INTERVAL_IMMEDIATE + + + +

Miscellaneous driver primitive capability flags.

+
+ + bb172583 + D3DPMISCCAPS + D3DPMISCCAPS +
+ + + No documentation. + + + D3DPMISCCAPS_MASKZ + D3DPMISCCAPS_MASKZ + + + + No documentation. + + + D3DPMISCCAPS_CULLNONE + D3DPMISCCAPS_CULLNONE + + + + No documentation. + + + D3DPMISCCAPS_CULLCW + D3DPMISCCAPS_CULLCW + + + + No documentation. + + + D3DPMISCCAPS_CULLCCW + D3DPMISCCAPS_CULLCCW + + + + No documentation. + + + D3DPMISCCAPS_COLORWRITEENABLE + D3DPMISCCAPS_COLORWRITEENABLE + + + + No documentation. + + + D3DPMISCCAPS_CLIPPLANESCALEDPOINTS + D3DPMISCCAPS_CLIPPLANESCALEDPOINTS + + + + No documentation. + + + D3DPMISCCAPS_CLIPTLVERTS + D3DPMISCCAPS_CLIPTLVERTS + + + + No documentation. + + + D3DPMISCCAPS_TSSARGTEMP + D3DPMISCCAPS_TSSARGTEMP + + + + No documentation. + + + D3DPMISCCAPS_BLENDOP + D3DPMISCCAPS_BLENDOP + + + + No documentation. + + + D3DPMISCCAPS_NULLREFERENCE + D3DPMISCCAPS_NULLREFERENCE + + + + No documentation. + + + D3DPMISCCAPS_INDEPENDENTWRITEMASKS + D3DPMISCCAPS_INDEPENDENTWRITEMASKS + + + + No documentation. + + + D3DPMISCCAPS_PERSTAGECONSTANT + D3DPMISCCAPS_PERSTAGECONSTANT + + + + No documentation. + + + D3DPMISCCAPS_FOGANDSPECULARALPHA + D3DPMISCCAPS_FOGANDSPECULARALPHA + + + + No documentation. + + + D3DPMISCCAPS_SEPARATEALPHABLEND + D3DPMISCCAPS_SEPARATEALPHABLEND + + + + No documentation. + + + D3DPMISCCAPS_MRTINDEPENDENTBITDEPTHS + D3DPMISCCAPS_MRTINDEPENDENTBITDEPTHS + + + + No documentation. + + + D3DPMISCCAPS_MRTPOSTPIXELSHADERBLENDING + D3DPMISCCAPS_MRTPOSTPIXELSHADERBLENDING + + + + No documentation. + + + D3DPMISCCAPS_FOGVERTEXCLAMPED + D3DPMISCCAPS_FOGVERTEXCLAMPED + + + + No documentation. + + + D3DPMISCCAPS_POSTBLENDSRGBCONVERT + D3DPMISCCAPS_POSTBLENDSRGBCONVERT + + + +

Defines the primitives supported by Direct3D.

+
+ +

Using Triangle Strips or Triangle Fans (Direct3D 9) is often more efficient than using triangle lists because fewer vertices are duplicated.

+
+ + bb172589 + D3DPRIMITIVETYPE + D3DPRIMITIVETYPE +
+ + +

Renders the vertices as a collection of isolated points. This value is unsupported for indexed primitives.

+
+ + bb172589 + D3DPT_POINTLIST + D3DPT_POINTLIST +
+ + +

Renders the vertices as a list of isolated straight line segments.

+
+ + bb172589 + D3DPT_LINELIST + D3DPT_LINELIST +
+ + +

Renders the vertices as a single polyline.

+
+ + bb172589 + D3DPT_LINESTRIP + D3DPT_LINESTRIP +
+ + +

Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.

Back-face culling is affected by the current winding-order render state.

+
+ + bb172589 + D3DPT_TRIANGLELIST + D3DPT_TRIANGLELIST +
+ + +

Renders the vertices as a triangle strip. The backface-culling flag is automatically flipped on even-numbered triangles.

+
+ + bb172589 + D3DPT_TRIANGLESTRIP + D3DPT_TRIANGLESTRIP +
+ + +

Renders the vertices as a triangle fan.

+
+ + bb172589 + D3DPT_TRIANGLEFAN + D3DPT_TRIANGLEFAN +
+ + +

Identifies the query type. For information about queries, see Queries (Direct3D 9)

+
+ + bb172594 + D3DQUERYTYPE + D3DQUERYTYPE +
+ + + No documentation. + + + D3DQUERYTYPE_VCACHE + D3DQUERYTYPE_VCACHE + + + + No documentation. + + + D3DQUERYTYPE_RESOURCEMANAGER + D3DQUERYTYPE_RESOURCEMANAGER + + + + No documentation. + + + D3DQUERYTYPE_VERTEXSTATS + D3DQUERYTYPE_VERTEXSTATS + + + + No documentation. + + + D3DQUERYTYPE_EVENT + D3DQUERYTYPE_EVENT + + + + No documentation. + + + D3DQUERYTYPE_OCCLUSION + D3DQUERYTYPE_OCCLUSION + + + + No documentation. + + + D3DQUERYTYPE_TIMESTAMP + D3DQUERYTYPE_TIMESTAMP + + + + No documentation. + + + D3DQUERYTYPE_TIMESTAMPDISJOINT + D3DQUERYTYPE_TIMESTAMPDISJOINT + + + + No documentation. + + + D3DQUERYTYPE_TIMESTAMPFREQ + D3DQUERYTYPE_TIMESTAMPFREQ + + + + No documentation. + + + D3DQUERYTYPE_PIPELINETIMINGS + D3DQUERYTYPE_PIPELINETIMINGS + + + + No documentation. + + + D3DQUERYTYPE_INTERFACETIMINGS + D3DQUERYTYPE_INTERFACETIMINGS + + + + No documentation. + + + D3DQUERYTYPE_VERTEXTIMINGS + D3DQUERYTYPE_VERTEXTIMINGS + + + + No documentation. + + + D3DQUERYTYPE_PIXELTIMINGS + D3DQUERYTYPE_PIXELTIMINGS + + + + No documentation. + + + D3DQUERYTYPE_BANDWIDTHTIMINGS + D3DQUERYTYPE_BANDWIDTHTIMINGS + + + + No documentation. + + + D3DQUERYTYPE_CACHEUTILIZATION + D3DQUERYTYPE_CACHEUTILIZATION + + + + No documentation. + + + D3DQUERYTYPE_MEMORYPRESSURE + D3DQUERYTYPE_MEMORYPRESSURE + + + + No documentation. + + + D3DPRASTERCAPS + D3DPRASTERCAPS + + + + No documentation. + + + D3DPRASTERCAPS_DITHER + D3DPRASTERCAPS_DITHER + + + + No documentation. + + + D3DPRASTERCAPS_ZTEST + D3DPRASTERCAPS_ZTEST + + + + No documentation. + + + D3DPRASTERCAPS_FOGVERTEX + D3DPRASTERCAPS_FOGVERTEX + + + + No documentation. + + + D3DPRASTERCAPS_FOGTABLE + D3DPRASTERCAPS_FOGTABLE + + + + No documentation. + + + D3DPRASTERCAPS_MIPMAPLODBIAS + D3DPRASTERCAPS_MIPMAPLODBIAS + + + + No documentation. + + + D3DPRASTERCAPS_ZBUFFERLESSHSR + D3DPRASTERCAPS_ZBUFFERLESSHSR + + + + No documentation. + + + D3DPRASTERCAPS_FOGRANGE + D3DPRASTERCAPS_FOGRANGE + + + + No documentation. + + + D3DPRASTERCAPS_ANISOTROPY + D3DPRASTERCAPS_ANISOTROPY + + + + No documentation. + + + D3DPRASTERCAPS_WBUFFER + D3DPRASTERCAPS_WBUFFER + + + + No documentation. + + + D3DPRASTERCAPS_WFOG + D3DPRASTERCAPS_WFOG + + + + No documentation. + + + D3DPRASTERCAPS_ZFOG + D3DPRASTERCAPS_ZFOG + + + + No documentation. + + + D3DPRASTERCAPS_COLORPERSPECTIVE + D3DPRASTERCAPS_COLORPERSPECTIVE + + + + No documentation. + + + D3DPRASTERCAPS_SCISSORTEST + D3DPRASTERCAPS_SCISSORTEST + + + + No documentation. + + + D3DPRASTERCAPS_SLOPESCALEDEPTHBIAS + D3DPRASTERCAPS_SLOPESCALEDEPTHBIAS + + + + No documentation. + + + D3DPRASTERCAPS_DEPTHBIAS + D3DPRASTERCAPS_DEPTHBIAS + + + + No documentation. + + + D3DPRASTERCAPS_MULTISAMPLE_TOGGLE + D3DPRASTERCAPS_MULTISAMPLE_TOGGLE + + + +

Data type of the register.

+
+ + bb205424 + D3DXREGISTER_SET + D3DXREGISTER_SET +
+ + +

Boolean value.

+
+ + bb205424 + D3DXRS_BOOL + D3DXRS_BOOL +
+ + +

4D integer number.

+
+ + bb205424 + D3DXRS_INT4 + D3DXRS_INT4 +
+ + +

4D floating-point number.

+
+ + bb205424 + D3DXRS_FLOAT4 + D3DXRS_FLOAT4 +
+ + +

The register contains 4D sampler data.

+
+ + bb205424 + D3DXRS_SAMPLER + D3DXRS_SAMPLER +
+ + +

The enumerated type lists a variety of attributes, or render states. The enumerators of that are used exclusively by drivers can specify either rendering information or a texture attribute. The following render states are used by display drivers:

#define D3DRENDERSTATE_EVICTMANAGEDTEXTURES  61	
+            #define D3DRENDERSTATE_SCENECAPTURE          62	
+            #define D3DRS_DELETERTPATCH                  169	
+            #define D3DRS_MAXVERTEXSHADERINST            196	
+            #define D3DRS_MAXPIXELSHADERINST             197

Enumerators

D3DRENDERSTATE_EVICTMANAGEDTEXTURES

Determines whether textures are evicted from memory. + The driver uses a data type without a default value to detect whether to evict.

This render state determines whether the driver evicts textures that it manages (as opposed to textures managed by the Direct3D runtime) from video memory. If the render state value is TRUE, the driver evicts the textures. Otherwise, the driver does not evict those textures.

D3DRENDERSTATE_SCENECAPTURE

Specifies either begin scene information or end scene information for geometric data captured within a frame. + The driver uses a data type with a default value of TRUE to detect scene-capture information.

The driver responds to D3DRENDERSTATE_SCENECAPTURE first with TRUE for begin scene information and next with for end scene information to capture geometric data within a frame. + See the permedia2 sample driver that ships with the Windows Driver Development Kit (DDK) for an example implementation. + Using the D3DRENDERSTATE_SCENECAPTURE render state in a D3dDrawPrimitives2 call replaces the legacy D3DHALCallbacks->D3dSceneCapture callback routine.

Care must be taken in updating a driver that implements the legacy D3DHALCallbacks->D3dSceneCapture callback routine to one using the D3DRENDERSTATE_SCENECAPTURE render state. The D3dSceneCapture callback routine uses the constants D3DHAL_SCENE_CAPTURE_START and D3DHAL_SCENE_CAPTURE_END to indicate, respectively, the beginning and end of a scene. The values of these constants are, respectively, 0 and 1. If you use these constants in place of TRUE and in this render state, the meaning will be the exact opposite of what you intend.

D3DRS_DELETERTPATCH

DirectX 8.0 and later versions only.

Deletes either a rectangular or triangular patch from memory. + The driver uses a DWORD data type without a default value to detect the patch to delete.

This render state notifies the driver that a patch is to be deleted. The value of this render state is the handle to the patch affected. All cached information should be freed and the handle should be removed from the driver's patch handle table. This render state is not visible to applications but is generated internally when an application calls the DeletePatch function. This render state is sent to the driver only when patches are deleted by DeletePatch explicitly. All other patches should be cleaned up when the device is destroyed.

D3DRS_MAXVERTEXSHADERINST

DirectX 9.0 and later versions only.

Determines the maximum number of instructions that the vertex shader assembler can execute.

The driver uses a DWORD data type with a default value of D3DINFINITEINSTRUCTIONS (0xffffffff) to report the maximum number of vertex-shader instructions. + This maximum number depends on the version of the vertex shader that the display device supports as shown in the following table.

VersionMaximum number
earlier than 2_00
2_0 and laterFrom 216 (0x0000ffff) to D3DINFINITEINSTRUCTIONS

?

D3DINFINITEINSTRUCTIONS represents a virtually unlimited amount.

Valid values for this render state are numbers that are powers of 2; if the driver sets any other integer, the runtime uses the next nearest power of 2 number.

The runtime sets the MaxVShaderInstructionsExecuted member of the structure to this maximum number.

D3DRS_MAXPIXELSHADERINST

DirectX 9.0 and later versions only.

Determines the maximum number of instructions that the pixel shader assembler can execute.

The driver uses a DWORD data type with a default value of D3DINFINITEINSTRUCTIONS (0xffffffff) to report the maximum number of pixel-shader instructions. + This maximum number depends on the version of the pixel shader that the display device supports as shown in the following table.

VersionMaximum number
earlier than 2_00
2_0From 96 to D3DINFINITEINSTRUCTIONS
3_0 and laterFrom 216 (0x0000ffff) to D3DINFINITEINSTRUCTIONS

?

D3DINFINITEINSTRUCTIONS represents a virtually unlimited amount.

Valid values for this render state are numbers that are powers of 2; if the driver sets any other integer, the runtime uses the next nearest power of 2 number.

The runtime sets the MaxVShaderInstructionsExecuted member of the structure to this maximum number.

+
+ +

The driver uses these render states when it performs graphics rendering. Only render states that are specific to drivers are included in the Windows Driver Kit (WDK) documentation. The render states accessible to DirectX applications are included in the DirectX SDK documentation. These application-level render states include such characteristics as whether alpha blending is enabled, whether dithering is enabled, whether Direct3D lighting is used, and the type of shading to be used.

To update a particular render state, Direct3D stores information about the render state, and then calls the driver's D3dDrawPrimitives2 callback routine. The information provided to the driver enables it to:

  • Determine that it should update one or more render states.

  • Identify which render states to update, and what the new render state values should be.

Note that for certain render states to be honored, the driver must have previously set capability flags in the relevant member of the D3DPRIMCAPS structure.

In order to indicate a specific render state update, Direct3D inserts a D3DHAL_DP2COMMAND structure into the command buffer, setting the bCommand member of this structure to D3DDP2OP_RENDERSTATE (see the description for D3DDP2OP_RENDERSTATE in D3DHAL_DP2OPERATION), and setting the wStateCount member of the same structure to the number of render states to be updated.

Immediately following the D3DHAL_DP2COMMAND structure, Direct3D inserts one D3DHAL_DP2RENDERSTATE structure into the command buffer for each render state to be updated. The RenderState member of this structure identifies the render state to be changed; the new value of this render state is specified in either the dwState member (for DWORD values) or the fState member (for D3DVALUE values).

The following figure shows a portion of the command buffer containing a D3DDP2OP_RENDERSTATE command and two D3DHAL_DP2RENDERSTATE structures. The first of the three structures indicates that two render states are to be updated. The second structure indicates that the D3DRENDERSTATE_FILLMODE render state is to be changed to . The third structure indicates that the D3DRENDERSTATE_SHADEMODE render state should be updated to .

Additional Notes

See the , , and D3DTEXTUREFILTER enumerated types in the DirectX SDK documentation for complete listings of all of the enabled render state types.

Some changes have been made to the enumerated type for DirectX 5.0 and beyond. D3DRENDERSTATE_BLENDENABLE has been removed completely although it is defined as D3DRENDERSTATE_ALPHABLENDENABLE in the d3dtypes.h header file. See D3DRENDERSTATE_COLORKEYENABLE for an explanation. The 128 integer values in the interval [128, 255] are reserved for texture coordinate wrap flags. These are constructed with the D3DWRAP_U and D3DWRAP_V macros. Using a flags word preserves forward compatibility with texture coordinates of higher dimension than 2D.

Multitexture macro ops and D3DRENDERSTATE_TEXTUREFACTOR override all of the per-texture stage blending controls (COLOR{OP,ARG1,ARG2} & ALPHA{OP,ARG1,ARG2}).

+
+ + ff549036 + D3DRENDERSTATETYPE + D3DRENDERSTATETYPE +
+ + +

Determines whether textures are evicted from memory. + The driver uses a data type without a default value to detect whether to evict.

This render state determines whether the driver evicts textures that it manages (as opposed to textures managed by the Direct3D runtime) from video memory. If the render state value is TRUE, the driver evicts the textures. Otherwise, the driver does not evict those textures.

+
+ + ff549036 + D3DRS_ZENABLE + D3DRS_ZENABLE +
+ + +

Specifies either begin scene information or end scene information for geometric data captured within a frame. + The driver uses a data type with a default value of TRUE to detect scene-capture information.

The driver responds to D3DRENDERSTATE_SCENECAPTURE first with TRUE for begin scene information and next with for end scene information to capture geometric data within a frame. + See the permedia2 sample driver that ships with the Windows Driver Development Kit (DDK) for an example implementation. + Using the D3DRENDERSTATE_SCENECAPTURE render state in a D3dDrawPrimitives2 call replaces the legacy D3DHALCallbacks->D3dSceneCapture callback routine.

Care must be taken in updating a driver that implements the legacy D3DHALCallbacks->D3dSceneCapture callback routine to one using the D3DRENDERSTATE_SCENECAPTURE render state. The D3dSceneCapture callback routine uses the constants D3DHAL_SCENE_CAPTURE_START and D3DHAL_SCENE_CAPTURE_END to indicate, respectively, the beginning and end of a scene. The values of these constants are, respectively, 0 and 1. If you use these constants in place of TRUE and in this render state, the meaning will be the exact opposite of what you intend.

+
+ + ff549036 + D3DRS_FILLMODE + D3DRS_FILLMODE +
+ + +

DirectX 8.0 and later versions only.

Deletes either a rectangular or triangular patch from memory. + The driver uses a DWORD data type without a default value to detect the patch to delete.

This render state notifies the driver that a patch is to be deleted. The value of this render state is the handle to the patch affected. All cached information should be freed and the handle should be removed from the driver's patch handle table. This render state is not visible to applications but is generated internally when an application calls the DeletePatch function. This render state is sent to the driver only when patches are deleted by DeletePatch explicitly. All other patches should be cleaned up when the device is destroyed.

+
+ + ff549036 + D3DRS_SHADEMODE + D3DRS_SHADEMODE +
+ + +

DirectX 9.0 and later versions only.

Determines the maximum number of instructions that the vertex shader assembler can execute.

The driver uses a DWORD data type with a default value of D3DINFINITEINSTRUCTIONS (0xffffffff) to report the maximum number of vertex-shader instructions. + This maximum number depends on the version of the vertex shader that the display device supports as shown in the following table.

VersionMaximum number
earlier than 2_00
2_0 and laterFrom 216 (0x0000ffff) to D3DINFINITEINSTRUCTIONS

?

D3DINFINITEINSTRUCTIONS represents a virtually unlimited amount.

Valid values for this render state are numbers that are powers of 2; if the driver sets any other integer, the runtime uses the next nearest power of 2 number.

The runtime sets the MaxVShaderInstructionsExecuted member of the structure to this maximum number.

+
+ + ff549036 + D3DRS_ZWRITEENABLE + D3DRS_ZWRITEENABLE +
+ + +

DirectX 9.0 and later versions only.

Determines the maximum number of instructions that the pixel shader assembler can execute.

The driver uses a DWORD data type with a default value of D3DINFINITEINSTRUCTIONS (0xffffffff) to report the maximum number of pixel-shader instructions. + This maximum number depends on the version of the pixel shader that the display device supports as shown in the following table.

VersionMaximum number
earlier than 2_00
2_0From 96 to D3DINFINITEINSTRUCTIONS
3_0 and laterFrom 216 (0x0000ffff) to D3DINFINITEINSTRUCTIONS

?

D3DINFINITEINSTRUCTIONS represents a virtually unlimited amount.

Valid values for this render state are numbers that are powers of 2; if the driver sets any other integer, the runtime uses the next nearest power of 2 number.

The runtime sets the MaxVShaderInstructionsExecuted member of the structure to this maximum number.

+
+ + ff549036 + D3DRS_ALPHATESTENABLE + D3DRS_ALPHATESTENABLE +
+ + + No documentation. + + + D3DRS_LASTPIXEL + D3DRS_LASTPIXEL + + + + No documentation. + + + D3DRS_SRCBLEND + D3DRS_SRCBLEND + + + + No documentation. + + + D3DRS_DESTBLEND + D3DRS_DESTBLEND + + + + No documentation. + + + D3DRS_CULLMODE + D3DRS_CULLMODE + + + + No documentation. + + + D3DRS_ZFUNC + D3DRS_ZFUNC + + + + No documentation. + + + D3DRS_ALPHAREF + D3DRS_ALPHAREF + + + + No documentation. + + + D3DRS_ALPHAFUNC + D3DRS_ALPHAFUNC + + + + No documentation. + + + D3DRS_DITHERENABLE + D3DRS_DITHERENABLE + + + + No documentation. + + + D3DRS_ALPHABLENDENABLE + D3DRS_ALPHABLENDENABLE + + + + No documentation. + + + D3DRS_FOGENABLE + D3DRS_FOGENABLE + + + + No documentation. + + + D3DRS_SPECULARENABLE + D3DRS_SPECULARENABLE + + + + No documentation. + + + D3DRS_FOGCOLOR + D3DRS_FOGCOLOR + + + + No documentation. + + + D3DRS_FOGTABLEMODE + D3DRS_FOGTABLEMODE + + + + No documentation. + + + D3DRS_FOGSTART + D3DRS_FOGSTART + + + + No documentation. + + + D3DRS_FOGEND + D3DRS_FOGEND + + + + No documentation. + + + D3DRS_FOGDENSITY + D3DRS_FOGDENSITY + + + + No documentation. + + + D3DRS_RANGEFOGENABLE + D3DRS_RANGEFOGENABLE + + + + No documentation. + + + D3DRS_STENCILENABLE + D3DRS_STENCILENABLE + + + + No documentation. + + + D3DRS_STENCILFAIL + D3DRS_STENCILFAIL + + + + No documentation. + + + D3DRS_STENCILZFAIL + D3DRS_STENCILZFAIL + + + + No documentation. + + + D3DRS_STENCILPASS + D3DRS_STENCILPASS + + + + No documentation. + + + D3DRS_STENCILFUNC + D3DRS_STENCILFUNC + + + + No documentation. + + + D3DRS_STENCILREF + D3DRS_STENCILREF + + + + No documentation. + + + D3DRS_STENCILMASK + D3DRS_STENCILMASK + + + + No documentation. + + + D3DRS_STENCILWRITEMASK + D3DRS_STENCILWRITEMASK + + + + No documentation. + + + D3DRS_TEXTUREFACTOR + D3DRS_TEXTUREFACTOR + + + + No documentation. + + + D3DRS_WRAP0 + D3DRS_WRAP0 + + + + No documentation. + + + D3DRS_WRAP1 + D3DRS_WRAP1 + + + + No documentation. + + + D3DRS_WRAP2 + D3DRS_WRAP2 + + + + No documentation. + + + D3DRS_WRAP3 + D3DRS_WRAP3 + + + + No documentation. + + + D3DRS_WRAP4 + D3DRS_WRAP4 + + + + No documentation. + + + D3DRS_WRAP5 + D3DRS_WRAP5 + + + + No documentation. + + + D3DRS_WRAP6 + D3DRS_WRAP6 + + + + No documentation. + + + D3DRS_WRAP7 + D3DRS_WRAP7 + + + + No documentation. + + + D3DRS_CLIPPING + D3DRS_CLIPPING + + + + No documentation. + + + D3DRS_LIGHTING + D3DRS_LIGHTING + + + + No documentation. + + + D3DRS_AMBIENT + D3DRS_AMBIENT + + + + No documentation. + + + D3DRS_FOGVERTEXMODE + D3DRS_FOGVERTEXMODE + + + + No documentation. + + + D3DRS_COLORVERTEX + D3DRS_COLORVERTEX + + + + No documentation. + + + D3DRS_LOCALVIEWER + D3DRS_LOCALVIEWER + + + + No documentation. + + + D3DRS_NORMALIZENORMALS + D3DRS_NORMALIZENORMALS + + + + No documentation. + + + D3DRS_DIFFUSEMATERIALSOURCE + D3DRS_DIFFUSEMATERIALSOURCE + + + + No documentation. + + + D3DRS_SPECULARMATERIALSOURCE + D3DRS_SPECULARMATERIALSOURCE + + + + No documentation. + + + D3DRS_AMBIENTMATERIALSOURCE + D3DRS_AMBIENTMATERIALSOURCE + + + + No documentation. + + + D3DRS_EMISSIVEMATERIALSOURCE + D3DRS_EMISSIVEMATERIALSOURCE + + + + No documentation. + + + D3DRS_VERTEXBLEND + D3DRS_VERTEXBLEND + + + + No documentation. + + + D3DRS_CLIPPLANEENABLE + D3DRS_CLIPPLANEENABLE + + + + No documentation. + + + D3DRS_POINTSIZE + D3DRS_POINTSIZE + + + + No documentation. + + + D3DRS_POINTSIZE_MIN + D3DRS_POINTSIZE_MIN + + + + No documentation. + + + D3DRS_POINTSPRITEENABLE + D3DRS_POINTSPRITEENABLE + + + + No documentation. + + + D3DRS_POINTSCALEENABLE + D3DRS_POINTSCALEENABLE + + + + No documentation. + + + D3DRS_POINTSCALE_A + D3DRS_POINTSCALE_A + + + + No documentation. + + + D3DRS_POINTSCALE_B + D3DRS_POINTSCALE_B + + + + No documentation. + + + D3DRS_POINTSCALE_C + D3DRS_POINTSCALE_C + + + + No documentation. + + + D3DRS_MULTISAMPLEANTIALIAS + D3DRS_MULTISAMPLEANTIALIAS + + + + No documentation. + + + D3DRS_MULTISAMPLEMASK + D3DRS_MULTISAMPLEMASK + + + + No documentation. + + + D3DRS_PATCHEDGESTYLE + D3DRS_PATCHEDGESTYLE + + + + No documentation. + + + D3DRS_DEBUGMONITORTOKEN + D3DRS_DEBUGMONITORTOKEN + + + + No documentation. + + + D3DRS_POINTSIZE_MAX + D3DRS_POINTSIZE_MAX + + + + No documentation. + + + D3DRS_INDEXEDVERTEXBLENDENABLE + D3DRS_INDEXEDVERTEXBLENDENABLE + + + + No documentation. + + + D3DRS_COLORWRITEENABLE + D3DRS_COLORWRITEENABLE + + + + No documentation. + + + D3DRS_TWEENFACTOR + D3DRS_TWEENFACTOR + + + + No documentation. + + + D3DRS_BLENDOP + D3DRS_BLENDOP + + + + No documentation. + + + D3DRS_POSITIONDEGREE + D3DRS_POSITIONDEGREE + + + + No documentation. + + + D3DRS_NORMALDEGREE + D3DRS_NORMALDEGREE + + + + No documentation. + + + D3DRS_SCISSORTESTENABLE + D3DRS_SCISSORTESTENABLE + + + + No documentation. + + + D3DRS_SLOPESCALEDEPTHBIAS + D3DRS_SLOPESCALEDEPTHBIAS + + + + No documentation. + + + D3DRS_ANTIALIASEDLINEENABLE + D3DRS_ANTIALIASEDLINEENABLE + + + + No documentation. + + + D3DRS_MINTESSELLATIONLEVEL + D3DRS_MINTESSELLATIONLEVEL + + + + No documentation. + + + D3DRS_MAXTESSELLATIONLEVEL + D3DRS_MAXTESSELLATIONLEVEL + + + + No documentation. + + + D3DRS_ADAPTIVETESS_X + D3DRS_ADAPTIVETESS_X + + + + No documentation. + + + D3DRS_ADAPTIVETESS_Y + D3DRS_ADAPTIVETESS_Y + + + + No documentation. + + + D3DRS_ADAPTIVETESS_Z + D3DRS_ADAPTIVETESS_Z + + + + No documentation. + + + D3DRS_ADAPTIVETESS_W + D3DRS_ADAPTIVETESS_W + + + + No documentation. + + + D3DRS_ENABLEADAPTIVETESSELLATION + D3DRS_ENABLEADAPTIVETESSELLATION + + + + No documentation. + + + D3DRS_TWOSIDEDSTENCILMODE + D3DRS_TWOSIDEDSTENCILMODE + + + + No documentation. + + + D3DRS_CCW_STENCILFAIL + D3DRS_CCW_STENCILFAIL + + + + No documentation. + + + D3DRS_CCW_STENCILZFAIL + D3DRS_CCW_STENCILZFAIL + + + + No documentation. + + + D3DRS_CCW_STENCILPASS + D3DRS_CCW_STENCILPASS + + + + No documentation. + + + D3DRS_CCW_STENCILFUNC + D3DRS_CCW_STENCILFUNC + + + + No documentation. + + + D3DRS_COLORWRITEENABLE1 + D3DRS_COLORWRITEENABLE1 + + + + No documentation. + + + D3DRS_COLORWRITEENABLE2 + D3DRS_COLORWRITEENABLE2 + + + + No documentation. + + + D3DRS_COLORWRITEENABLE3 + D3DRS_COLORWRITEENABLE3 + + + + No documentation. + + + D3DRS_BLENDFACTOR + D3DRS_BLENDFACTOR + + + + No documentation. + + + D3DRS_SRGBWRITEENABLE + D3DRS_SRGBWRITEENABLE + + + + No documentation. + + + D3DRS_DEPTHBIAS + D3DRS_DEPTHBIAS + + + + No documentation. + + + D3DRS_WRAP8 + D3DRS_WRAP8 + + + + No documentation. + + + D3DRS_WRAP9 + D3DRS_WRAP9 + + + + No documentation. + + + D3DRS_WRAP10 + D3DRS_WRAP10 + + + + No documentation. + + + D3DRS_WRAP11 + D3DRS_WRAP11 + + + + No documentation. + + + D3DRS_WRAP12 + D3DRS_WRAP12 + + + + No documentation. + + + D3DRS_WRAP13 + D3DRS_WRAP13 + + + + No documentation. + + + D3DRS_WRAP14 + D3DRS_WRAP14 + + + + No documentation. + + + D3DRS_WRAP15 + D3DRS_WRAP15 + + + + No documentation. + + + D3DRS_SEPARATEALPHABLENDENABLE + D3DRS_SEPARATEALPHABLENDENABLE + + + + No documentation. + + + D3DRS_SRCBLENDALPHA + D3DRS_SRCBLENDALPHA + + + + No documentation. + + + D3DRS_DESTBLENDALPHA + D3DRS_DESTBLENDALPHA + + + + No documentation. + + + D3DRS_BLENDOPALPHA + D3DRS_BLENDOPALPHA + + + + No documentation. + + + D3DX_RESOURCE_RESIDENCY + D3DX_RESOURCE_RESIDENCY + + + + No documentation. + + + D3DX_RESOURCE_RESIDENCY_RESIDENT + D3DX_RESOURCE_RESIDENCY_RESIDENT + + + + No documentation. + + + D3DX_RESOURCE_RESIDENCY_RESIDENT_IN_SHARED_MEMORY + D3DX_RESOURCE_RESIDENCY_RESIDENT_IN_SHARED_MEMORY + + + + No documentation. + + + D3DX_RESOURCE_RESIDENCY_NOT_RESIDENT + D3DX_RESOURCE_RESIDENCY_NOT_RESIDENT + + + + No documentation. + + + D3DRESOURCETYPE + D3DRESOURCETYPE + + + + No documentation. + + + D3DRTYPE_SURFACE + D3DRTYPE_SURFACE + + + + No documentation. + + + D3DRTYPE_VOLUME + D3DRTYPE_VOLUME + + + + No documentation. + + + D3DRTYPE_TEXTURE + D3DRTYPE_TEXTURE + + + + No documentation. + + + D3DRTYPE_VOLUMETEXTURE + D3DRTYPE_VOLUMETEXTURE + + + + No documentation. + + + D3DRTYPE_CUBETEXTURE + D3DRTYPE_CUBETEXTURE + + + + No documentation. + + + D3DRTYPE_VERTEXBUFFER + D3DRTYPE_VERTEXBUFFER + + + + No documentation. + + + D3DRTYPE_INDEXBUFFER + D3DRTYPE_INDEXBUFFER + + + +

Sampler states define texture sampling operations such as texture addressing and texture filtering. Some sampler states set-up vertex processing, and some set-up pixel processing. Sampler states can be saved and restored using stateblocks (see State Blocks Save and Restore State (Direct3D 9)).

+
+ + bb172602 + D3DSAMPLERSTATETYPE + D3DSAMPLERSTATETYPE +
+ + + No documentation. + + + D3DSAMP_ADDRESSU + D3DSAMP_ADDRESSU + + + + No documentation. + + + D3DSAMP_ADDRESSV + D3DSAMP_ADDRESSV + + + + No documentation. + + + D3DSAMP_ADDRESSW + D3DSAMP_ADDRESSW + + + + No documentation. + + + D3DSAMP_BORDERCOLOR + D3DSAMP_BORDERCOLOR + + + + No documentation. + + + D3DSAMP_MAGFILTER + D3DSAMP_MAGFILTER + + + + No documentation. + + + D3DSAMP_MINFILTER + D3DSAMP_MINFILTER + + + + No documentation. + + + D3DSAMP_MIPFILTER + D3DSAMP_MIPFILTER + + + + No documentation. + + + D3DSAMP_MIPMAPLODBIAS + D3DSAMP_MIPMAPLODBIAS + + + + No documentation. + + + D3DSAMP_MAXMIPLEVEL + D3DSAMP_MAXMIPLEVEL + + + + No documentation. + + + D3DSAMP_MAXANISOTROPY + D3DSAMP_MAXANISOTROPY + + + + No documentation. + + + D3DSAMP_SRGBTEXTURE + D3DSAMP_SRGBTEXTURE + + + + No documentation. + + + D3DSAMP_ELEMENTINDEX + D3DSAMP_ELEMENTINDEX + + + + No documentation. + + + D3DSAMP_DMAPOFFSET + D3DSAMP_DMAPOFFSET + + + +

Defines the sampler texture types for vertex shaders.

+
+ + bb172603 + D3DSAMPLER_TEXTURE_TYPE + D3DSAMPLER_TEXTURE_TYPE +
+ + +

Uninitialized value. The value of this element is D3DSP_TEXTURETYPE_SHIFT.

+
+ + bb172603 + D3DSTT_UNKNOWN + D3DSTT_UNKNOWN +
+ + +

Declaring a 2D texture. The value of this element is D3DSP_TEXTURETYPE_SHIFT * 4.

+
+ + bb172603 + D3DSTT_2D + D3DSTT_2D +
+ + +

Declaring a cube texture. The value of this element is D3DSP_TEXTURETYPE_SHIFT * 8.

+
+ + bb172603 + D3DSTT_CUBE + D3DSTT_CUBE +
+ + +

Declaring a volume texture. The value of this element is D3DSP_TEXTURETYPE_SHIFT * 16.

+
+ + bb172603 + D3DSTT_VOLUME + D3DSTT_VOLUME +
+ + +

Flags indicating the method the rasterizer uses to create an image on a surface.

+
+ +

This enumeration is used as a member in and .

+
+ + bb172604 + D3DSCANLINEORDERING + D3DSCANLINEORDERING +
+ + +

The image is created from the first scanline to the last without skipping any.

+
+ + bb172604 + D3DSCANLINEORDERING_UNKNOWN + D3DSCANLINEORDERING_UNKNOWN +
+ + +

The image is created using the interlaced method in which odd-numbered lines are drawn on odd-numbered passes and even lines are drawn on even-numbered passes.

+
+ + bb172604 + D3DSCANLINEORDERING_PROGRESSIVE + D3DSCANLINEORDERING_PROGRESSIVE +
+ + + No documentation. + + + D3DSCANLINEORDERING_INTERLACED + D3DSCANLINEORDERING_INTERLACED + + + + No documentation. + + + D3DPSHADECAPS + D3DPSHADECAPS + + + + No documentation. + + + D3DPSHADECAPS_COLORGOURAUDRGB + D3DPSHADECAPS_COLORGOURAUDRGB + + + + No documentation. + + + D3DPSHADECAPS_SPECULARGOURAUDRGB + D3DPSHADECAPS_SPECULARGOURAUDRGB + + + + No documentation. + + + D3DPSHADECAPS_ALPHAGOURAUDBLEND + D3DPSHADECAPS_ALPHAGOURAUDBLEND + + + + No documentation. + + + D3DPSHADECAPS_FOGGOURAUD + D3DPSHADECAPS_FOGGOURAUD + + + + No documentation. + + + D3DSHADEMODE + D3DSHADEMODE + + + + No documentation. + + + D3DSHADE_FLAT + D3DSHADE_FLAT + + + + No documentation. + + + D3DSHADE_GOURAUD + D3DSHADE_GOURAUD + + + + No documentation. + + + D3DSHADE_PHONG + D3DSHADE_PHONG + + + +

The following flags are used for parsing, compiling, or assembling shaders:

  • Parser
  • Compiler
  • Assembler
  • Remarks
+
+ +

Applying Compiler or Assembler to the incorrect API will fail shader validation. Check the Direct3D error code return value from the function (with the DirectX Error Lookup Tool) to help track down this error.

+
+ + bb205441 + D3DXSHADER + D3DXSHADER +
+ + + No documentation. + + + D3DXSHADER_DEBUG + D3DXSHADER_DEBUG + + + + No documentation. + + + D3DXSHADER_SKIPVALIDATION + D3DXSHADER_SKIPVALIDATION + + + + No documentation. + + + D3DXSHADER_SKIPOPTIMIZATION + D3DXSHADER_SKIPOPTIMIZATION + + + + No documentation. + + + D3DXSHADER_PACKMATRIX_ROWMAJOR + D3DXSHADER_PACKMATRIX_ROWMAJOR + + + + No documentation. + + + D3DXSHADER_PACKMATRIX_COLUMNMAJOR + D3DXSHADER_PACKMATRIX_COLUMNMAJOR + + + + No documentation. + + + D3DXSHADER_PARTIALPRECISION + D3DXSHADER_PARTIALPRECISION + + + + No documentation. + + + D3DXSHADER_FORCE_VS_SOFTWARE_NOOPT + D3DXSHADER_FORCE_VS_SOFTWARE_NOOPT + + + + No documentation. + + + D3DXSHADER_FORCE_PS_SOFTWARE_NOOPT + D3DXSHADER_FORCE_PS_SOFTWARE_NOOPT + + + + No documentation. + + + D3DXSHADER_NO_PRESHADER + D3DXSHADER_NO_PRESHADER + + + + No documentation. + + + D3DXSHADER_AVOID_FLOW_CONTROL + D3DXSHADER_AVOID_FLOW_CONTROL + + + + No documentation. + + + D3DXSHADER_PREFER_FLOW_CONTROL + D3DXSHADER_PREFER_FLOW_CONTROL + + + + No documentation. + + + D3DXSHADER_ENABLE_BACKWARDS_COMPATIBILITY + D3DXSHADER_ENABLE_BACKWARDS_COMPATIBILITY + + + + No documentation. + + + D3DXSHADER_IEEE_STRICTNESS + D3DXSHADER_IEEE_STRICTNESS + + + + No documentation. + + + D3DXSHADER_USE_LEGACY_D3DX9_31_DLL + D3DXSHADER_USE_LEGACY_D3DX9_31_DLL + + + + No documentation. + + + D3DXSHADER_OPTIMIZATION_LEVEL0 + D3DXSHADER_OPTIMIZATION_LEVEL0 + + + + No documentation. + + + D3DXSHADER_OPTIMIZATION_LEVEL1 + D3DXSHADER_OPTIMIZATION_LEVEL1 + + + + No documentation. + + + D3DXSHADER_OPTIMIZATION_LEVEL2 + D3DXSHADER_OPTIMIZATION_LEVEL2 + + + + No documentation. + + + D3DXSHADER_OPTIMIZATION_LEVEL3 + D3DXSHADER_OPTIMIZATION_LEVEL3 + + + + None. + + + None + None + + + +

The following flags are used to specify sprite rendering options to the flags parameter in the Begin method:

+
+ + bb205466 + D3DXSPRITE + D3DXSPRITE +
+ + + No documentation. + + + D3DXSPRITE_DONOTSAVESTATE + D3DXSPRITE_DONOTSAVESTATE + + + + No documentation. + + + D3DXSPRITE_DONOTMODIFY_RENDERSTATE + D3DXSPRITE_DONOTMODIFY_RENDERSTATE + + + + No documentation. + + + D3DXSPRITE_OBJECTSPACE + D3DXSPRITE_OBJECTSPACE + + + + No documentation. + + + D3DXSPRITE_BILLBOARD + D3DXSPRITE_BILLBOARD + + + + No documentation. + + + D3DXSPRITE_ALPHABLEND + D3DXSPRITE_ALPHABLEND + + + + No documentation. + + + D3DXSPRITE_SORT_TEXTURE + D3DXSPRITE_SORT_TEXTURE + + + + No documentation. + + + D3DXSPRITE_SORT_DEPTH_FRONTTOBACK + D3DXSPRITE_SORT_DEPTH_FRONTTOBACK + + + + No documentation. + + + D3DXSPRITE_SORT_DEPTH_BACKTOFRONT + D3DXSPRITE_SORT_DEPTH_BACKTOFRONT + + + + No documentation. + + + D3DXSPRITE_DO_NOT_ADDREF_TEXTURE + D3DXSPRITE_DO_NOT_ADDREF_TEXTURE + + + + None. + + + None + None + + + + No documentation. + + + D3DSTATEBLOCKTYPE + D3DSTATEBLOCKTYPE + + + + No documentation. + + + D3DSBT_ALL + D3DSBT_ALL + + + + No documentation. + + + D3DSBT_PIXELSTATE + D3DSBT_PIXELSTATE + + + + No documentation. + + + D3DSBT_VERTEXSTATE + D3DSBT_VERTEXSTATE + + + +

Driver stencil capability flags.

+
+ + bb172609 + D3DSTENCILCAPS + D3DSTENCILCAPS +
+ + + No documentation. + + + D3DSTENCILCAPS_KEEP + D3DSTENCILCAPS_KEEP + + + + No documentation. + + + D3DSTENCILCAPS_ZERO + D3DSTENCILCAPS_ZERO + + + + No documentation. + + + D3DSTENCILCAPS_REPLACE + D3DSTENCILCAPS_REPLACE + + + + No documentation. + + + D3DSTENCILCAPS_INCRSAT + D3DSTENCILCAPS_INCRSAT + + + + No documentation. + + + D3DSTENCILCAPS_DECRSAT + D3DSTENCILCAPS_DECRSAT + + + + No documentation. + + + D3DSTENCILCAPS_INVERT + D3DSTENCILCAPS_INVERT + + + + No documentation. + + + D3DSTENCILCAPS_INCR + D3DSTENCILCAPS_INCR + + + + No documentation. + + + D3DSTENCILCAPS_DECR + D3DSTENCILCAPS_DECR + + + + No documentation. + + + D3DSTENCILCAPS_TWOSIDED + D3DSTENCILCAPS_TWOSIDED + + + +

Defines stencil-buffer operations.

+
+ +

Stencil-buffer entries are integer values ranging from 0 through 2n - 1, where n is the bit depth of the stencil buffer.

+
+ + bb172610 + D3DSTENCILOP + D3DSTENCILOP +
+ + +

Do not update the entry in the stencil buffer. This is the default value.

+
+ + bb172610 + D3DSTENCILOP_KEEP + D3DSTENCILOP_KEEP +
+ + +

Set the stencil-buffer entry to 0.

+
+ + bb172610 + D3DSTENCILOP_ZERO + D3DSTENCILOP_ZERO +
+ + +

Replace the stencil-buffer entry with a reference value.

+
+ + bb172610 + D3DSTENCILOP_REPLACE + D3DSTENCILOP_REPLACE +
+ + +

Increment the stencil-buffer entry, clamping to the maximum value.

+
+ + bb172610 + D3DSTENCILOP_INCRSAT + D3DSTENCILOP_INCRSAT +
+ + +

Decrement the stencil-buffer entry, clamping to zero.

+
+ + bb172610 + D3DSTENCILOP_DECRSAT + D3DSTENCILOP_DECRSAT +
+ + +

Invert the bits in the stencil-buffer entry.

+
+ + bb172610 + D3DSTENCILOP_INVERT + D3DSTENCILOP_INVERT +
+ + +

Increment the stencil-buffer entry, wrapping to zero if the new value exceeds the maximum value.

+
+ + bb172610 + D3DSTENCILOP_INCR + D3DSTENCILOP_INCR +
+ + +

Decrement the stencil-buffer entry, wrapping to the maximum value if the new value is less than zero.

+
+ + bb172610 + D3DSTENCILOP_DECR + D3DSTENCILOP_DECR +
+ + + No documentation. + + + D3DSTREAMSOURCE + D3DSTREAMSOURCE + + + + No documentation. + + + D3DSTREAMSOURCE_INDEXEDDATA + D3DSTREAMSOURCE_INDEXEDDATA + + + + No documentation. + + + D3DSTREAMSOURCE_INSTANCEDATA + D3DSTREAMSOURCE_INSTANCEDATA + + + +

Defines swap effects.

+
+ +

The state of the back buffer after a call to Present is well-defined by each of these swap effects, and whether the Direct3D device was created with a full-screen swap chain or a windowed swap chain has no effect on this state. In particular, the swap effect operates the same whether windowed or full-screen, and the Direct3D runtime guarantees this by creating extra buffers. As a result, it is recommended that applications use whenever possible to avoid any such penalties. This is because this swap effect will always be the most efficient in terms of memory consumption and performance.

Applications that use or should not expect full-screen destination alpha to work. This means that the render state will not work as expected because full-screen swap chains with these swap effects do not have an explicit pixel format from the driver's point of view. The driver infers that they should take on the display format, which does not have an alpha channel. To work around this, take the following steps:

  • Use .
  • Check the flag in the Caps3 member of the structure. This flag indicates whether the driver can do alpha blending when or is used.
  • Applications using flip mode swap effect () should call PresentEx after a window resize or region change to ensure that the display content is updated.

An invisible window cannot receive user-mode events; furthermore, an invisible-fullscreen window will interfere with the presentation of another applications' windowed-mode window. Therefore, each application needs to ensure that a device window is visible when a swapchain is presented in fullscreen mode.

+
+ + bb172612 + D3DSWAPEFFECT + D3DSWAPEFFECT +
+ + +

When a swap chain is created with a swap effect of or , the runtime will guarantee that an operation will not affect the content of any of the back buffers. Unfortunately, meeting this guarantee can involve substantial video memory or processing overheads, especially when implementing flip semantics for a windowed swap chain or copy semantics for a full-screen swap chain. An application may use the swap effect to avoid these overheads and to enable the display driver to select the most efficient presentation technique for the swap chain. This is also the only swap effect that may be used when specifying a value other than for the MultiSampleType member of .

Like a swap chain that uses , a swap chain that uses might include more than one back buffer, any of which may be accessed using or . The swap chain is best envisaged as a queue in which 0 always indexes the back buffer that will be displayed by the next Present operation and from which buffers are discarded when they have been displayed.

An application that uses this swap effect cannot make any assumptions about the contents of a discarded back buffer and should therefore update an entire back buffer before invoking a Present operation that would display it. Although this is not enforced, the debug version of the runtime will overwrite the contents of discarded back buffers with random data to enable developers to verify that their applications are updating the entire back buffer surfaces correctly.

+
+ + bb172612 + D3DSWAPEFFECT_DISCARD + D3DSWAPEFFECT_DISCARD +
+ + +

The swap chain might include multiple back buffers and is best envisaged as a circular queue that includes the front buffer. Within this queue, the back buffers are always numbered sequentially from 0 to (n - 1), where n is the number of back buffers, so that 0 denotes the least recently presented buffer. When Present is invoked, the queue is "rotated" so that the front buffer becomes back buffer (n - 1), while the back buffer 0 becomes the new front buffer.

+
+ + bb172612 + D3DSWAPEFFECT_FLIP + D3DSWAPEFFECT_FLIP +
+ + +

This swap effect may be specified only for a swap chain comprising a single back buffer. Whether the swap chain is windowed or full-screen, the runtime will guarantee the semantics implied by a copy-based Present operation, namely that the operation leaves the content of the back buffer unchanged, instead of replacing it with the content of the front buffer as a flip-based Present operation would.

For a full-screen swap chain, the runtime uses a combination of flip operations and copy operations, supported if necessary by hidden back buffers, to accomplish the Present operation. Accordingly, the presentation is synchronized with the display adapter's vertical retrace and its rate is constrained by the chosen presentation interval. A swap chain specified with the flag is the only exception. (Refer to the description of the PresentationIntervals member of the structure.) In this case, a Present operation copies the back buffer content directly to the front buffer without waiting for the vertical retrace.

+
+ + bb172612 + D3DSWAPEFFECT_COPY + D3DSWAPEFFECT_COPY +
+ + +

Use a dedicated area of video memory that can be overlayed on the primary surface. No copy is performed when the overlay is displayed. The overlay operation is performed in hardware, without modifying the data in the primary surface.

Differences between Direct3D 9 and Direct3D 9Ex:

is only available in Direct3D9Ex running on Windows 7 (or more current operating system).

?

+
+ + bb172612 + D3DSWAPEFFECT_OVERLAY + D3DSWAPEFFECT_OVERLAY +
+ + +

Designates when an application is adopting flip mode, during which time an application's frame is passed instead of copied to the Desktop Window Manager(DWM) for composition when the application is presenting in windowed mode. Flip mode allows an application to more efficiently use memory bandwidth as well as enabling an application to take advantage of full-screen-present statistics. Flip mode does not affect full-screen behavior. A sample application that uses and is the D3D9ExFlipEx sample on the MSDN Code Gallery.

Differences between Direct3D 9 and Direct3D 9Ex:

is only available in Direct3D9Ex running on Windows 7 (or more current operating system).

?

+
+ + bb172612 + D3DSWAPEFFECT_FLIPEX + D3DSWAPEFFECT_FLIPEX +
+ + +

Defines settings used for mesh tangent frame computations.

+
+ + bb205467 + D3DXTANGENT + D3DXTANGENT +
+ + +

Texture coordinate values in the u direction are between 0 and 1. In this case a texture coordinate set will be chosen that minimizes the perimeter of the triangle. See Texture Wrapping (Direct3D 9).

+
+ + bb205467 + D3DXTANGENT_WRAP_U + D3DXTANGENT_WRAP_U +
+ + +

Texture coordinate values in the v direction are between 0 and 1. In this case a texture coordinate set will be chosen that minimizes the perimeter of the triangle. See Texture Wrapping (Direct3D 9).

+
+ + bb205467 + D3DXTANGENT_WRAP_V + D3DXTANGENT_WRAP_V +
+ + +

Texture coordinate values in both u and v directions are between 0 and 1. In this case a texture coordinate set will be chosen that minimizes the perimeter of the triangle. See Texture Wrapping (Direct3D 9).

+
+ + bb205467 + D3DXTANGENT_WRAP_UV + D3DXTANGENT_WRAP_UV +
+ + +

Do not normalize partial derivatives with respect to texture coordinates. If not normalized, the scale of the partial derivatives is proportional to the scale of the 3D model divided by the scale of the triangle in (u, v) space. This scale value provides a measure of how much the texture is stretched in a given direction. The resulting vector length is a weighted sum of the lengths of the partial derivatives.

+
+ + bb205467 + D3DXTANGENT_DONT_NORMALIZE_PARTIALS + D3DXTANGENT_DONT_NORMALIZE_PARTIALS +
+ + +

Do not transform texture coordinates to orthogonal Cartesian coordinates. Mutually exclusive with and .

+
+ + bb205467 + D3DXTANGENT_DONT_ORTHOGONALIZE + D3DXTANGENT_DONT_ORTHOGONALIZE +
+ + +

Compute the partial derivative with respect to texture coordinate v independently for each vertex, and then compute the partial derivative with respect to u as the cross product of the partial derivative with respect to v and the normal vector. Mutually exclusive with and .

+
+ + bb205467 + D3DXTANGENT_ORTHOGONALIZE_FROM_V + D3DXTANGENT_ORTHOGONALIZE_FROM_V +
+ + +

Compute the partial derivative with respect to texture coordinate u independently for each vertex, and then compute the partial derivative with respect to v as the cross product of the normal vector and the partial derivative with respect to u. Mutually exclusive with and .

+
+ + bb205467 + D3DXTANGENT_ORTHOGONALIZE_FROM_U + D3DXTANGENT_ORTHOGONALIZE_FROM_U +
+ + +

Weight the direction of the computed per-vertex normal or partial derivative vector according to the areas of triangles attached to that vertex. Mutually exclusive with .

+
+ + bb205467 + D3DXTANGENT_WEIGHT_BY_AREA + D3DXTANGENT_WEIGHT_BY_AREA +
+ + +

Compute a unit-length normal vector for each triangle of the input mesh. Mutually exclusive with .

+
+ + bb205467 + D3DXTANGENT_WEIGHT_EQUAL + D3DXTANGENT_WEIGHT_EQUAL +
+ + +

Vertices are ordered in a clockwise direction around each triangle. The computed normal vector direction is therefore inverted 180 degrees from the direction computed using counterclockwise vertex ordering.

+
+ + bb205467 + D3DXTANGENT_WIND_CW + D3DXTANGENT_WIND_CW +
+ + +

Compute the per-vertex normal vector for each triangle of the input mesh, and ignore any normal vectors already in the input mesh.

+
+ + bb205467 + D3DXTANGENT_CALCULATE_NORMALS + D3DXTANGENT_CALCULATE_NORMALS +
+ + +

The results are stored in the original input mesh, and the output mesh is not used.

+
+ + bb205467 + D3DXTANGENT_GENERATE_IN_PLACE + D3DXTANGENT_GENERATE_IN_PLACE +
+ + + None. + + + None + None + + + + No documentation. + + + D3DTEXTUREADDRESS + D3DTEXTUREADDRESS + + + + No documentation. + + + D3DTADDRESS_WRAP + D3DTADDRESS_WRAP + + + + No documentation. + + + D3DTADDRESS_MIRROR + D3DTADDRESS_MIRROR + + + + No documentation. + + + D3DTADDRESS_CLAMP + D3DTADDRESS_CLAMP + + + + No documentation. + + + D3DTADDRESS_BORDER + D3DTADDRESS_BORDER + + + + No documentation. + + + D3DTADDRESS_MIRRORONCE + D3DTADDRESS_MIRRORONCE + + + + No documentation. + + + D3DPTADDRESSCAPS + D3DPTADDRESSCAPS + + + + No documentation. + + + D3DPTADDRESSCAPS_WRAP + D3DPTADDRESSCAPS_WRAP + + + + No documentation. + + + D3DPTADDRESSCAPS_MIRROR + D3DPTADDRESSCAPS_MIRROR + + + + No documentation. + + + D3DPTADDRESSCAPS_CLAMP + D3DPTADDRESSCAPS_CLAMP + + + + No documentation. + + + D3DPTADDRESSCAPS_BORDER + D3DPTADDRESSCAPS_BORDER + + + + No documentation. + + + D3DPTADDRESSCAPS_INDEPENDENTUV + D3DPTADDRESSCAPS_INDEPENDENTUV + + + + No documentation. + + + D3DPTADDRESSCAPS_MIRRORONCE + D3DPTADDRESSCAPS_MIRRORONCE + + + +

Texture argument constants are used as values for the following members of the enumerated type:

Set and retrieve texture arguments by calling the SetTextureStageState and GetTextureStageState methods.

Argument flags

You can combine an argument flag with a modifier, but two argument flags cannot be combined.

+
+ + bb172613 + D3DTA + D3DTA +
+ + + No documentation. + + + D3DTA_SELECTMASK + D3DTA_SELECTMASK + + + + No documentation. + + + D3DTA_DIFFUSE + D3DTA_DIFFUSE + + + + No documentation. + + + D3DTA_CURRENT + D3DTA_CURRENT + + + + No documentation. + + + D3DTA_TEXTURE + D3DTA_TEXTURE + + + + No documentation. + + + D3DTA_TFACTOR + D3DTA_TFACTOR + + + + No documentation. + + + D3DTA_SPECULAR + D3DTA_SPECULAR + + + + No documentation. + + + D3DTA_TEMP + D3DTA_TEMP + + + + No documentation. + + + D3DTA_CONSTANT + D3DTA_CONSTANT + + + + No documentation. + + + D3DTA_COMPLEMENT + D3DTA_COMPLEMENT + + + + No documentation. + + + D3DTA_ALPHAREPLICATE + D3DTA_ALPHAREPLICATE + + + + No documentation. + + + D3DPTEXTURECAPS + D3DPTEXTURECAPS + + + + No documentation. + + + D3DPTEXTURECAPS_PERSPECTIVE + D3DPTEXTURECAPS_PERSPECTIVE + + + + No documentation. + + + D3DPTEXTURECAPS_POW2 + D3DPTEXTURECAPS_POW2 + + + + No documentation. + + + D3DPTEXTURECAPS_ALPHA + D3DPTEXTURECAPS_ALPHA + + + + No documentation. + + + D3DPTEXTURECAPS_SQUAREONLY + D3DPTEXTURECAPS_SQUAREONLY + + + + No documentation. + + + D3DPTEXTURECAPS_TEXREPEATNOTSCALEDBYSIZE + D3DPTEXTURECAPS_TEXREPEATNOTSCALEDBYSIZE + + + + No documentation. + + + D3DPTEXTURECAPS_ALPHAPALETTE + D3DPTEXTURECAPS_ALPHAPALETTE + + + + No documentation. + + + D3DPTEXTURECAPS_NONPOW2CONDITIONAL + D3DPTEXTURECAPS_NONPOW2CONDITIONAL + + + + No documentation. + + + D3DPTEXTURECAPS_PROJECTED + D3DPTEXTURECAPS_PROJECTED + + + + No documentation. + + + D3DPTEXTURECAPS_CUBEMAP + D3DPTEXTURECAPS_CUBEMAP + + + + No documentation. + + + D3DPTEXTURECAPS_VOLUMEMAP + D3DPTEXTURECAPS_VOLUMEMAP + + + + No documentation. + + + D3DPTEXTURECAPS_MIPMAP + D3DPTEXTURECAPS_MIPMAP + + + + No documentation. + + + D3DPTEXTURECAPS_MIPVOLUMEMAP + D3DPTEXTURECAPS_MIPVOLUMEMAP + + + + No documentation. + + + D3DPTEXTURECAPS_MIPCUBEMAP + D3DPTEXTURECAPS_MIPCUBEMAP + + + + No documentation. + + + D3DPTEXTURECAPS_CUBEMAP_POW2 + D3DPTEXTURECAPS_CUBEMAP_POW2 + + + + No documentation. + + + D3DPTEXTURECAPS_VOLUMEMAP_POW2 + D3DPTEXTURECAPS_VOLUMEMAP_POW2 + + + + No documentation. + + + D3DPTEXTURECAPS_NOPROJECTEDBUMPENV + D3DPTEXTURECAPS_NOPROJECTEDBUMPENV + + + +

Driver texture coordinate capability flags.

+
+ + bb172621 + D3DTSS_TCI + D3DTSS_TCI +
+ + + No documentation. + + + D3DTSS_TCI_PASSTHRU + D3DTSS_TCI_PASSTHRU + + + + No documentation. + + + D3DTSS_TCI_CAMERASPACENORMAL + D3DTSS_TCI_CAMERASPACENORMAL + + + + No documentation. + + + D3DTSS_TCI_CAMERASPACEPOSITION + D3DTSS_TCI_CAMERASPACEPOSITION + + + + No documentation. + + + D3DTSS_TCI_CAMERASPACEREFLECTIONVECTOR + D3DTSS_TCI_CAMERASPACEREFLECTIONVECTOR + + + + No documentation. + + + D3DTSS_TCI_SPHEREMAP + D3DTSS_TCI_SPHEREMAP + + + +

Defines texture filtering modes for a texture stage.

+
+ +

is used by along with to define texture filtering modes for a texture stage.

To check if a format supports texture filter types other than (which is always supported), call with .

Set a texture stage's magnification filter by calling with the value as the second parameter and one member of this enumeration as the third parameter.

Set a texture stage's minification filter by calling with the value as the second parameter and one member of this enumeration as the third parameter.

Set the texture filter to use between-mipmap levels by calling with the value as the second parameter and one member of this enumeration as the third parameter.

Not all valid filtering modes for a device will apply to volume maps. In general, and magnification filters will be supported for volume maps. If is set, then the mipmap filter and and minification filters will be supported for volume maps. The device may or may not support the mipmap filter for volume maps. Devices that support anisotropic filtering for 2D maps do not necessarily support anisotropic filtering for volume maps. However, applications that enable anisotropic filtering will receive the best available filtering (probably linear) if anisotropic filtering is not supported.

+
+ + bb172615 + D3DTEXTUREFILTERTYPE + D3DTEXTUREFILTERTYPE +
+ + +

When used with , disables mipmapping.

+
+ + bb172615 + D3DTEXF_NONE + D3DTEXF_NONE +
+ + +

When used with D3DSAMP_ MAGFILTER or , specifies that point filtering is to be used as the texture magnification or minification filter respectively. When used with , enables mipmapping and specifies that the rasterizer chooses the color from the texel of the nearest mip level.

+
+ + bb172615 + D3DTEXF_POINT + D3DTEXF_POINT +
+ + +

When used with D3DSAMP_ MAGFILTER or , specifies that linear filtering is to be used as the texture magnification or minification filter respectively. When used with , enables mipmapping and trilinear filtering; it specifies that the rasterizer interpolates between the two nearest mip levels.

+
+ + bb172615 + D3DTEXF_LINEAR + D3DTEXF_LINEAR +
+ + +

When used with D3DSAMP_ MAGFILTER or , specifies that anisotropic texture filtering used as a texture magnification or minification filter respectively. Compensates for distortion caused by the difference in angle between the texture polygon and the plane of the screen. Use with is undefined.

+
+ + bb172615 + D3DTEXF_ANISOTROPIC + D3DTEXF_ANISOTROPIC +
+ + +

A 4-sample tent filter used as a texture magnification or minification filter. Use with is undefined.

+
+ + bb172615 + D3DTEXF_PYRAMIDALQUAD + D3DTEXF_PYRAMIDALQUAD +
+ + +

A 4-sample Gaussian filter used as a texture magnification or minification filter. Use with is undefined.

+
+ + bb172615 + D3DTEXF_GAUSSIANQUAD + D3DTEXF_GAUSSIANQUAD +
+ + +

Convolution filter for monochrome textures. See .

Differences between Direct3D 9 and Direct3D 9Ex:

This flag is available in Direct3D 9Ex only.

?

Use with is undefined.

+
+ + bb172615 + D3DTEXF_CONVOLUTIONMONO + D3DTEXF_CONVOLUTIONMONO +
+ + + No documentation. + + + D3DTEXTUREOP + D3DTEXTUREOP + + + + No documentation. + + + D3DTOP_DISABLE + D3DTOP_DISABLE + + + + No documentation. + + + D3DTOP_SELECTARG1 + D3DTOP_SELECTARG1 + + + + No documentation. + + + D3DTOP_SELECTARG2 + D3DTOP_SELECTARG2 + + + + No documentation. + + + D3DTOP_MODULATE + D3DTOP_MODULATE + + + + No documentation. + + + D3DTOP_MODULATE2X + D3DTOP_MODULATE2X + + + + No documentation. + + + D3DTOP_MODULATE4X + D3DTOP_MODULATE4X + + + + No documentation. + + + D3DTOP_ADD + D3DTOP_ADD + + + + No documentation. + + + D3DTOP_ADDSIGNED + D3DTOP_ADDSIGNED + + + + No documentation. + + + D3DTOP_ADDSIGNED2X + D3DTOP_ADDSIGNED2X + + + + No documentation. + + + D3DTOP_SUBTRACT + D3DTOP_SUBTRACT + + + + No documentation. + + + D3DTOP_ADDSMOOTH + D3DTOP_ADDSMOOTH + + + + No documentation. + + + D3DTOP_BLENDDIFFUSEALPHA + D3DTOP_BLENDDIFFUSEALPHA + + + + No documentation. + + + D3DTOP_BLENDTEXTUREALPHA + D3DTOP_BLENDTEXTUREALPHA + + + + No documentation. + + + D3DTOP_BLENDFACTORALPHA + D3DTOP_BLENDFACTORALPHA + + + + No documentation. + + + D3DTOP_BLENDTEXTUREALPHAPM + D3DTOP_BLENDTEXTUREALPHAPM + + + + No documentation. + + + D3DTOP_BLENDCURRENTALPHA + D3DTOP_BLENDCURRENTALPHA + + + + No documentation. + + + D3DTOP_PREMODULATE + D3DTOP_PREMODULATE + + + + No documentation. + + + D3DTOP_MODULATEALPHA_ADDCOLOR + D3DTOP_MODULATEALPHA_ADDCOLOR + + + + No documentation. + + + D3DTOP_MODULATECOLOR_ADDALPHA + D3DTOP_MODULATECOLOR_ADDALPHA + + + + No documentation. + + + D3DTOP_MODULATEINVALPHA_ADDCOLOR + D3DTOP_MODULATEINVALPHA_ADDCOLOR + + + + No documentation. + + + D3DTOP_MODULATEINVCOLOR_ADDALPHA + D3DTOP_MODULATEINVCOLOR_ADDALPHA + + + + No documentation. + + + D3DTOP_BUMPENVMAP + D3DTOP_BUMPENVMAP + + + + No documentation. + + + D3DTOP_BUMPENVMAPLUMINANCE + D3DTOP_BUMPENVMAPLUMINANCE + + + + No documentation. + + + D3DTOP_DOTPRODUCT3 + D3DTOP_DOTPRODUCT3 + + + + No documentation. + + + D3DTOP_MULTIPLYADD + D3DTOP_MULTIPLYADD + + + + No documentation. + + + D3DTOP_LERP + D3DTOP_LERP + + + + No documentation. + + + D3DTEXOPCAPS + D3DTEXOPCAPS + + + + No documentation. + + + D3DTEXOPCAPS_DISABLE + D3DTEXOPCAPS_DISABLE + + + + No documentation. + + + D3DTEXOPCAPS_SELECTARG1 + D3DTEXOPCAPS_SELECTARG1 + + + + No documentation. + + + D3DTEXOPCAPS_SELECTARG2 + D3DTEXOPCAPS_SELECTARG2 + + + + No documentation. + + + D3DTEXOPCAPS_MODULATE + D3DTEXOPCAPS_MODULATE + + + + No documentation. + + + D3DTEXOPCAPS_MODULATE2X + D3DTEXOPCAPS_MODULATE2X + + + + No documentation. + + + D3DTEXOPCAPS_MODULATE4X + D3DTEXOPCAPS_MODULATE4X + + + + No documentation. + + + D3DTEXOPCAPS_ADD + D3DTEXOPCAPS_ADD + + + + No documentation. + + + D3DTEXOPCAPS_ADDSIGNED + D3DTEXOPCAPS_ADDSIGNED + + + + No documentation. + + + D3DTEXOPCAPS_ADDSIGNED2X + D3DTEXOPCAPS_ADDSIGNED2X + + + + No documentation. + + + D3DTEXOPCAPS_SUBTRACT + D3DTEXOPCAPS_SUBTRACT + + + + No documentation. + + + D3DTEXOPCAPS_ADDSMOOTH + D3DTEXOPCAPS_ADDSMOOTH + + + + No documentation. + + + D3DTEXOPCAPS_BLENDDIFFUSEALPHA + D3DTEXOPCAPS_BLENDDIFFUSEALPHA + + + + No documentation. + + + D3DTEXOPCAPS_BLENDTEXTUREALPHA + D3DTEXOPCAPS_BLENDTEXTUREALPHA + + + + No documentation. + + + D3DTEXOPCAPS_BLENDFACTORALPHA + D3DTEXOPCAPS_BLENDFACTORALPHA + + + + No documentation. + + + D3DTEXOPCAPS_BLENDTEXTUREALPHAPM + D3DTEXOPCAPS_BLENDTEXTUREALPHAPM + + + + No documentation. + + + D3DTEXOPCAPS_BLENDCURRENTALPHA + D3DTEXOPCAPS_BLENDCURRENTALPHA + + + + No documentation. + + + D3DTEXOPCAPS_PREMODULATE + D3DTEXOPCAPS_PREMODULATE + + + + No documentation. + + + D3DTEXOPCAPS_MODULATEALPHA_ADDCOLOR + D3DTEXOPCAPS_MODULATEALPHA_ADDCOLOR + + + + No documentation. + + + D3DTEXOPCAPS_MODULATECOLOR_ADDALPHA + D3DTEXOPCAPS_MODULATECOLOR_ADDALPHA + + + + No documentation. + + + D3DTEXOPCAPS_MODULATEINVALPHA_ADDCOLOR + D3DTEXOPCAPS_MODULATEINVALPHA_ADDCOLOR + + + + No documentation. + + + D3DTEXOPCAPS_MODULATEINVCOLOR_ADDALPHA + D3DTEXOPCAPS_MODULATEINVCOLOR_ADDALPHA + + + + No documentation. + + + D3DTEXOPCAPS_BUMPENVMAP + D3DTEXOPCAPS_BUMPENVMAP + + + + No documentation. + + + D3DTEXOPCAPS_BUMPENVMAPLUMINANCE + D3DTEXOPCAPS_BUMPENVMAPLUMINANCE + + + + No documentation. + + + D3DTEXOPCAPS_DOTPRODUCT3 + D3DTEXOPCAPS_DOTPRODUCT3 + + + + No documentation. + + + D3DTEXOPCAPS_MULTIPLYADD + D3DTEXOPCAPS_MULTIPLYADD + + + + No documentation. + + + D3DTEXOPCAPS_LERP + D3DTEXOPCAPS_LERP + + + + No documentation. + + + D3DTEXTURESTAGESTATETYPE + D3DTEXTURESTAGESTATETYPE + + + + No documentation. + + + D3DTSS_COLOROP + D3DTSS_COLOROP + + + + No documentation. + + + D3DTSS_COLORARG1 + D3DTSS_COLORARG1 + + + + No documentation. + + + D3DTSS_COLORARG2 + D3DTSS_COLORARG2 + + + + No documentation. + + + D3DTSS_ALPHAOP + D3DTSS_ALPHAOP + + + + No documentation. + + + D3DTSS_ALPHAARG1 + D3DTSS_ALPHAARG1 + + + + No documentation. + + + D3DTSS_ALPHAARG2 + D3DTSS_ALPHAARG2 + + + + No documentation. + + + D3DTSS_BUMPENVMAT00 + D3DTSS_BUMPENVMAT00 + + + + No documentation. + + + D3DTSS_BUMPENVMAT01 + D3DTSS_BUMPENVMAT01 + + + + No documentation. + + + D3DTSS_BUMPENVMAT10 + D3DTSS_BUMPENVMAT10 + + + + No documentation. + + + D3DTSS_BUMPENVMAT11 + D3DTSS_BUMPENVMAT11 + + + + No documentation. + + + D3DTSS_TEXCOORDINDEX + D3DTSS_TEXCOORDINDEX + + + + No documentation. + + + D3DTSS_BUMPENVLSCALE + D3DTSS_BUMPENVLSCALE + + + + No documentation. + + + D3DTSS_BUMPENVLOFFSET + D3DTSS_BUMPENVLOFFSET + + + + No documentation. + + + D3DTSS_TEXTURETRANSFORMFLAGS + D3DTSS_TEXTURETRANSFORMFLAGS + + + + No documentation. + + + D3DTSS_COLORARG0 + D3DTSS_COLORARG0 + + + + No documentation. + + + D3DTSS_ALPHAARG0 + D3DTSS_ALPHAARG0 + + + + No documentation. + + + D3DTSS_RESULTARG + D3DTSS_RESULTARG + + + + No documentation. + + + D3DTSS_CONSTANT + D3DTSS_CONSTANT + + + +

Defines texture coordinate transformation values.

+
+ +

Texture coordinates can be transformed using a 4 x 4 matrix before the results are passed to the rasterizer. The texture coordinate transforms are set by calling , and by passing in the texture stage state and one of the values from . For more information about texture transforms, see Texture Coordinate Transformations (Direct3D 9).

+
+ + bb172618 + D3DTEXTURETRANSFORMFLAGS + D3DTEXTURETRANSFORMFLAGS +
+ + +

Texture coordinates are passed directly to the rasterizer.

+
+ + bb172618 + D3DTTFF_DISABLE + D3DTTFF_DISABLE +
+ + +

The rasterizer should expect 1D texture coordinates. This value is used by fixed function vertex processing; it should be set to 0 when using a programmable vertex shader.

+
+ + bb172618 + D3DTTFF_COUNT1 + D3DTTFF_COUNT1 +
+ + +

The rasterizer should expect 2D texture coordinates. This value is used by fixed function vertex processing; it should be set to 0 when using a programmable vertex shader.

+
+ + bb172618 + D3DTTFF_COUNT2 + D3DTTFF_COUNT2 +
+ + +

The rasterizer should expect 3D texture coordinates. This value is used by fixed function vertex processing; it should be set to 0 when using a programmable vertex shader.

+
+ + bb172618 + D3DTTFF_COUNT3 + D3DTTFF_COUNT3 +
+ + +

The rasterizer should expect 4D texture coordinates. This value is used by fixed function vertex processing; it should be set to 0 when using a programmable vertex shader.

+
+ + bb172618 + D3DTTFF_COUNT4 + D3DTTFF_COUNT4 +
+ + +

This flag is honored by the fixed function pixel pipeline, as well as the programmable pixel pipeline in versions ps_1_1 to ps_1_3. When texture projection is enabled for a texture stage, all four floating point values must be written to the corresponding texture register. Each texture coordinate is divided by the last element before being passed to the rasterizer. For example, if this flag is specified with the flag, the first and second texture coordinates are divided by the third coordinate before being passed to the rasterizer.

+
+ + bb172618 + D3DTTFF_PROJECTED + D3DTTFF_PROJECTED +
+ + + No documentation. + + + D3DWRAPCOORD + D3DWRAPCOORD + + + + No documentation. + + + D3DWRAPCOORD_0 + D3DWRAPCOORD_0 + + + + No documentation. + + + D3DWRAPCOORD_1 + D3DWRAPCOORD_1 + + + + No documentation. + + + D3DWRAPCOORD_2 + D3DWRAPCOORD_2 + + + + No documentation. + + + D3DWRAPCOORD_3 + D3DWRAPCOORD_3 + + + + None. + + + None + None + + + +

Defines the priority type to which an animation track is assigned.

+
+ +

Tracks with the same priority are blended together, and the two resulting values are then blended using the priority blend factor.

+
+ + bb205401 + D3DXPRIORITY_TYPE + D3DXPRIORITY_TYPE +
+ + +

Track should be blended with all the low-priority tracks before the low-priority blend is mixed with the high-priority blend.

+
+ + bb205401 + D3DXPRIORITY_LOW + D3DXPRIORITY_LOW +
+ + +

Track should be blended with all the high-priority tracks before the high-priority blend is mixed with the low-priority blend.

+
+ + bb205401 + D3DXPRIORITY_HIGH + D3DXPRIORITY_HIGH +
+ + + No documentation. + + + D3DTRANSFORMSTATETYPE2 + D3DTRANSFORMSTATETYPE2 + + + + No documentation. + + + D3DTS2_VIEW + D3DTS2_VIEW + + + + No documentation. + + + D3DTS2_PROJECTION + D3DTS2_PROJECTION + + + + No documentation. + + + D3DTS2_WORLD + D3DTS2_WORLD + + + + No documentation. + + + D3DTS2_WORLD1 + D3DTS2_WORLD1 + + + + No documentation. + + + D3DTS2_WORLD2 + D3DTS2_WORLD2 + + + + No documentation. + + + D3DTS2_WORLD3 + D3DTS2_WORLD3 + + + + No documentation. + + + D3DTS2_TEXTURE0 + D3DTS2_TEXTURE0 + + + + No documentation. + + + D3DTS2_TEXTURE1 + D3DTS2_TEXTURE1 + + + + No documentation. + + + D3DTS2_TEXTURE2 + D3DTS2_TEXTURE2 + + + + No documentation. + + + D3DTS2_TEXTURE3 + D3DTS2_TEXTURE3 + + + + No documentation. + + + D3DTS2_TEXTURE4 + D3DTS2_TEXTURE4 + + + + No documentation. + + + D3DTS2_TEXTURE5 + D3DTS2_TEXTURE5 + + + + No documentation. + + + D3DTS2_TEXTURE6 + D3DTS2_TEXTURE6 + + + + No documentation. + + + D3DTS2_TEXTURE7 + D3DTS2_TEXTURE7 + + + +

Defines the transition style between values of a mesh animation.

+
+ +

The calculation for the ramp from ease in to ease out is calculated as follows:

Q(t) = 2(x - y)t3 + 3(y - x)t2 + x

where the ramp is a function Q(t) with the following properties:

  • Q(t) is a cubic spline.
  • Q(t) interpolates between x and y as t ranges from 0 to 1.
  • Q(t) is horizontal when t = 0 and t = 1.

Mathematically, this translates into:

Q(t) = At3 + Bt2 + Ct + D (and therefore, Q'(t) = 3At2 + 2Bt + C)
2a) Q(0) = x
2b) Q(1) = y
3a) Q'(0) = 0
3b) Q'(1) = 0

Solving for A, B, C, D:

D = x (from 2a)
C = 0 (from 3a)
3A + 2B = 0 (from 3b)
A + B = y - x (from 2b and D = x)

Therefore:

A = 2(x - y), B = 3(y - x), C = 0, D = x
+
+ + bb205475 + D3DXTRANSITION_TYPE + D3DXTRANSITION_TYPE +
+ + +

Linear transition between values.

+
+ + bb205475 + D3DXTRANSITION_LINEAR + D3DXTRANSITION_LINEAR +
+ + +

Ease-in, ease-out spline transition between values.

+
+ + bb205475 + D3DXTRANSITION_EASEINEASEOUT + D3DXTRANSITION_EASEINEASEOUT +
+ + +

Usage options that identify how resources are to be used.

The following table summarizes the available usage options.

+
+ + Usage and Resource Combinations

Usages are either specified when a resource is created, or specified with CheckDeviceType to test the capability of an existing resource. The following table identifies which usages can be applied to which resource types.

UsageVertex buffer createIndex buffer createTexture createCube texture createVolume texture createSurface createCheck device format
xxx
xxxx
xx
xx
xxxxxx
xxxxxxx
xx
xx
xx
xxxx
xxxxxx
xx
xx

?

Use CheckDeviceFormat to check hardware support for these usages.

Each of the resource creation methods is listed here.

  • CreateCubeTexture
  • CreateDepthStencilSurface
  • CreateIndexBuffer
  • CreateOffscreenPlainSurface
  • CreateRenderTarget
  • CreateTexture
  • CreateVertexBuffer
  • CreateVolumeTexture

The D3DXCreatexxx texturing functions also use some of these constant values for resource creation.

For more information about pool types and their restrictions with certain usages, see .

+
+ + bb172625 + D3DUSAGE + D3DUSAGE +
+ + + No documentation. + + + D3DUSAGE_RENDERTARGET + D3DUSAGE_RENDERTARGET + + + + No documentation. + + + D3DUSAGE_DEPTHSTENCIL + D3DUSAGE_DEPTHSTENCIL + + + + No documentation. + + + D3DUSAGE_DYNAMIC + D3DUSAGE_DYNAMIC + + + + No documentation. + + + D3DUSAGE_NONSECURE + D3DUSAGE_NONSECURE + + + + No documentation. + + + D3DUSAGE_AUTOGENMIPMAP + D3DUSAGE_AUTOGENMIPMAP + + + + No documentation. + + + D3DUSAGE_DMAP + D3DUSAGE_DMAP + + + + No documentation. + + + D3DUSAGE_QUERY_LEGACYBUMPMAP + D3DUSAGE_QUERY_LEGACYBUMPMAP + + + + No documentation. + + + D3DUSAGE_QUERY_SRGBREAD + D3DUSAGE_QUERY_SRGBREAD + + + + No documentation. + + + D3DUSAGE_QUERY_FILTER + D3DUSAGE_QUERY_FILTER + + + + No documentation. + + + D3DUSAGE_QUERY_SRGBWRITE + D3DUSAGE_QUERY_SRGBWRITE + + + + No documentation. + + + D3DUSAGE_QUERY_POSTPIXELSHADER_BLENDING + D3DUSAGE_QUERY_POSTPIXELSHADER_BLENDING + + + + No documentation. + + + D3DUSAGE_QUERY_VERTEXTEXTURE + D3DUSAGE_QUERY_VERTEXTEXTURE + + + + No documentation. + + + D3DUSAGE_QUERY_WRAPANDMIP + D3DUSAGE_QUERY_WRAPANDMIP + + + + No documentation. + + + D3DUSAGE_WRITEONLY + D3DUSAGE_WRITEONLY + + + + No documentation. + + + D3DUSAGE_SOFTWAREPROCESSING + D3DUSAGE_SOFTWAREPROCESSING + + + + No documentation. + + + D3DUSAGE_DONOTCLIP + D3DUSAGE_DONOTCLIP + + + + No documentation. + + + D3DUSAGE_POINTS + D3DUSAGE_POINTS + + + + No documentation. + + + D3DUSAGE_RTPATCHES + D3DUSAGE_RTPATCHES + + + + No documentation. + + + D3DUSAGE_NPATCHES + D3DUSAGE_NPATCHES + + + + No documentation. + + + D3DUSAGE_TEXTAPI + D3DUSAGE_TEXTAPI + + + + No documentation. + + + D3DUSAGE_RESTRICTED_CONTENT + D3DUSAGE_RESTRICTED_CONTENT + + + + No documentation. + + + D3DUSAGE_RESTRICT_SHARED_RESOURCE + D3DUSAGE_RESTRICT_SHARED_RESOURCE + + + + No documentation. + + + D3DUSAGE_RESTRICT_SHARED_RESOURCE_DRIVER + D3DUSAGE_RESTRICT_SHARED_RESOURCE_DRIVER + + + + None. + + + None + None + + + +

Texture wrapping options for IMT computation APIs.

+
+ + bb172880 + D3DXIMT + D3DXIMT +
+ + +

The texture wraps in the U direction.

+
+ + bb172880 + D3DXIMT_WRAP_U + D3DXIMT_WRAP_U +
+ + +

The texture wraps in the V direction.

+
+ + bb172880 + D3DXIMT_WRAP_V + D3DXIMT_WRAP_V +
+ + +

The texture wraps in both the U and V direction.

+
+ + bb172880 + D3DXIMT_WRAP_UV + D3DXIMT_WRAP_UV +
+ + +

Defines flags used to control the number or matrices that the system applies when performing multimatrix vertex blending.

+
+ +

Members of this type are used with the render state.

Geometry blending (multimatrix vertex blending) requires that your application use a vertex format that has blending (beta) weights for each vertex.

+
+ + bb172628 + D3DVERTEXBLENDFLAGS + D3DVERTEXBLENDFLAGS +
+ + +

Disable vertex blending; apply only the world matrix set by the D3DTS_WORLDMATRIX macro, where the index value for the transformation state is 0.

+
+ + bb172628 + D3DVBF_DISABLE + D3DVBF_DISABLE +
+ + +

Enable vertex blending between the two matrices set by the D3DTS_WORLDMATRIX macro, where the index value for the transformation states are 0 and 1.

+
+ + bb172628 + D3DVBF_1WEIGHTS + D3DVBF_1WEIGHTS +
+ + +

Enable vertex blending between the three matrices set by the D3DTS_WORLDMATRIX macro, where the index value for the transformation states are 0, 1, and 2.

+
+ + bb172628 + D3DVBF_2WEIGHTS + D3DVBF_2WEIGHTS +
+ + +

Enable vertex blending between the four matrices set by the D3DTS_WORLDMATRIX macro, where the index value for the transformation states are 0, 1, 2, and 3.

+
+ + bb172628 + D3DVBF_3WEIGHTS + D3DVBF_3WEIGHTS +
+ + +

Vertex blending is done by using the value assigned to .

+
+ + bb172628 + D3DVBF_TWEENING + D3DVBF_TWEENING +
+ + +

Use a single matrix with a weight of 1.0.

+
+ + bb172628 + D3DVBF_0WEIGHTS + D3DVBF_0WEIGHTS +
+ + +

Flexible Vertex Format Constants, or FVF codes, are used to describe the contents of vertices interleaved in a single data stream that will be processed by the fixed-function pipeline.

+
+ + bb172559 + D3DFVF + D3DFVF +
+ + + No documentation. + + + D3DFVF_RESERVED0 + D3DFVF_RESERVED0 + + + + No documentation. + + + D3DFVF_POSITION_MASK + D3DFVF_POSITION_MASK + + + + No documentation. + + + D3DFVF_XYZ + D3DFVF_XYZ + + + + No documentation. + + + D3DFVF_XYZRHW + D3DFVF_XYZRHW + + + + No documentation. + + + D3DFVF_XYZB1 + D3DFVF_XYZB1 + + + + No documentation. + + + D3DFVF_XYZB2 + D3DFVF_XYZB2 + + + + No documentation. + + + D3DFVF_XYZB3 + D3DFVF_XYZB3 + + + + No documentation. + + + D3DFVF_XYZB4 + D3DFVF_XYZB4 + + + + No documentation. + + + D3DFVF_XYZB5 + D3DFVF_XYZB5 + + + + No documentation. + + + D3DFVF_XYZW + D3DFVF_XYZW + + + + No documentation. + + + D3DFVF_NORMAL + D3DFVF_NORMAL + + + + No documentation. + + + D3DFVF_PSIZE + D3DFVF_PSIZE + + + + No documentation. + + + D3DFVF_DIFFUSE + D3DFVF_DIFFUSE + + + + No documentation. + + + D3DFVF_SPECULAR + D3DFVF_SPECULAR + + + + No documentation. + + + D3DFVF_TEXCOUNT_MASK + D3DFVF_TEXCOUNT_MASK + + + + No documentation. + + + D3DFVF_TEXCOUNT_SHIFT + D3DFVF_TEXCOUNT_SHIFT + + + + No documentation. + + + D3DFVF_TEX0 + D3DFVF_TEX0 + + + + No documentation. + + + D3DFVF_TEX1 + D3DFVF_TEX1 + + + + No documentation. + + + D3DFVF_TEX2 + D3DFVF_TEX2 + + + + No documentation. + + + D3DFVF_TEX3 + D3DFVF_TEX3 + + + + No documentation. + + + D3DFVF_TEX4 + D3DFVF_TEX4 + + + + No documentation. + + + D3DFVF_TEX5 + D3DFVF_TEX5 + + + + No documentation. + + + D3DFVF_TEX6 + D3DFVF_TEX6 + + + + No documentation. + + + D3DFVF_TEX7 + D3DFVF_TEX7 + + + + No documentation. + + + D3DFVF_TEX8 + D3DFVF_TEX8 + + + + No documentation. + + + D3DFVF_LASTBETA_UBYTE4 + D3DFVF_LASTBETA_UBYTE4 + + + + No documentation. + + + D3DFVF_LASTBETA_D3DCOLOR + D3DFVF_LASTBETA_D3DCOLOR + + + + None. + + + None + None + + + + No documentation. + + + D3DFVFCAPS + D3DFVFCAPS + + + + No documentation. + + + D3DFVFCAPS_TEXCOORDCOUNTMASK + D3DFVFCAPS_TEXCOORDCOUNTMASK + + + + No documentation. + + + D3DFVFCAPS_DONOTSTRIPELEMENTS + D3DFVFCAPS_DONOTSTRIPELEMENTS + + + + No documentation. + + + D3DFVFCAPS_PSIZE + D3DFVFCAPS_PSIZE + + + +

This constant is the maximum number of vertex declarators for a mesh.

+
+ +

MAXD3DDECLLENGTH is defined as a maximum of 64 (see d3d9types.h). This does not include the "end" marker vertex element.

+
+ + bb147183 + _MAX_FVF_DECL_SIZE + _MAX_FVF_DECL_SIZE +
+ + +

The maximum number of elements in the vertex declaration. The additional (+1) is for D3DDECL_END.

+
+ + bb147183 + MAX_FVF_DECL_SIZE + MAX_FVF_DECL_SIZE +
+ + +

A combination of one or more flags that control the device create behavior.

+
+ + bb172637 + D3DVTXPCAPS + D3DVTXPCAPS +
+ + + No documentation. + + + D3DVTXPCAPS_TEXGEN + D3DVTXPCAPS_TEXGEN + + + + No documentation. + + + D3DVTXPCAPS_MATERIALSOURCE7 + D3DVTXPCAPS_MATERIALSOURCE7 + + + + No documentation. + + + D3DVTXPCAPS_DIRECTIONALLIGHTS + D3DVTXPCAPS_DIRECTIONALLIGHTS + + + + No documentation. + + + D3DVTXPCAPS_POSITIONALLIGHTS + D3DVTXPCAPS_POSITIONALLIGHTS + + + + No documentation. + + + D3DVTXPCAPS_LOCALVIEWER + D3DVTXPCAPS_LOCALVIEWER + + + + No documentation. + + + D3DVTXPCAPS_TWEENING + D3DVTXPCAPS_TWEENING + + + + No documentation. + + + D3DVTXPCAPS_TEXGEN_SPHEREMAP + D3DVTXPCAPS_TEXGEN_SPHEREMAP + + + + No documentation. + + + D3DVTXPCAPS_NO_TEXGEN_NONLOCALVIEWER + D3DVTXPCAPS_NO_TEXGEN_NONLOCALVIEWER + + + +

Vertex shader caps constants. These constants are used by the VS20Caps member of .

+
+ + bb172634 + D3DVS20CAPS + D3DVS20CAPS +
+ + + No documentation. + + + D3DVS20CAPS_PREDICATION + D3DVS20CAPS_PREDICATION + + + + None. + + + None + None + + + +

Vertex texture sampler constants.

These constants identify the texture samplers used by vertex shaders.

+
+ + bb172631 + D3DVERTEXTEXTURESAMPLER + D3DVERTEXTEXTURESAMPLER +
+ + + No documentation. + + + D3DVERTEXTEXTURESAMPLER0 + D3DVERTEXTEXTURESAMPLER0 + + + + No documentation. + + + D3DVERTEXTEXTURESAMPLER1 + D3DVERTEXTEXTURESAMPLER1 + + + + No documentation. + + + D3DVERTEXTEXTURESAMPLER2 + D3DVERTEXTEXTURESAMPLER2 + + + + No documentation. + + + D3DVERTEXTEXTURESAMPLER3 + D3DVERTEXTEXTURESAMPLER3 + + + + No documentation. + + + D3DVERTEXTEXTURESAMPLERMAPSAMPLER + D3DVERTEXTEXTURESAMPLERMAPSAMPLER + + + +

Specifies the type of I/O bus used by the graphics adapter.

+
+ +

As many as three flags can be set. Flags in the range 0x00 through 0x04 (D3DBUSTYPE_Xxx) provide the basic bus type. Flags in the range 0x10000 through 0x50000 (D3DBUSIMPL_MODIFIER_Xxx) modify the basic description. The driver sets one bus-type flag, and can set zero or one modifier flag. If the driver sets a modifier flag, it also sets the flag. Flags are combined with a bitwise OR.

+
+ + dd318379 + D3DBUSTYPE + D3DBUSTYPE +
+ + +

Indicates a type of bus other than the types listed here. +

+
+ + dd318379 + D3DBUSTYPE_OTHER + D3DBUSTYPE_OTHER +
+ + +

PCI bus. +

+
+ + dd318379 + D3DBUSTYPE_PCI + D3DBUSTYPE_PCI +
+ + +

PCI-X bus. +

+
+ + dd318379 + D3DBUSTYPE_PCIX + D3DBUSTYPE_PCIX +
+ + +

PCI Express bus. +

+
+ + dd318379 + D3DBUSTYPE_PCIEXPRESS + D3DBUSTYPE_PCIEXPRESS +
+ + +

Accelerated Graphics Port (AGP) bus. +

+
+ + dd318379 + D3DBUSTYPE_AGP + D3DBUSTYPE_AGP +
+ + +

The implementation for the graphics adapter is in a motherboard chipset's north bridge. This flag implies that data never goes over an expansion bus (such as PCI or AGP) when it is transferred from main memory to the graphics adapter.

+
+ + dd318379 + D3DBUSIMPL_MODIFIER_INSIDE_OF_CHIPSET + D3DBUSIMPL_MODIFIER_INSIDE_OF_CHIPSET +
+ + +

Indicates that the graphics adapter is connected to a motherboard chipset's north bridge by tracks on the motherboard and all of the graphics adapter's chips are soldered to the motherboard. This flag implies that data never goes over an expansion bus (such as PCI or AGP) when it is transferred from main memory to the graphics adapter.

+
+ + dd318379 + D3DBUSIMPL_MODIFIER_TRACKS_ON_MOTHER_BOARD_TO_CHIP + D3DBUSIMPL_MODIFIER_TRACKS_ON_MOTHER_BOARD_TO_CHIP +
+ + +

The graphics adapter is connected to a motherboard chipset's north bridge by tracks on the motherboard, and all of the graphics adapter's chips are connected through sockets to the motherboard. +

+
+ + dd318379 + D3DBUSIMPL_MODIFIER_TRACKS_ON_MOTHER_BOARD_TO_SOCKET + D3DBUSIMPL_MODIFIER_TRACKS_ON_MOTHER_BOARD_TO_SOCKET +
+ + +

The graphics adapter is connected to the motherboard through a daughterboard connector. +

+
+ + dd318379 + D3DBUSIMPL_MODIFIER_DAUGHTER_BOARD_CONNECTOR + D3DBUSIMPL_MODIFIER_DAUGHTER_BOARD_CONNECTOR +
+ + +

The graphics adapter is connected to the motherboard through a daughterboard connector, and the graphics adapter is inside an enclosure that is not user accessible. +

+
+ + dd318379 + D3DBUSIMPL_MODIFIER_DAUGHTER_BOARD_CONNECTOR_INSIDE_OF_NUAE + D3DBUSIMPL_MODIFIER_DAUGHTER_BOARD_CONNECTOR_INSIDE_OF_NUAE +
+ + +

One of the D3DBUSIMPL_MODIFIER_MODIFIER_Xxx flags is set. +

+
+ + dd318379 + D3DBUSIMPL_MODIFIER_NON_STANDARD + D3DBUSIMPL_MODIFIER_NON_STANDARD +
+ + +

Options for welding together vertices.

+
+ + bb205561 + _D3DXWELDEPSILONSFLAGS + _D3DXWELDEPSILONSFLAGS +
+ + +

Weld together all vertices that are at the same location. Using this flag avoids an epsilon comparison between vertex components.

+
+ + bb205561 + D3DXWELDEPSILONS_WELDALL + D3DXWELDEPSILONS_WELDALL +
+ + +

If a given vertex component is within epsilon, modify partially matched vertices so that both components are identical. If all components are equal, remove one of the vertices.

+
+ + bb205561 + D3DXWELDEPSILONS_WELDPARTIALMATCHES + D3DXWELDEPSILONS_WELDPARTIALMATCHES +
+ + +

Instructs the weld to allow only modifications to vertices and not removal. This flag is valid only if is set. It is useful to modify vertices to be equal, but not to allow vertices to be removed.

+
+ + bb205561 + D3DXWELDEPSILONS_DONOTREMOVEVERTICES + D3DXWELDEPSILONS_DONOTREMOVEVERTICES +
+ + +

Instructs the weld not to split vertices that are in separate attribute groups. When the method is called with the flag, then the flag will also be set. Setting this flag can slow down software vertex processing.

+
+ + bb205561 + D3DXWELDEPSILONS_DONOTSPLIT + D3DXWELDEPSILONS_DONOTSPLIT +
+ + + No documentation. + + + D3DXF_FILEFORMAT2 + D3DXF_FILEFORMAT2 + + + + No documentation. + + + D3DXF_FILEFORMAT_BINARY + D3DXF_FILEFORMAT_BINARY + + + + No documentation. + + + D3DXF_FILEFORMAT_TEXT + D3DXF_FILEFORMAT_TEXT + + + + No documentation. + + + D3DXF_FILEFORMAT_COMPRESSED + D3DXF_FILEFORMAT_COMPRESSED + + + + No documentation. + + + D3DZBUFFERTYPE + D3DZBUFFERTYPE + + + + No documentation. + + + D3DZB_FALSE + D3DZB_FALSE + + + + No documentation. + + + D3DZB_TRUE + D3DZB_TRUE + + + + No documentation. + + + D3DZB_USEW + D3DZB_USEW + + + + Functions + + + + + Constant SdkVersion. + D3D_SDK_VERSION + + + +

Creates an object and returns an interface to it.

+
+ No documentation. + No documentation. +
  • if Direct3DEx features are not supported (no WDDM driver is installed) or if the SDKVersion does not match the version of the DLL.
  • D3DERR_OUTOFMEMORY if out-of-memory conditions are detected when creating the enumerator object.
  • if the creation of the enumerator object is successful.
+ +

The object is the first object that the application creates and the last object thta the application releases. Functions for enumerating and retrieving capabilities of a device are accessible through the object. This enables applications to select devices without creating them.

The interface supports enumeration of active display adapters and allows the creation of objects. If the user dynamically adds adapters (either by adding devices to the desktop, or by hot-docking a laptop), these devices are not included in the enumeration. Creating a new interface will expose the new devices.

Pass the flag to this function to ensure that header files used in the compiled application match the version of the installed runtime DLLs. is changed in the runtime only when a header or another code change would require rebuilding the application. If this function fails, it indicates that the versions of the header file and the runtime DLL do not match.

Note??Direct3DCreate9Ex is supported only in Windows Vista, Windows Server 2008, and Windows 7. Earlier versions of the D3D9.dll library do not include Direct3D9Ex and Direct3DCreate9Ex.

+
+ + bb219676 + HRESULT Direct3DCreate9Ex([In] unsigned int SDKVersion,[Out, Fast] IDirect3D9Ex** arg1) + Direct3DCreate9Ex +
+ + +

Create an object and return an interface to it.

+
+

The value of this parameter should be . See Remarks.

+

If successful, this function returns a reference to an interface; otherwise, a null reference is returned.

+ +

The Direct3D object is the first Direct3D COM object that your graphical application needs to create and the last object that your application needs to release. Functions for enumerating and retrieving capabilities of a device are accessible through the Direct3D object. This enables applications to select devices without creating them.

Create an object as shown here:

 LPDIRECT3D9 g_pD3D = null; if( null == (g_pD3D = Direct3DCreate9())) return E_FAIL;	
+            

The interface supports enumeration of active display adapters and allows the creation of objects. If the user dynamically adds adapters (either by adding devices to the desktop, or by hot-docking a laptop), those devices will not be included in the enumeration. Creating a new interface will expose the new devices.

is passed to this function to ensure that the header files against which an application is compiled match the version of the runtime DLL's that are installed on the machine. is only changed in the runtime when a header change (or other code change) would require an application to be rebuilt. If this function fails, it indicates that the header file version does not match the runtime DLL version.

For an example, see Creating a Device (Direct3D 9).

+
+ + bb219685 + IDirect3D9* Direct3DCreate9([In] unsigned int SDKVersion) + Direct3DCreate9 +
+ + + Functions + + + + + Constant Version. + D3DX_VERSION + + + Constant SdkVersion. + D3DX_SDK_VERSION + + + +

Mark an instantaneous event. PIX can use this event to trigger an action.

+
+
Event color. This is the color to display the event in the event view.
+
Event name.
+ +

Instantaneous user events do not bracket or group other events. For example, when the user fires a weapon in a game, a Shot Fired event could be created by a call. To group together multiple events under a single, user-defined name, use and rather than .

+
+ + microsoft.directx_sdk.reference.d3dperf_setmarker + void D3DPERF_SetMarker([In] D3DCOLOR col,[In] const wchar_t* wszName) + D3DPERF_SetMarker +
+ + +

Set profiler options specified by the target program.

+
+
User options recognizable by PIX. Set this to 1 to notify PIX that the target program does not give permission to be profiled.
+ + ee416584 + void D3DPERF_SetOptions([In] unsigned int dwOptions) + D3DPERF_SetOptions +
+ + +

Determine the current state of the profiler from the target program.

+
+

Returns a non-zero value when PIX is profiling the target program; otherwise, returns zero.

+ + ee416581 + unsigned int D3DPERF_GetStatus() + D3DPERF_GetStatus +
+ + +

Mark a series of frames with the specified color and name in the PIXRun file. This function is not currently supported by PIX.

+
+
Event color.
+
Event name or marker name.
+ +

To make analysis easier, the target program can use color to mark each level of a target program.

+
+ + ee416585 + void D3DPERF_SetRegion([In] D3DCOLOR col,[In] const wchar_t* wszName) + D3DPERF_SetRegion +
+ + +

Mark the end of a user-defined event. PIX can use this event to trigger an action.

+
+

The level of the hierarchy in which the event is ending. If an error occurs, this value is negative.

+ + ee416580 + int D3DPERF_EndEvent() + D3DPERF_EndEvent +
+ + +

Marks the beginning of a user-defined event. PIX can use this event to trigger an action.

+
+
Event color. This is the color to display the event in the event view.
+
Event name.
+

The zero-based level of the hierarchy that this event is starting in. If an error occurs, the return value will be negative.

+ +

User-defined events group together other events in a way that is meaningful to the target program so that they can be better represented in performance profiling tools. For example, a Draw Spaceship event might bracket a number of Direct3D calls that handle drawing a spaceship in a game. Events can be nested.

Each call should have a matching call. Instantaneous events (which do not bracket other events) should be labeled by using rather than by and .

+
+ + ee416579 + int D3DPERF_BeginEvent([In] D3DCOLOR col,[In] const wchar_t* wszName) + D3DPERF_BeginEvent +
+ + +

Determine whether a performance profiler is requesting that the current frame be resubmitted to Direct3D for performance analysis. This function is not currently supported by PIX.

+
+

If the return value is TRUE, the caller should repeat the same sequence of calls. If , the caller should continue.

+ +

The function should be called immediately after is called.

+
+ + microsoft.directx_sdk.reference.d3dperf_queryrepeatframe + BOOL D3DPERF_QueryRepeatFrame() + D3DPERF_QueryRepeatFrame +
+ + +

Adds a child frame to a frame.

+
+

Pointer to the parent node.

+

Pointer to the child node.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + Bb172846 + HRESULT D3DXFrameAppendChild([In] D3DXFRAME* pFrameParent,[In] const D3DXFRAME* pFrameChild) + D3DXFrameAppendChild +
+ + +

Loads the first frame hierarchy from a .x file.

+
+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Combination of one or more flags from the D3DXMESH enumeration that specify creation options for the mesh.

+

Pointer to an interface, the device object associated with the mesh.

+

Pointer to an interface.

+

Application provided interface that allows loading of user data. See .

+

Returns a reference to the loaded frame hierarchy. See .

+

Returns a reference to the animation controller corresponding to animation in the .x file. This is created with default tracks and events. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXLoadMeshHierarchyFromXA.

All the meshes in the file will be collapsed into one output mesh. If the file contains a frame hierarchy, all the transformations will be applied to the mesh.

loads the animation data and frame hierarchy from a .x file. It scans the .x file and builds a frame hierarchy and animation controller according to the -derived object passed to it through pAlloc. Loading the data requires several steps as follows:

  1. Derive , implementing each method. This controls how frames and meshes are allocated and freed.
  2. Derive , implementing each method. If your .x file has no embedded user-defined data, or if you do not need it, you can skip this part.
  3. Create an object of your class, and optionally of your LoadUserData class. You do not need to call any methods of these objects yourself.
  4. Call , passing in your object and your object (or null) to create the frame hierarchy and animation controller. All the animation sets and frames are automatically registered to the animation controller.

During the load, CreateFrame and LoadFrameChildData are called back on each frame to control loading and allocation of the frame. The application defines these methods to control how frames are stored. CreateMeshContainer and LoadMeshChildData are called back on each mesh object to control loading and allocation of mesh objects. LoadTopLevelData is called back for each top level object that doesn't get loaded by the other methods.

To free this data, call ID3DXAnimationController::Release to free the animation sets, and D3DXFRAMEDestroy, passing in the root node of the frame hierarchy and an object of your derived class. DestroyFrame and DestroyMeshContainer will each be called for every frame and mesh object in the frame hierarchy. Your implementation of DestroyFrame should release everything allocated by CreateFrame, and likewise for the mesh container methods.

+
+ + bb172894 + HRESULT D3DXLoadMeshHierarchyFromXW([In] const wchar_t* Filename,[In] unsigned int MeshOptions,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXAllocateHierarchy* pAlloc,[In] ID3DXLoadUserData* pUserDataLoader,[In] D3DXFRAME** ppFrameHierarchy,[In] ID3DXAnimationController** ppAnimController) + D3DXLoadMeshHierarchyFromXW +
+ + +

Given a frame hierarchy, registers all the named matrices in the animation mixer.

+
+

The top level node in the frame hierarchy.

+

Pointer to the animation controller object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb172851 + HRESULT D3DXFrameRegisterNamedMatrices([In] D3DXFRAME* pFrameRoot,[In] ID3DXAnimationController* pAnimController) + D3DXFrameRegisterNamedMatrices +
+ + +

Loads the first frame hierarchy from a .x file.

+
+

Pointer to a buffer that contains the mesh hierarchy.

+

Size of the pMemory buffer, in bytes.

+

Combination of one or more flags from the D3DXMESH enumeration that specify creation options for the mesh.

+

Pointer to an interface, the device object associated with the mesh.

+

Pointer to an interface.

+

Application provided interface that allows loading of user data. See .

+

Returns a reference to the loaded frame hierarchy. See .

+

Returns a reference to the animation controller corresponding to animation in the .x file. This is created with default tracks and events. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

All the meshes in the file will be collapsed into one output mesh. If the file contains a frame hierarchy, all the transformations will be applied to the mesh.

+
+ + bb172895 + HRESULT D3DXLoadMeshHierarchyFromXInMemory([In] const void* Memory,[In] unsigned int SizeOfMemory,[In] unsigned int MeshOptions,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXAllocateHierarchy* pAlloc,[In] ID3DXLoadUserData* pUserDataLoader,[In] D3DXFRAME** ppFrameHierarchy,[In] ID3DXAnimationController** ppAnimController) + D3DXLoadMeshHierarchyFromXInMemory +
+ + +

Creates a key framed animation set interface that stores key frame data in a compressed format.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb172754 + HRESULT D3DXCreateCompressedAnimationSet([In] const char* pName,[In] double TicksPerSecond,[In] D3DXPLAYBACK_TYPE Playback,[In] ID3DXBuffer* pCompressedData,[In] unsigned int NumCallbackKeys,[In] const D3DXKEY_CALLBACK* pCallbackKeys,[In] ID3DXCompressedAnimationSet** ppAnimationSet) + D3DXCreateCompressedAnimationSet +
+ + +

Creates a .x file and saves the mesh hierarchy and corresponding animations in it.

+
+

Pointer to a string that specifies the name of the .x file identifying the saved mesh. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Format of the .x file (text or binary, compressed or not). See . can be combined (using a logical OR) with either the or flags to reduce the output file size.

+

Root node of the hierarchy to be saved. See .

+

Animation controller that has animation sets to be stored. See .

+

Application-provided interface that allows saving of user data. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be: .

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXSaveMeshHierarchyToFileA.

This function does not save compressed animation sets.

+
+ + bb205427 + HRESULT D3DXSaveMeshHierarchyToFileW([In] const wchar_t* Filename,[In] unsigned int XFormat,[In] const D3DXFRAME* pFrameRoot,[In] ID3DXAnimationController* pAnimController,[In] ID3DXSaveUserData* pUserDataSaver) + D3DXSaveMeshHierarchyToFileW +
+ + +

Computes the bounding sphere of all the meshes in the frame hierarchy.

+
+

Pointer to the root node.

+

Returns the center of the bounding sphere.

+

Returns the radius of the bounding sphere.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb172847 + HRESULT D3DXFrameCalculateBoundingSphere([In] const D3DXFRAME* pFrameRoot,[In] D3DXVECTOR3* pObjectCenter,[In] float* pObjectRadius) + D3DXFrameCalculateBoundingSphere +
+ + +

Creates an animation controller object.

+
+

Maximum number of animation outputs the controller can support.

+

Maximum number of animation sets that can be mixed.

+

Maximum number of animation sets that can be mixed simultaneously.

+

Maximum number of outstanding events that the controller will support.

+

Pointer to the animation controller object created. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

An animation controller controls an animation mixer. The controller adds methods to modify blending parameters over time to enable smooth transitions.

+
+ + bb172751 + HRESULT D3DXCreateAnimationController([In] unsigned int MaxNumMatrices,[In] unsigned int MaxNumAnimationSets,[In] unsigned int MaxNumTracks,[In] unsigned int MaxNumEvents,[In] ID3DXAnimationController** ppAnimController) + D3DXCreateAnimationController +
+ + +

Finds the child frame of a root frame.

+
+

Pointer to the root frame. See .

+

Name of the child frame to find.

+

Returns the child frame if it is found, or null otherwise. See .

+ + bb172849 + D3DXFRAME* D3DXFrameFind([In] const D3DXFRAME* pFrameRoot,[In] const char* Name) + D3DXFrameFind +
+ + +

Creates a key framed animation set interface.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + Bb172776 + HRESULT D3DXCreateKeyframedAnimationSet([In] const char* pName,[In] double TicksPerSecond,[In] D3DXPLAYBACK_TYPE Playback,[In] unsigned int NumAnimations,[In] unsigned int NumCallbackKeys,[In] const D3DXKEY_CALLBACK* pCallbackKeys,[In] ID3DXKeyframedAnimationSet** ppAnimationSet) + D3DXCreateKeyframedAnimationSet +
+ + +

Destroys the subtree of frames under the root, including the root.

+
+

Pointer to the root node.

+

Allocation interface used to deallocate nodes of the frame hierarchy.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb172848 + HRESULT D3DXFrameDestroy([In] D3DXFRAME* pFrameRoot,[In] ID3DXAllocateHierarchy* pAlloc) + D3DXFrameDestroy +
+ + +

Counts number of frames in a subtree that have non-null names.

+
+

Pointer to the root node of the subtree.

+

Returns the frame count.

+ + bb172850 + unsigned int D3DXFrameNumNamedMatrices([In] const D3DXFRAME* pFrameRoot) + D3DXFrameNumNamedMatrices +
+ + +

Creates a render environment map.

+
+

Pointer to an interface, which is the device to associate with the render surface.

+

Size of the render surface.

+

The number of mipmap levels.

+

Member of the enumerated type that describes the pixel format of the environment map.

+

If TRUE, the render surface supports a depth-stencil surface. Otherwise, this member is set to .

+

If DepthStencil is set to TRUE, this parameter is a member of the enumerated type that describes the depth-stencil format of the environment map.

+

Address of a reference to an interface that represents the created render environment map.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb172790 + HRESULT D3DXCreateRenderToEnvMap([In] IDirect3DDevice9* pDevice,[In] unsigned int Size,[In] unsigned int MipLevels,[In] D3DFORMAT Format,[In] BOOL DepthStencil,[In] D3DFORMAT DepthStencilFormat,[In] ID3DXRenderToEnvMap** ppRenderToEnvMap) + D3DXCreateRenderToEnvMap +
+ + +

Returns the driver level.

+
+

Pointer to an interface representing the device.

+

The driver level. See remarks.

+ +

This method returns the driver version, which is one of the following:

  • 700 - Direct3D 7 level driver
  • 800 - Direct3D 8 level driver
  • 900 - Direct3D 9 level driver
+
+ + bb172865 + unsigned int D3DXGetDriverLevel([In] IDirect3DDevice9* pDevice) + D3DXGetDriverLevel +
+ + +

Creates a font object for a device and font.

+
+

Pointer to an interface, the device to be associated with the font object.

+

The height of the characters in logical units.

+

The width of the characters in logical units.

+

Typeface weight. One example is bold.

+

The number of mipmap levels.

+

True for italic font, false otherwise.

+

The character set of the font.

+

Specifies how Windows should attempt to match the desired font sizes and characteristics with actual fonts. Use OUT_TT_ONLY_PRECIS for instance, to ensure that you always get a TrueType font.

+

Specifies how Windows should match the desired font with a real font. It applies to raster fonts only and should not affect TrueType fonts.

+

Pitch and family index.

+

String containing the typeface name. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Returns a reference to an interface, representing the created font object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The creation of an object requires that the device supports 32-bit color.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateFontA because ANSI strings are being used.

If you want more information about font parameters, see The Logical Font.

+
+ + bb172773 + HRESULT D3DXCreateFontW([In] IDirect3DDevice9* pDevice,[In] int Height,[In] unsigned int Width,[In] unsigned int Weight,[In] unsigned int MipLevels,[In] BOOL Italic,[In] unsigned int CharSet,[In] unsigned int OutputPrecision,[In] unsigned int Quality,[In] unsigned int PitchAndFamily,[In] const wchar_t* pFaceName,[Out, Fast] ID3DXFont** ppFont) + D3DXCreateFontW +
+ + +

Creates a render surface.

+
+

Pointer to an interface, the device to be associated with the render surface.

+

Width of the render surface, in pixels.

+

Height of the render surface, in pixels.

+

Member of the enumerated type, describing the pixel format of the render surface.

+

If TRUE, the render surface supports a depth-stencil surface. Otherwise, this member is set to . This function will create a new depth buffer.

+

If DepthStencil is set to TRUE, this parameter is a member of the enumerated type, describing the depth-stencil format of the render surface.

+

Address of a reference to an interface, representing the created render surface.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb172791 + HRESULT D3DXCreateRenderToSurface([In] IDirect3DDevice9* pDevice,[In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] BOOL DepthStencil,[In] D3DFORMAT DepthStencilFormat,[Out, Fast] ID3DXRenderToSurface** ppRenderToSurface) + D3DXCreateRenderToSurface +
+ + +

Creates a sprite object which is associated with a particular device. Sprite objects are used to draw 2D images to the screen.

+
+

Pointer to an interface, the device to be associated with the sprite.

+

Address of a reference to an interface. This interface allows the user to access sprite functions.

+

If the function succeeds, the return value is .If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This interface can be used to draw two dimensional images in screen space of the associated device.

+
+ + bb172797 + HRESULT D3DXCreateSprite([In] IDirect3DDevice9* pDevice,[Out, Fast] ID3DXSprite** ppSprite) + D3DXCreateSprite +
+ + +

Creates a font object indirectly for both a device and a font.

+
+

Pointer to an interface, the device to be associated with the font object.

+

Pointer to a structure, describing the attributes of the font object to create. If the compiler settings require Unicode, the data type resolves to ; otherwise, the data type resolves to D3DXFONT_DESCA. See Remarks.

+

Returns a reference to an interface, representing the created font object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateFontIndirectA because ANSI strings are being used.

+
+ + bb172774 + HRESULT D3DXCreateFontIndirectW([In] IDirect3DDevice9* pDevice,[In] const D3DXFONT_DESCW* pDesc,[Out, Fast] ID3DXFont** ppFont) + D3DXCreateFontIndirectW +
+ + +

Uses a left-handed coordinate system to create a line.

+
+

Pointer to an interface, representing the device associated with the created box mesh.

+

Pointer to an interface.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function creates a mesh with the creation option and | Flexible Vertex Format (FVF).

+
+ + bb172778 + HRESULT D3DXCreateLine([In] IDirect3DDevice9* pDevice,[Out, Fast] ID3DXLine** ppLine) + D3DXCreateLine +
+ + +

Turns on or off all D3DX debug output.

+
+

If TRUE, debugger output is halted; if , debug output is enabled.

+

Returns the previous value of Mute.

+ + bb172817 + BOOL D3DXDebugMute([In] BOOL Mute) + D3DXDebugMute +
+ + +

Verify that the version of D3DX you compiled with is the version that you are running.

+
+

Use . See remarks.

+

Use . See remarks.

+

Returns TRUE if the version of D3DX you compiled against is the version you are running with; otherwise, is returned.

+ +

Use this function during the initialization of your application like this:

  CD3DXMyApplication::Initialize( hInstance,  LPCSTR szWindowName, LPCSTR szClassName, UINT uWidth, UINT uHeight)	
+            {  hr; if (!(, )) return E_FAIL; ...	
+            }	
+            

Use Direct3DCreate9 to verify that the correct runtime is installed.

+
+ + bb172717 + BOOL D3DXCheckVersion([In] unsigned int D3DSdkVersion,[In] unsigned int D3DXSdkVersion) + D3DXCheckVersion +
+ + +

Create an effect from an ASCII or binary effect description.

+
+

Pointer to the device that will create the effect. See .

+

Pointer to a buffer containing an effect description.

+

Length of the effect data, in bytes.

+

An optional null-terminated array of structures that describe preprocessor definitions. This value can be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

If pSrcData contains a text effect, flags can be a combination of Flags and flags; otherwise, pSrcData contains a binary effect and the only flags honored are flags. The Direct3D 10 HLSL compiler is now the default. See Effect-Compiler Tool for details.

+

Pointer to a object to use for shared parameters. If this value is null, no parameters will be shared.

+

Returns a reference to an interface.

+

Returns a buffer containing a listing of compile errors.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172763 + HRESULT D3DXCreateEffect([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + D3DXCreateEffect +
+ + +

Disassemble an effect.

+
+

Pointer to an interface that contains the effect.

+

Enable color coding to make the disassembly easier to read.

+

Returns a buffer containing the disassembled shader. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172819 + HRESULT D3DXDisassembleEffect([In] ID3DXEffect* pEffect,[In] BOOL EnableColorCode,[In] ID3DXBuffer** ppDisassembly) + D3DXDisassembleEffect +
+ + +

Create an effect from an ASCII or binary effect description. This is an extended version of that allows an application to control which parameters are ignored by the effects system.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function is an extended version of that allows an application to specify which effect constants will be managed by the application. A constant that is managed by the application is ignored by the effects system. That is, the application is responsible for initializing the constant as well as saving and restoring its state whenever appropriate.

This function checks each constant in pSkipConstants to see that:

  • It is bound to a constant register.
  • It is only used in HLSL shader code.

If a constant is named in the string that is not present in the effect, it is ignored.

If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the LPCTSTR data type resolves to LPCSTR.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateEffectFromResourceA because ANSI strings are being used.

loads data from a resource of type RT_RCDATA. See MSDN for more information about Windows resources.

+
+ + bb172771 + HRESULT D3DXCreateEffectFromResourceExW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + D3DXCreateEffectFromResourceExW +
+ + +

Create an effect from an ASCII or binary effect description.

+
+

Pointer to the device.

+

Handle to a module containing the effect description. If this parameter is null, the current module will be used.

+

Pointer to the resource. This parameter supports both Unicode and ANSI strings. See Remarks.

+

An optional null-terminated array of structures that describe preprocessor definitions. This value can be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

If hSrcModule contains a text effect, flags can be a combination of Flags and flags; otherwise, hSrcModule contains a binary effect and the only flags honored are flags. The Direct3D 10 HLSL compiler is now the default. See Effect-Compiler Tool for details.

+

Pointer to a object to use for shared parameters. If this value is null, no parameters will be shared.

+

Returns a buffer containing the compiled effect.

+

Returns a buffer containing a listing of compile errors.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the LPCTSTR data type resolves to LPCSTR.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateEffectFromResourceA because ANSI strings are being used.

loads data from a resource of type RT_RCDATA. See MSDN for more information about Windows resources.

+
+ + bb172770 + HRESULT D3DXCreateEffectFromResourceW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + D3DXCreateEffectFromResourceW +
+ + +

Creates an effect compiler from an ASCII effect description.

+
+

Pointer to a buffer containing an effect description.

+

Length, in bytes, of the effect data.

+

An optional null-terminated array of structures that describe preprocessor definitions. This value can be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Compile options identified by various flags (see Flags). The Direct3D 10 HLSL compiler is now the default. See Effect-Compiler Tool for details.

+

Address of a reference to an interface containing the effect compiler.

+

Address of a reference to an interface containing any error messages that occurred during compilation. This parameter can be set to null to ignore error messages.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb172764 + HRESULT D3DXCreateEffectCompiler([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[Out, Fast] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + D3DXCreateEffectCompiler +
+ + +

Create an effect from an ASCII or binary effect description. This function is an extended version of that allows an application to control which parameters are ignored by the effects system.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function is an extended version of that allows an application to specify which effect constants will be managed by the application. A constant that is managed by the application is ignored by the effects system. That is, the application is responsible for initializing the constant as well as saving and restoring its state whenever appropriate.

This function checks each constant in pSkipConstants to see that:

  • It is bound to a constant register.
  • It is only used in HLSL shader code.

If a constant is named in the string that is not present in the effect, it is ignored.

If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the LPCTSTR data type resolves to LPCSTR.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateEffectFromFileA because ANSI strings are being used.

+
+ + bb172769 + HRESULT D3DXCreateEffectFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + D3DXCreateEffectFromFileExW +
+ + +

Creates an effect compiler from an ASCII effect description.

+
+

Pointer to the filename. This parameter supports both Unicode and ANSI strings. See Remarks.

+

An optional null-terminated array of structures that describe preprocessor definitions. This value can be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Compile options identified by various flags (see Flags). The Direct3D 10 HLSL compiler is now the default. See Effect-Compiler Tool for details.

+

Address of a reference to an interface, containing the effect compiler.

+

Address of a reference to an interface, containing any error messages that occurred during compilation. This parameter can be set to null to ignore error messages.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the LPCTSTR data type resolves to LPCSTR.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateEffectCompilerFromFileA because ANSI strings are being used.

+
+ + bb172765 + HRESULT D3DXCreateEffectCompilerFromFileW([In] const wchar_t* pSrcFile,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + D3DXCreateEffectCompilerFromFileW +
+ + +

Creates an from an ASCII effect description.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the LPCTSTR data type resolves to LPCSTR.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateEffectCompilerFromResourceA because ANSI strings are being used.

+
+ + bb172766 + HRESULT D3DXCreateEffectCompilerFromResourceW([In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXEffectCompiler** ppCompiler,[In] ID3DXBuffer** ppParseErrors) + D3DXCreateEffectCompilerFromResourceW +
+ + +

Create an effect from an ASCII or binary effect description.

+
+

Pointer to the device that will create the effect. See .

+

Pointer to the filename. This parameter supports both Unicode and ANSI strings. See Remarks.

+

Optional null-terminated array of preprocessor macro definitions. See .

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

If pSrcFile contains a text effect, flags can be a combination of Flags and flags; otherwise, pSrcFile contains a binary effect and the only flags honored are flags. The Direct3D 10 HLSL compiler is now the default. See Effect-Compiler Tool for details.

+

Pointer to a object to use for shared parameters. If this value is null, no parameters will be shared.

+

Returns a reference to a buffer containing the compiled effect. See .

+

Returns a reference to a buffer containing a listing of compile errors. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the LPCTSTR data type resolves to LPCSTR.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateEffectFromFileA because ANSI strings are being used.

+
+ + bb172768 + HRESULT D3DXCreateEffectFromFileW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + D3DXCreateEffectFromFileW +
+ + +

Create an effect pool. A pool is used to share parameters between effects.

+
+

Returns a reference to the created pool.

+

If the method succeeds, the return value is .

If the arguments are invalid, the method will return .

If the method fails, the return value will be E_FAIL.

+ +

For effects within a pool, shared parameters with the same name share values.

+
+ + bb172772 + HRESULT D3DXCreateEffectPool([Out, Fast] ID3DXEffectPool** ppPool) + D3DXCreateEffectPool +
+ + +

Creates an effect from an ASCII or binary effect description. This function is an extended version of that allows an application to control which parameters are ignored by the effects system.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function is an extended version of that allows an application to specify which effect constants will be managed by the application. A constant that is managed by the application is ignored by the effects system. That is, the application is responsible for initializing the constant as well as saving and restoring its state whenever appropriate.

This function checks each constant in pSkipConstants to see that:

  • It is bound to a constant register.
  • It is only used in HLSL shader code.

If a constant is named in the string that is not present in the effect, it is ignored.

+
+ + bb172767 + HRESULT D3DXCreateEffectEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pSkipConstants,[In] unsigned int Flags,[In] ID3DXEffectPool* pPool,[In] ID3DXEffect** ppEffect,[In] ID3DXBuffer** ppCompilationErrors) + D3DXCreateEffectEx +
+ + +

Saves a mesh to a .x file.

+
+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Pointer to an interface, representing the mesh to save to a .x file.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh. This parameter may be null.

+

Pointer to an array of structures, containing material information to be saved in the .x file.

+

Pointer to an array of effect instances, one per attribute group in the mesh. This parameter may be null. An effect instance is a particular instance of state information used to initialize an effect. For more information, see .

+

Number of structures in the pMaterials array.

+

A combination of file format and save options when saving an .x file. See D3DX X File Constants.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: .

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXSaveMeshToXA because ANSI strings are being used.

The default file format is binary; however, if a file is specified as both a binary and a text file, it will be saved as a text file. Regardless of the file format, you may also use the compressed format to reduce the file size.

The following is a typical code example of how to use this function.

 *    m_pMesh;           // Mesh object to be saved to a .x file	
+            * m_pMaterials;      // Array of material structs in the mesh	
+            DWORD         m_dwNumMaterials;  // Number of material structs in the mesh DWORD dwFormat = ;  // Binary-format .x file (default)	
+            // DWORD dwFormat = ; // Text-format .x file // Load mesh into m_pMesh and determine values of m_pMaterials and 	
+            // m_dwNumMaterials with calls to D3DXLoadMeshxxx or other D3DX functions // ... ( L"outputxfilename.x", m_pMesh, null, m_pMaterials, null, m_dwNumMaterials, dwFormat );	
+            
+
+ + bb205428 + HRESULT D3DXSaveMeshToXW([In] const wchar_t* pFilename,[In] ID3DXMesh* pMesh,[In] const unsigned int* pAdjacency,[In] const D3DXMATERIAL* pMaterials,[In] const D3DXEFFECTINSTANCE* pEffectInstances,[In] unsigned int NumMaterials,[In] unsigned int Format) + D3DXSaveMeshToXW +
+ + +

Returns a declarator from a flexible vertex format (FVF) code.

+
+

Combination of that describes the FVF from which to generate the returned declarator array.

+

An array of elements describing the vertex format of the mesh vertices. The upper limit of this declarator array is .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: D3DXERR_INVALIDMESH.

+ + bb172818 + HRESULT D3DXDeclaratorFromFVF([In] D3DFVF FVF,[In, Buffer] D3DVERTEXELEMENT9* pDeclarator) + D3DXDeclaratorFromFVF +
+ + +

Compute tangent, binormal, and normal vectors for a mesh.

+
+

Pointer to an input mesh object.

+

Combination of one or more flags.

Use null to specify the following options:

  • Weight the normal vector length by the angle, in radians, subtended by the two edges leaving the vertex.
  • Compute orthogonal Cartesian coordinates from the UV texture coordinates.
  • Textures are not wrapped in either U or V directions
  • Partial derivatives with respect to texture coordinates are normalized.
  • Vertices are ordered in a counterclockwise direction around each triangle.
  • Use per-vertex normal vectors already present in the input mesh.
  • The results will be stored in the original input mesh. The function will fail if new vertices need to be created.
+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function simply calls with the following input parameters:

 (pMesh, , 0,    , 0, , 0,  , 0,  dwOptions | , null, 0.01f, 0.25f, 0.01f, null, null);	
+            

Singularities are handled as required by grouping edges and splitting vertices. If any vertices need to be split, the function will fail. The computed normal vector at each vertex is always normalized to have unit length.

The most robust solution for computing orthogonal Cartesian coordinates is to not set flags and , so that orthogonal coordinates are computed from both UV texture coordinates. However, in this case, if either U or V is zero, then the function will compute orthogonal coordinates using or respectively.

+
+ + bb172744 + HRESULT D3DXComputeTangentFrame([In] ID3DXMesh* pMesh,[In] unsigned int dwOptions) + D3DXComputeTangentFrame +
+ + +

Generates an optimized face remapping for a triangle list.

+
+

Pointer to triangle list indices to use for ordering vertices.

+

Number of faces in the triangle list. For 16-bit meshes, this is limited to 2^16 - 1 (65535) or fewer faces.

+

Number of vertices referenced by the triangle list.

+

Flag indicating index type: TRUE if indices are 32-bit (more than 65535 indices), if indices are 16-bit (65535 or fewer indices).

+

Pointer to the original mesh face that was split to generate the current face.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This function's optimization procedure is functionally equivalent to calling with the flag, but this function makes more efficient use of vertex caches.

+
+ + bb205376 + HRESULT D3DXOptimizeFaces([In] const void* pbIndices,[In] unsigned int cFaces,[In] unsigned int cVertices,[In] BOOL b32BitIndices,[In, Buffer] int* pFaceRemap) + D3DXOptimizeFaces +
+ + +

Welds together replicated vertices that have equal attributes. This method uses specified epsilon values for equality comparisons.

+
+

Pointer to an object, the mesh from which to weld vertices.

+

Combination of one or more flags from D3DXWELDEPSILONSFLAGS.

+

Pointer to a D3DXWeldEpsilons structure, specifying the epsilon values to be used for this method. Use null to initialize all structure members to a default value of 1.0e-6f.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the source mesh. If the edge has no adjacent faces, the value is 0xffffffff. If this parameter is set to null, will be called to create logical adjacency information.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the optimized mesh. If the edge has no adjacent faces, the value is 0xffffffff.

+

An array of DWORDs, one per face, that identifies the original mesh face that corresponds to each face in the welded mesh.

+

Address of a reference to an interface, which contains a DWORD for each vertex that specifies how the new vertices map to the old vertices. This remap is useful if you need to alter external data based on the new vertex mapping.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This function uses supplied adjacency information to determine the points that are replicated. Vertices are merged based on an epsilon comparison. Vertices with equal position must already have been calculated and represented by point-representative data.

This function combines logically-welded vertices that have similar components, such as normals or texture coordinates within pEpsilons.

The following example code calls this function with welding enabled. Vertices are compared using epsilon values for normal vector and vertex position. A reference is returned to a face remapping array (pFaceRemap).

 TCHAR            strMediaPath[512];       // X-file path 	
+            LPD3DXBUFFER     pAdjacencyBuffer = null; // adjacency data buffer	
+            LPD3DXBUFFER     pD3DXMtrlBuffer  = null; // material buffer	
+            LPD3DXMESH       pMesh            = null; // mesh object	
+            DWORD            m_dwNumMaterials;        // number of materials	
+             Epsilons;                // structure with epsilon values	
+            DWORD            *pFaceRemap[65536];      // face remapping array	
+            DWORD            i;                       // internal variable // Load the mesh from the specified file hr =  ( strMediaPath, , m_pd3dDevice, &pAdjacencyBuffer, &pD3DXMtrlBuffer, null, &m_dwNumMaterials, &pMesh ) ) if( FAILED( hr ) )  goto End;              // Go to error handling // Set epsilon values Epsilons.Normal = 0.001; Epsilons.Position = 0.1; // Weld the vertices for( i=0; i < 65536; i++ ) {  pFaceRemap[i] = 0;  } hr =  ( pMesh, , &Epsilons, (DWORD*)pAdjacencyBuffer->GetBufferPointer(), (DWORD*)pAdjacencyBuffer->GetBufferPointer(), (DWORD*)pFaceRemap, null ) if( FAILED( hr ) )  goto End;              // Go to error handling	
+            
+
+ + bb205562 + HRESULT D3DXWeldVertices([In] ID3DXMesh* pMesh,[In] unsigned int Flags,[In] const D3DXWELDEPSILONS* pEpsilons,[In] const unsigned int* pAdjacencyIn,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pFaceRemap,[In] ID3DXBuffer** ppVertexRemap) + D3DXWeldVertices +
+ + +

Generates an output vertex declaration from the input declaration. The output declaration is intended for use by the mesh tessellation functions.

+
+

Pointer to the output vertex declaration. See .

+

Pointer to the input vertex declaration. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: .

+ + bb172861 + HRESULT D3DXGenerateOutputDecl([In, Buffer] D3DVERTEXELEMENT9* pOutput,[In, Buffer] const D3DVERTEXELEMENT9* pInput) + D3DXGenerateOutputDecl +
+ + +

Creates a buffer object.

+
+

Size of the buffer to create, in bytes.

+

Address of a reference to an interface, representing the created buffer object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: E_OUTOFMEMORY.

+ + bb172753 + HRESULT D3DXCreateBuffer([In] unsigned int NumBytes,[In] ID3DXBuffer** ppBuffer) + D3DXCreateBuffer +
+ + +

Loads a patch mesh from an object.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

For mesh files that do not contain effect instance information, default effect instances will be generated from the material information in the .x file. A default effect instance will have default values that correspond to the members of the structure.

The default texture name is also filled in, but is handled differently. The name will be Texture0@Name, which corresponds to an effect variable by the name of "Texture0" with an annotation called "Name." This will contain the string file name for the texture.

+
+ + bb172896 + HRESULT D3DXLoadPatchMeshFromXof([In] ID3DXFileData* pXofObjMesh,[In] unsigned int Options,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXBuffer** ppMaterials,[In] ID3DXBuffer** ppEffectInstances,[In] unsigned int* pNumMaterials,[In] ID3DXPatchMesh** ppMesh) + D3DXLoadPatchMeshFromXof +
+ + +

Tessellates the given mesh using the N-patch tessellation scheme.

+
+

Pointer to an interface, representing the mesh to tessellate.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the source mesh. This parameter may be null.

+

Number of segments per edge to tessellate.

+

Set to TRUE to use quadratic interpolation for normals; set to for linear interpolation.

+

Address of a reference to an interface, representing the returned tessellated mesh.

+

Address of a reference to an interface. If the value of this parameter is not set to null, this buffer will contain an array of three DWORDs per face that specify the three neighbors for each face in the output mesh. This parameter may be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function tessellates by using the N-patch algorithm.

+
+ + bb205469 + HRESULT D3DXTessellateNPatches([In] ID3DXMesh* pMeshIn,[In] const unsigned int* pAdjacencyIn,[In] float NumSegs,[In] BOOL QuadraticInterpNormals,[In] ID3DXMesh** ppMeshOut,[In] ID3DXBuffer** ppAdjacencyOut) + D3DXTessellateNPatches +
+ + +

Generates an optimized vertex remapping for a triangle list. This function is commonly used after applying the face remapping generated by .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

By default, a mesh uses 16 bit indices when it is created unless the application specifies otherwise. To check whether an existing mesh uses 16-bit or 32-bit indices, call and check for the flag.

+
+ + bb205377 + HRESULT D3DXOptimizeVertices([In] const void* pbIndices,[In] unsigned int cFaces,[In] unsigned int cVertices,[In] BOOL b32BitIndices,[In, Buffer] int* pVertexRemap) + D3DXOptimizeVertices +
+ + +

Calculates per-triangle IMT's from a custom application-specified signal that varies over the surface of the mesh (generally at a higher frequency than vertex data). The signal is evaluated via a user-specified callback function.

+
+

A reference to an input mesh (see ) which contains the object geometry for calculating the IMT.

+

Zero-based texture coordinate index that identifies which set of texture coordinates to use.

+

The number of components in each data point in the signal.

+

The maximum distance between vertices; the algorithm continues subdividing until the distance between all vertices is less than or equal to fMaxUVDistance.

+

Texture wrap options. This is a combination of one or more FLAGS.

+

A reference to a user-provided evaluator function, which will be used to compute the signal value at arbitrary U,V coordinates. The function follows the prototype of LPD3DXIMTSIGNALCALLBACK.

+

A reference to a user-defined value which is passed to the signal callback function. Typically used by an application to pass a reference to a data structure that provides context information for the callback function.

+

A reference to a callback function to monitor IMT computation progress.

+

A reference to a user-defined variable which is passed to the status callback function. Typically used by an application to pass a reference to a data structure that provides context information for the callback function.

+

A reference to the buffer (see ) containing the returned IMT array. This array can be provided as input to the D3DX UVAtlas Functions to prioritize texture-space allocation in the texture parameterization.

+

If the function succeeds, the return value is ; otherwise, the value is .

+ +

This function requires that the input mesh contain a signal-to-mesh texture mapping (ie. texture coordinates). It allows the user to define a signal arbitrarily over the surface of the mesh.

+
+ + bb172739 + HRESULT D3DXComputeIMTFromSignal([In] ID3DXMesh* pMesh,[In] unsigned int dwTextureIndex,[In] unsigned int uSignalDimension,[In] float fMaxUVDistance,[In] unsigned int dwOptions,[In] __function__stdcall* pSignalCallback,[In] void* pUserData,[In] __function__stdcall* pStatusCallback,[In] void* pUserContext,[In] ID3DXBuffer** ppIMTData) + D3DXComputeIMTFromSignal +
+ + +

Validates a patch mesh, returning the number of degenerate vertices and patches.

+
+

Pointer to an interface, representing the patch mesh to be tested.

+

Returns the number of degenerate vertices in the patch mesh.

+

Returns the number of degenerate patches in the patch mesh.

+

Returns a reference to a buffer containing a string of errors and warnings that explain the problems found in the patch mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This method validates the mesh by checking for invalid indices. Error information is available from the debugger output.

+
+ + bb205483 + HRESULT D3DXValidPatchMesh([In] ID3DXPatchMesh* pMesh,[In] unsigned int* dwcDegenerateVertices,[In] unsigned int* dwcDegeneratePatches,[In] ID3DXBuffer** ppErrorsAndWarnings) + D3DXValidPatchMesh +
+ + +

Validates a mesh.

+
+

Pointer to an interface, representing the mesh to be tested.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh to be tested.

+

Returns a buffer containing a string of errors and warnings, which explain the problems found in the mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: D3DXERR_INVALIDMESH, , E_OUTOFMEMORY.

+ +

This method validates the mesh by checking for invalid indices. Error information is available from the debugger output.

+
+ + bb205482 + HRESULT D3DXValidMesh([In] ID3DXMesh* pMeshIn,[In] const unsigned int* pAdjacency,[In] ID3DXBuffer** ppErrorsAndWarnings) + D3DXValidMesh +
+ + +

Create a UV atlas for a mesh.

+
+

Pointer to an input mesh (see ) that contains the object geometry for calculating the atlas. At a minimum, the mesh must contain position data and 2D texture coordinates.

+

The maximum number of charts to partition the mesh into. See remarks about the partitioning modes. Use 0 to tell D3DX that the atlas should be parameterized based on stretch.

+

The amount of stretching allowed. 0 means no stretching is allowed, 1 means any amount of stretching can be used.

+

Zero-based texture coordinate index that identifies which set of texture coordinates to use.

+

A reference to an array of adjacency data with 3 DWORDs per face, indicating which triangles are adjacent to each other (see ).

+

An array with 3 DWORDS per face. Each face indicates if an edge is false or not. A non-false edge is indicated by -1, a false edge is indicated by any other value. This enables the parameterization of a mesh of quads where the edges down the middle of each quad will not be cut.

+

A reference to an array of integrated metric tensors that describes how to stretch a triangle (see IntegratedMetricTensor).

+

A reference to a callback function (see LPD3DXUVATLASCB) that is useful for monitoring progress.

+

Specify how often D3DX will call the callback; a reasonable default value is 0.0001f.

+

Pointer to a user-defined value that is passed to the callback function; typically used by an application to pass a reference to a data structure that provides context information for the callback function.

+

Specify the quality of the charts generated by combining one or more D3DXUVATLAS flags.

+

Pointer to the created mesh with the atlas (see ).

+

A reference to an array of the final face-partitioning data. Each element contains one DWORD per face (see ).

+

A reference to an array of remapped vertices. Each array element identifies the original vertex each final vertex came from (if the vertex was split during remapping). Each array element contains one DWORD per vertex.

+

Address of a reference to an interface. This buffer will contain an array of three DWORDs per face that specify the three neighbors for each face in the output mesh. This parameter must not be null, because the subsequent call to () requires it.

+

A reference to the maximum stretch value generated by the atlas algorithm. The range is between 0.0 and 1.0.

+

A reference to the number of charts created by the atlas algorithm. If dwMaxChartNumber is too low, this parameter will return the minimum number of charts required to create an atlas.

+

If the function succeeds, the return value is ; otherwise, the value is .

+ +

is similar to , except that does not performing the final packing step.

+
+ + bb205481 + HRESULT D3DXUVAtlasPartition([In] ID3DXMesh* pMesh,[In] unsigned int uMaxChartNumber,[In] float fMaxStretch,[In] unsigned int dwTextureIndex,[In] const unsigned int* pdwAdjacency,[In] const unsigned int* pdwFalseEdgeAdjacency,[In] const float* pfIMTArray,[In] __function__stdcall* pStatusCallback,[In] float fCallbackFrequency,[In] void* pUserContext,[In] unsigned int dwOptions,[In] ID3DXMesh** ppMeshOut,[In] ID3DXBuffer** ppFacePartitioning,[In] ID3DXBuffer** ppVertexRemapArray,[In] ID3DXBuffer** ppPartitionResultAdjacency,[In] float* pfMaxStretchOut,[In] unsigned int* puNumChartsOut) + D3DXUVAtlasPartition +
+ + +

Splits a mesh into meshes smaller than the specified size.

+
+

Pointer to an interface, representing the source mesh.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh to be simplified.

+

Maximum number of vertices in the resulting mesh.

+

Option flags for the new meshes.

+

Number of meshes returned.

+

Buffer containing an array of interfaces for the new meshes. For a source mesh split into n meshes, ppMeshArrayOut is an array of n references.

+

Buffer containing an array of adjacency arrays (DWORDs) for the new meshes. See . This parameter is optional.

+

Buffer containing an array of face remap arrays (DWORDs) for the new meshes. See . This parameter is optional.

+

Buffer containing an array of vertex remap arrays for the new meshes. See . This parameter is optional.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

A common use of this function is to split a mesh with 32-bit indices (more than 65535 vertices) into more than one mesh, each of which has 16-bit indices.

The adjacency, vertex remap and face remap arrays are arrays are DWORDs where each array contains n DWORD references, followed by the DWORD data referenced by the references. For example, to obtain the face remap information for face 3 in mesh 2, the following code could be used, assuming the face remap data was returned in a variable named ppFaceRemapArrayOut.

 const DWORD **face_remaps =  static_cast<DWORD **>(ppFaceRemapArrayOut->GetBufferPointer());	
+            const DWORD remap = face_remaps[2][3];	
+            
+
+ + bb205465 + HRESULT D3DXSplitMesh([In] ID3DXMesh* pMeshIn,[In] const unsigned int* pAdjacencyIn,[In] const unsigned int MaxSize,[In] const unsigned int Options,[In] unsigned int* pMeshesOut,[In] ID3DXBuffer** ppMeshArrayOut,[In] ID3DXBuffer** ppAdjacencyArrayOut,[In] ID3DXBuffer** ppFaceRemapArrayOut,[In] ID3DXBuffer** ppVertRemapArrayOut) + D3DXSplitMesh +
+ + +

Computes the tangent vectors for the texture coordinates given in the texture stage. Provided to support legacy applications. Use for better results.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

If the mesh vertex declaration specifies tangent or binormal fields, will update any user-supplied tangent or binormal data. Alternatively, set TangentIndex to D3DX_DEFAULT to not update the user-supplied tangent data, or set BinormIndex to D3DX_DEFAULT to not update the user-supplied binormal data. TexStageIndex cannot be set to D3DX_DEFAULT.

depends on the mesh vertex declaration containing either the binormal field (BinormIndex), the tangent field (TangentIndex), or both. If both are missing, this function will fail.

This function simply calls with the following input parameters:

 ( Mesh, , TexStageIndex, ( BinormIndex == D3DX_DEFAULT ) ? D3DX_DEFAULT : , // provides backward function compatibility BinormIndex, ( TangentIndex == D3DX_DEFAULT ) ? D3DX_DEFAULT : , TangentIndex, D3DX_DEFAULT, // do not store normals 0, ( Wrap ?  : 0 ) |  | , pAdjacency, -1.01f, -0.01f, -1.01f, null, null);	
+            
+
+ + bb172743 + HRESULT D3DXComputeTangent([In] ID3DXMesh* Mesh,[In] unsigned int TexStage,[In] unsigned int TangentIndex,[In] unsigned int BinormIndex,[In] unsigned int Wrap,[In] const unsigned int* pAdjacency) + D3DXComputeTangent +
+ + +

Determines if a ray intersects with a mesh.

+
+

Pointer to an interface, representing the mesh to be tested.

+

Pointer to a structure, specifying the point where the ray begins.

+

Pointer to a structure, specifying the direction of the ray.

+

Pointer to a . If the ray intersects a triangular face on the mesh, this value will be set to TRUE. Otherwise, this value is set to .

+

Pointer to an index value of the face closest to the ray origin, if pHit is TRUE.

+

Pointer to a barycentric hit coordinate, U.

+

Pointer to a barycentric hit coordinate, V.

+

Pointer to a ray intersection parameter distance.

+

Pointer to an object, containing an array of D3DXINTERSECTINFO structures.

+

Pointer to a DWORD that contains the number of entries in the ppAllHits array.

+

If the function succeeds, the return value is . If the function fails, the return value can be: E_OUTOFMEMORY.

+ +

The function provides a way to understand points in and around a triangle, independent of where the triangle is actually located. This function returns the resulting point by using the following equation: V1 + U(V2 - V1) + V(V3 - V1).

Any point in the plane V1V2V3 can be represented by the barycentric coordinate (U,V). The parameter U controls how much V2 gets weighted into the result, and the parameter V controls how much V3 gets weighted into the result. Lastly, the value of [1 - (U + V)] controls how much V1 gets weighted into the result.

Barycentric coordinates are a form of general coordinates. In this context, using barycentric coordinates represents a change in coordinate systems. What holds true for Cartesian coordinates holds true for barycentric coordinates.

Barycentric coordinates define a point inside a triangle in terms of the triangle's vertices. For a more in-depth description of barycentric coordinates, see Mathworld's Barycentric Coordinates Description.

+
+ + bb172882 + HRESULT D3DXIntersect([In] ID3DXBaseMesh* pMesh,[In] const D3DXVECTOR3* pRayPos,[In] const D3DXVECTOR3* pRayDir,[In] BOOL* pHit,[In] unsigned int* pFaceIndex,[In] float* pU,[In] float* pV,[In] float* pDist,[In] ID3DXBuffer** ppAllHits,[In] unsigned int* pCountOfHits) + D3DXIntersect +
+ + +

Pack mesh partitioning data into an atlas.

+
+

Pointer to an input mesh (see ) which contains the object geometry for calculating the atlas. At a minimum, the mesh must contain position data and 2D texture coordinates.

+

Texture width.

+

Texture height.

+

The minimum distance, in texels, between two charts on the atlas. The gutter is always scaled by the width; so, if a gutter of 2.5 is used on a 512x512 texture, then the minimum distance between two charts is 2.5 / 512.0 texels.

+

Zero-based texture coordinate index that identifies which set of texture coordinates to use.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh. It should be derived from the ppPartitionResultAdjacency returned from . This value cannot be null, because Pack needs to know where charts were cut in the partition step in order to find the edges of each chart.

+

A reference to a callback function (see LPD3DXUVATLASCB) that is useful for monitoring progress.

+

Specify how often D3DX will call the callback; a reasonable default value is 0.0001f.

+

A void reference to be passed back to the callback function.

+

This options parameter is currently reserved.

+

A reference to an containing the array of the final face-partitioning. Each element contains one DWORD per face.

+

If the function succeeds, the return value is ; otherwise, the value is .

+ + bb205480 + HRESULT D3DXUVAtlasPack([In] ID3DXMesh* pMesh,[In] unsigned int uWidth,[In] unsigned int uHeight,[In] float fGutter,[In] unsigned int dwTextureIndex,[In] const unsigned int* pdwPartitionResultAdjacency,[In] __function__stdcall* pStatusCallback,[In] float fCallbackFrequency,[In] void* pUserContext,[In] unsigned int dwOptions,[In] ID3DXBuffer* pFacePartitioning) + D3DXUVAtlasPack +
+ + +

Creates an N-patch mesh from a triangle mesh.

+
+

Address of a reference to an interface that represents the triangle mesh object.

+

Address of a reference to an interface that represents the created patch mesh object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb172782 + HRESULT D3DXCreateNPatchMesh([In] ID3DXMesh* pMeshSysMem,[In] ID3DXPatchMesh** pPatchMesh) + D3DXCreateNPatchMesh +
+ + +

Loads a skin mesh from a DirectX .x file data object.

+
+

Pointer to an interface, representing the file data object to load.

+

Combination of one or more flags, from the D3DXMESH enumeration, specifying creation options for the mesh.

+

Pointer to an interface, the device object associated with the mesh.

+

Address of a reference to an interface. When this method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of structures.

+

Pointer to a buffer containing an array of effect instances, one per attribute group in the returned mesh. An effect instance is a particular instance of state information used to initialize an effect. See . For more information about accessing the buffer, see .

+

Pointer to the number of structures in the ppMaterials array, when the method returns.

+

Address of a reference to an interface, which represents the skinning information.

+

Address of a reference to an interface, which represents the loaded mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY

+ +

This method takes a reference to an internal object in the .x file, enabling you to load the frame hierarchy.

For mesh files that do not contain effect instance information, default effect instances will be generated from the material information in the .x file. A default effect instance will have default values that correspond to the members of the structure.

The default texture name is also filled in, but is handled differently. The name will be Texture0@Name, which corresponds to an effect variable by the name of "Texture0" with an annotation called "Name." This will contain the string file name for the texture.

+
+ + bb172899 + HRESULT D3DXLoadSkinMeshFromXof([In] ID3DXFileData* pxofMesh,[In] unsigned int Options,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXBuffer** ppAdjacency,[In] ID3DXBuffer** ppMaterials,[In] ID3DXBuffer** ppEffectInstances,[In] unsigned int* pMatOut,[In] ID3DXSkinInfo** ppSkinInfo,[In] ID3DXMesh** ppMesh) + D3DXLoadSkinMeshFromXof +
+ + +

Creates an empty skin mesh object using a flexible vertex format (FVF) code.

+
+

Number of vertices for the skin mesh.

+

Combination of that describes the vertex format for the returned skin mesh.

+

Number of bones for the skin mesh.

+

Address of a reference to an interface, representing the created skin information object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Use SetBoneInfluence to populate the empty skin mesh object returned by this method.

+
+ + bb172794 + HRESULT D3DXCreateSkinInfoFVF([In] unsigned int NumVertices,[In] D3DFVF FVF,[In] unsigned int NumBones,[In] ID3DXSkinInfo** ppSkinInfo) + D3DXCreateSkinInfoFVF +
+ + +

Intersects the specified ray with the given mesh subset. This provides similar functionality to .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be the following value: E_OUTOFMEMORY.

+ +

The function provides a way to understand points in and around a triangle, independent of where the triangle is actually located. This function returns the resulting point by using the following equation: V1 + U(V2 - V1) + V(V3 - V1).

Any point in the plane V1V2V3 can be represented by the barycentric coordinate (U,V). The parameter U controls how much V2 gets weighted into the result and the parameter V controls how much V3 gets weighted into the result. Lastly, the value of [1 - (U + V)] controls how much V1 gets weighted into the result.

Barycentric coordinates are a form of general coordinates. In this context, using barycentric coordinates represents a change in coordinate systems. What holds true for Cartesian coordinates holds true for barycentric coordinates.

Barycentric coordinates define a point inside a triangle in terms of the triangle's vertices. For a more in-depth description of barycentric coordinates, see Mathworld's Barycentric Coordinates Description.

+
+ + bb172884 + HRESULT D3DXIntersectSubset([In] ID3DXBaseMesh* pMesh,[In] unsigned int AttribId,[In] const D3DXVECTOR3* pRayPos,[In] const D3DXVECTOR3* pRayDir,[In] BOOL* pHit,[In] unsigned int* pFaceIndex,[In] float* pU,[In] float* pV,[In] float* pDist,[In] ID3DXBuffer** ppAllHits,[In] unsigned int* pCountOfHits) + D3DXIntersectSubset +
+ + +

Returns the size of a vertex for a flexible vertex format (FVF).

+
+

FVF to be queried. A combination of .

+

The FVF vertex size, in bytes.

+ + bb172866 + unsigned int D3DXGetFVFVertexSize([In] D3DFVF FVF) + D3DXGetFVFVertexSize +
+ + +

Returns the number of elements in the vertex declaration.

+
+

A reference to the vertex declaration. See .

+

The number of elements in the vertex declaration.

+ + bb172863 + unsigned int D3DXGetDeclLength([In, Buffer] const D3DVERTEXELEMENT9* pDecl) + D3DXGetDeclLength +
+ + +

Cleans a mesh, preparing it for simplification.

+
+

Vertex operations to perform in preparation for mesh cleaning. See .

+

Pointer to an interface, representing the mesh to be cleaned.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh to be cleaned.

+

Address of a reference to an interface, representing the returned cleaned mesh. The same mesh is returned that was passed in if no cleaning was necessary.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the output mesh.

+

Returns a buffer containing a string of errors and warnings, which explain the problems found in the mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This function cleans a mesh using the cleaning method and options specified in the CleanType parameter. See the enumeration for a description of the available options.

+
+ + bb172719 + HRESULT D3DXCleanMesh([In] D3DXCLEANTYPE CleanType,[In] ID3DXMesh* pMeshIn,[In] const unsigned int* pAdjacencyIn,[In] ID3DXMesh** ppMeshOut,[In] unsigned int* pAdjacencyOut,[In] ID3DXBuffer** ppErrorsAndWarnings) + D3DXCleanMesh +
+ + +

Computes the intersection of a ray and a triangle.

+
+

Pointer to a structure, describing the first triangle vertex position.

+

Pointer to a structure, describing the second triangle vertex position.

+

Pointer to a structure, describing the third triangle vertex position.

+

Pointer to a structure, specifying the point where the ray begins.

+

Pointer to a structure, specifying the direction of the ray.

+

Barycentric hit coordinates, U.

+

Barycentric hit coordinates, V.

+

Ray-intersection parameter distance.

+

Returns TRUE if the ray intersects the area of the triangle. Otherwise, returns .

+ +

The function provides a way to understand points in and around a triangle, independent of where the triangle is actually located. This function returns the resulting point by using the following equation: V1 + U(V2 - V1) + V(V3 - V1).

Any point in the plane V1V2V3 can be represented by the barycentric coordinate (U,V). The parameter U controls how much V2 gets weighted into the result, and the parameter V controls how much V3 gets weighted into the result. Lastly, the value of [1 - (U + V)] controls how much V1 gets weighted into the result.

Barycentric coordinates are a form of general coordinates. In this context, using barycentric coordinates represents a change in coordinate systems. What holds true for Cartesian coordinates holds true for barycentric coordinates.

Barycentric coordinates define a point inside a triangle in terms of the triangle's vertices. For a more in-depth description of barycentric coordinates, see Mathworld's Barycentric Coordinates Description.

+
+ + bb172885 + BOOL D3DXIntersectTri([In] const D3DXVECTOR3* p0,[In] const D3DXVECTOR3* p1,[In] const D3DXVECTOR3* p2,[In] const D3DXVECTOR3* pRayPos,[In] const D3DXVECTOR3* pRayDir,[In] float* pU,[In] float* pV,[In] float* pDist) + D3DXIntersectTri +
+ + +

Converts the specified mesh subset into a single triangle strip.

+
+

Pointer to an interface, representing the mesh to convert to a strip.

+

Attribute ID of the mesh subset to convert to strips.

+

Combination of one or more flags from the D3DXMESH enumeration, specifying options for creating the index buffer. Cannot be . The index buffer will be created with 32-bit or 16-bit indices, depending on the format of the index buffer of the mesh specified by the MeshIn parameter.

+

Pointer to an interface, representing the index buffer containing the strip.

+

Number of indices in the buffer returned in the ppIndexBuffer parameter.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

Before running this function, call Optimize or , with the flag set.

+
+ + bb172749 + HRESULT D3DXConvertMeshSubsetToSingleStrip([In] ID3DXBaseMesh* MeshIn,[In] unsigned int AttribId,[In] unsigned int IBOptions,[In] IDirect3DIndexBuffer9** ppIndexBuffer,[In] unsigned int* pNumIndices) + D3DXConvertMeshSubsetToSingleStrip +
+ + +

Creates an empty skin mesh object using a declarator.

+
+

Number of vertices for the skin mesh.

+

Array of elements, describing the vertex format for the returned mesh.

+

Number of bones for the skin mesh.

+

Address of a reference to an interface, representing the created skin mesh object.

+

If the function succeeds, the return value is . If the function fails, the return value can be: E_OUTOFMEMORY.

+ +

Use SetBoneInfluence to populate the empty skin mesh object returned by this method.

+
+ + bb172792 + HRESULT D3DXCreateSkinInfo([In] unsigned int NumVertices,[In] const D3DVERTEXELEMENT9* pDeclaration,[In] unsigned int NumBones,[In] ID3DXSkinInfo** ppSkinInfo) + D3DXCreateSkinInfo +
+ + +

Returns the size of a vertex from the vertex declaration.

+
+

A reference to the vertex declaration. See .

+

The zero-based stream index.

+

The vertex declaration size, in bytes.

+ + bb172864 + unsigned int D3DXGetDeclVertexSize([In, Buffer] const D3DVERTEXELEMENT9* pDecl,[In] unsigned int Stream) + D3DXGetDeclVertexSize +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT D3DXGeneratePMesh([In] ID3DXMesh* pMesh,[In] const unsigned int* pAdjacency,[In] const D3DXATTRIBUTEWEIGHTS* pVertexAttributeWeights,[In] const float* pVertexWeights,[In] unsigned int MinValue,[In] unsigned int Options,[In] ID3DXPMesh** ppPMesh) + D3DXGeneratePMesh + + + +

Tessellates a rectangular higher-order surface patch into a triangle mesh.

+
+

Vertex buffer containing the patch data.

+

Pointer to an array of four floating-point values that identify the number of segments into which each edge of the rectangle patch should be divided when tessellated. See .

+

Vertex declaration structure that defines the vertex data. See .

+

Describes a rectangular patch. See .

+

Pointer to the created mesh. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Use to get the number of output vertices and indices that the tessellation function needs.

+
+ + bb205470 + HRESULT D3DXTessellateRectPatch([In] IDirect3DVertexBuffer9* pVB,[In] const float* pNumSegs,[In] const D3DVERTEXELEMENT9* pdwInDecl,[In] const D3DRECTPATCH_INFO* pRectPatchInfo,[In] ID3DXMesh* pMesh) + D3DXTessellateRectPatch +
+ + +

Returns a flexible vertex format (FVF) code from a declarator.

+
+

Array of elements, describing the FVF code.

+

Pointer to a DWORD value, representing the returned combination of that describes the vertex format returned from the declarator.

+ +

This function will fail for any declarator that does not map directly to an FVF.

+
+ + bb172854 + HRESULT D3DXFVFFromDeclarator([In, Buffer] const D3DVERTEXELEMENT9* pDeclarator,[Out] D3DFVF* pFVF) + D3DXFVFFromDeclarator +
+ + +

Creates a skin mesh from another mesh.

+
+

Pointer to an object, the mesh from which to create the skin mesh.

+

The length of the array attached to the BoneId. See .

+

Pointer to an array of bone combinations. See .

+

Address of a reference to an interface representing the created skin mesh object.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following: E_OUTOFMEMORY.

+ + bb172793 + HRESULT D3DXCreateSkinInfoFromBlendedMesh([In] ID3DXBaseMesh* pMesh,[In] unsigned int NumBones,[In] const D3DXBONECOMBINATION* pBoneCombinationTable,[In] ID3DXSkinInfo** ppSkinInfo) + D3DXCreateSkinInfoFromBlendedMesh +
+ + +

Performs tangent frame computations on a mesh. Tangent, binormal, and optionally normal vectors are generated. Singularities are handled as required by grouping edges and splitting vertices.

+
+

Pointer to an input mesh object.

+

Specifies the texture coordinate input semantic. If D3DX_DEFAULT, the function assumes that there are no texture coordinates, and the function will fail unless normal vector calculation is specified.

+

If a mesh has multiple texture coordinates, specifies the texture coordinate to use for the tangent frame computations. If zero, the mesh has only a single texture coordinate.

+

Specifies the output semantic for the type, typically , that describes where the partial derivative with respect to the U texture coordinate will be stored. If D3DX_DEFAULT, then this partial derivative will not be stored.

+

Specifies the semantic index at which to store the partial derivative with respect to the U texture coordinate.

+

Specifies the type, typically , that describes where the partial derivative with respect to the V texture coordinate will be stored. If D3DX_DEFAULT, then this partial derivative will not be stored.

+

Specifies the semantic index at which to store the partial derivative with respect to the V texture coordinate.

+

Specifies the output normal semantic, typically , that describes where the normal vector at each vertex will be stored. If D3DX_DEFAULT, then this normal vector will not be stored.

+

Specifies the semantic index at which to store the normal vector at each vertex.

+

Combination of one or more flags that specify tangent frame computation options. If null, the following options will be specified:

Description Flag Value
Weight the normal vector length by the angle, in radians, subtended by the two edges leaving the vertex.& !( | )
Compute orthogonal Cartesian coordinates from texture coordinates (u, v). See Remarks.& !( | )
Textures are not wrapped in either u or v directions& !( )
Partial derivatives with respect to texture coordinates are normalized.& !( )
Vertices are ordered in a counterclockwise direction around each triangle.& !( )
Use per-vertex normal vectors already present in the input mesh.& !( )

?

If is not set, the input mesh is cloned. The original mesh must therefore have sufficient space to store the computed normal vector and partial derivative data.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh. The number of bytes in this array must be at least 3 * GetNumFaces * sizeof(DWORD).

+

Specifies the maximum cosine of the angle at which two partial derivatives are deemed to be incompatible with each other. If the dot product of the direction of the two partial derivatives in adjacent triangles is less than or equal to this threshold, then the vertices shared between these triangles will be split.

+

Specifies the maximum magnitude of a partial derivative at which a vertex will be deemed singular. As multiple triangles are incident on a point that have nearby tangent frames, but altogether cancel each other out (such as at the top of a sphere), the magnitude of the partial derivative will decrease. If the magnitude is less than or equal to this threshold, then the vertex will be split for every triangle that contains it.

+

Similar to fPartialEdgeThreshold, specifies the maximum cosine of the angle between two normals that is a threshold beyond which vertices shared between triangles will be split. If the dot product of the two normals is less than the threshold, the shared vertices will be split, forming a hard edge between neighboring triangles. If the dot product is more than the threshold, neighboring triangles will have their normals interpolated.

+

Address of a reference to an output mesh object that receives the computed tangent, binormal, and normal vector data.

+

Address of a reference to an output buffer object that receives a mapping of new vertices computed by this method to the original vertices. The buffer is an array of DWORDs, with the array size defined as the number of vertices in ppMeshOut.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

A simplified version of this function is available as .

The computed normal vector at each vertex is always normalized to have unit length.

The most robust solution for computing orthogonal Cartesian coordinates is to not set flags and , so that orthogonal coordinates are computed from both texture coordinates u and v. However, in this case, if either u or v is zero, then the function will compute orthogonal coordinates using or , respectively.

+
+ + bb172745 + HRESULT D3DXComputeTangentFrameEx([In] ID3DXMesh* pMesh,[In] unsigned int dwTextureInSemantic,[In] unsigned int dwTextureInIndex,[In] unsigned int dwUPartialOutSemantic,[In] unsigned int dwUPartialOutIndex,[In] unsigned int dwVPartialOutSemantic,[In] unsigned int dwVPartialOutIndex,[In] unsigned int dwNormalOutSemantic,[In] unsigned int dwNormalOutIndex,[In] unsigned int dwOptions,[In] const unsigned int* pdwAdjacency,[In] float fPartialEdgeThreshold,[In] float fSingularPointThreshold,[In] float fNormalEdgeThreshold,[In] ID3DXMesh** ppMeshOut,[In] ID3DXBuffer** ppVertexMapping) + D3DXComputeTangentFrameEx +
+ + +

Determines if a ray intersects the volume of a sphere's bounding box.

+
+

Pointer to a structure, specifying the center coordinate of the sphere.

+

Radius of the sphere.

+

Pointer to a structure, specifying the origin coordinate of the ray.

+

Pointer to a structure, specifying the direction of the ray. This vector should not be (0,0,0) but does not need to be normalized.

+

Returns TRUE if the ray intersects the volume of the sphere's bounding box. Otherwise, returns .

+ +

determines if the ray intersects the volume of the sphere's bounding box, not just the surface of the sphere.

+
+ + bb204995 + BOOL D3DXSphereBoundProbe([In] const D3DXVECTOR3* pCenter,[In] float Radius,[In] const D3DXVECTOR3* pRayPosition,[In] const D3DXVECTOR3* pRayDirection) + D3DXSphereBoundProbe +
+ + +

Create a UV atlas for a mesh.

+
+

Pointer to an input mesh (see ) which contains the object geometry for calculating the atlas. At a minimum, the mesh must contain position data and 2D texture coordinates.

+

The maximum number of charts to partition the mesh into. See remarks about the partitioning modes. Use 0 to tell D3DX that the atlas should be parameterized based on stretch.

+

The amount of stretching allowed. 0 means no stretching is allowed, 1 means any amount of stretching can be used.

+

Texture width.

+

Texture height.

+

The minimum distance, in texels, between two charts on the atlas. The gutter is always scaled by the width; so, if a gutter of 2.5 is used on a 512x512 texture, then the minimum distance between two charts is 2.5 / 512.0 texels.

+

Zero-based texture coordinate index that identifies which set of texture coordinates to use.

+

A reference to an array of adjacency data. with 3 DWORDs per face, indicating which triangles are adjacent to each other (see ).

+

An array with 3 DWORDS per face. Each face indicates if an edge is false or not. A non-false edge is indicated by -1, a false edge is indicated by any other value. This enables the parameterization of a mesh of quads where the edges down the middle of each quad will not be cut.

+

A reference to an array of integrated metric tensors that describes how to stretch a triangle (see IntegratedMetricTensor).

+

A reference to a callback function (see LPD3DXUVATLASCB) that is useful for monitoring progress.

+

Specify how often D3DX will call the callback; a reasonable default value is 0.0001f.

+

Pointer to a user-defined value which is passed to the callback function; typically used by an application to pass a reference to a data structure that provides context information for the callback function.

+

Specify the quality of the charts generated. See D3DXUVATLAS.

+

Pointer to the created mesh with the atlas (see ).

+

A reference to an array of the final face-partitioning data. Each element contains one DWORD per face (see ).

+

A reference to an array of remapped vertices. Each array element identifies the original vertex that each final vertex came from (if the vertex was split during remapping). Each array element contains one DWORD per vertex.

+

A reference to the maximum stretch value generated by the atlas algorithm. The range is between 0.0 and 1.0.

+

A reference to the number of charts created by the atlas algorithm. If dwMaxChartNumber is too low, this parameter will return the minimum number of charts required to create an atlas.

+

If the function succeeds, the return value is ; otherwise, the value is .

+ +

can partition mesh geometry two ways:

  • Based on the number of charts
  • Based on the maximum allowed stretch. If the maximum allowed stretch is 0, each triangle will likely be in its own chart.
+
+ + bb205479 + HRESULT D3DXUVAtlasCreate([In] ID3DXMesh* pMesh,[In] unsigned int uMaxChartNumber,[In] float fMaxStretch,[In] unsigned int uWidth,[In] unsigned int uHeight,[In] float fGutter,[In] unsigned int dwTextureIndex,[In] const unsigned int* pdwAdjacency,[In] const unsigned int* pdwFalseEdgeAdjacency,[In] const float* pfIMTArray,[In] __function__stdcall* pStatusCallback,[In] float fCallbackFrequency,[In] void* pUserContext,[In] unsigned int dwOptions,[In] ID3DXMesh** ppMeshOut,[In] ID3DXBuffer** ppFacePartitioning,[In] ID3DXBuffer** ppVertexRemapArray,[In] float* pfMaxStretchOut,[In] unsigned int* puNumChartsOut) + D3DXUVAtlasCreate +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT D3DXCreatePMeshFromStream([In] IStream* pStream,[In] unsigned int Options,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXBuffer** ppMaterials,[In] ID3DXBuffer** ppEffectInstances,[In] unsigned int* pNumMaterials,[In] ID3DXPMesh** ppPMesh) + D3DXCreatePMeshFromStream + + + +

Calculates per-triangle IMT's from a texture mapped onto a mesh, to be used optionally as input to the D3DX UVAtlas Functions.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is ; otherwise, the value is .

+ +

Given a texture that maps over the surface of the mesh, the algorithm computes the IMT for each face. This will cause triangles containing lower-frequency signal data to take up less space in the final texture atlas when parameterized with the UVAtlas functions. The texture is assumed to be interpolated over the mesh bilinearly.

+
+ + bb172740 + HRESULT D3DXComputeIMTFromTexture([In] ID3DXMesh* pMesh,[In] IDirect3DTexture9* pTexture,[In] unsigned int dwTextureIndex,[In] unsigned int dwOptions,[In] __function__stdcall* pStatusCallback,[In] void* pUserContext,[In] ID3DXBuffer** ppIMTData) + D3DXComputeIMTFromTexture +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT D3DXCreateSPMesh([In] ID3DXMesh* pMesh,[In] const unsigned int* pAdjacency,[In] const D3DXATTRIBUTEWEIGHTS* pVertexAttributeWeights,[In] const float* pVertexWeights,[In] ID3DXSPMesh** ppSMesh) + D3DXCreateSPMesh + + + +

Concatenates a group of meshes into one common mesh. This method can optionally apply a matrix transformation to each input mesh and its texture coordinates.

+
+

Array of input mesh references (see ). The number of elements in the array is NumMeshes.

+

Number of input meshes to concatenate.

+

Mesh creation options; this is a combination of one or more D3DXMESH flags. The mesh creation options are equivalent to the options parameter required by .

+

Optional array of geometry transforms. The number of elements in the array is NumMeshes; each element is a transformation matrix (see ). May be null.

+

Optional array of texture transforms. The number of elements in the array is NumMeshes; each element is a transformation matrix (see ). This parameter may be null.

+

Optional reference to a vertex declaration (see ). This parameter may be null.

+

Pointer to a device that is used to create the new mesh.

+

Address of a reference to the mesh created (see ).

+

If the function succeeds, the return value is . If the function fails, the return value can be one of these: , E_OUTOFMEMORY.

+ +

If no vertex declaration is given as part of the Options mesh creation parameter, the method will generate a union of all of the vertex declarations of the submeshes, promoting channels and types if necessary. The method will create an attribute table from attribute tables of the input meshes. To ensure creation of an attribute table, call Optimize with Flags set to and (see D3DXMESHOPT).

+
+ + bb172746 + HRESULT D3DXConcatenateMeshes([In] ID3DXMesh** ppMeshes,[In] unsigned int NumMeshes,[In] unsigned int Options,[In] const D3DXMATRIX* pGeomXForms,[In] const D3DXMATRIX* pTextureXForms,[In, Buffer] const D3DVERTEXELEMENT9* pDecl,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXMesh** ppMeshOut) + D3DXConcatenateMeshes +
+ + +

Determines whether a ray intersects the volume of a box's bounding box.

+
+

Pointer to a , describing the lower-left corner of the bounding box. See Remarks.

+

Pointer to a structure, describing the upper-right corner of the bounding box. See Remarks.

+

Pointer to a structure, specifying the origin coordinate of the ray.

+

Pointer to a structure, specifying the direction of the ray. This vector should not be (0,0,0) but does not need to be normalized.

+

Returns TRUE if the ray intersects the volume of the box's bounding box. Otherwise, returns .

+ +

determines if the ray intersects the volume of the box's bounding box, not just the surface of the box.

The values passed to are xmin, xmax, ymin, ymax, zmin, and zmax. Thus, the following defines the corners of the bounding box.

 xmax, ymax, zmax	
+            xmax, ymax, zmin	
+            xmax, ymin, zmax	
+            xmax, ymin, zmin	
+            xmin, ymax, zmax	
+            xmin, ymax, zmin	
+            xmin, ymin, zmax	
+            xmin, ymin, zmin	
+            

The depth of the bounding box in the z direction is zmax - zmin, in the y direction is ymax - ymin, and in the x direction is xmax - xmin. For example, with the following minimum and maximum vectors, min (-1, -1, -1) and max (1, 1, 1), the bounding box is defined in the following manner.

 1,  1,  1 1,  1, -1 1, -1,  1 1, -1, -1	
+            -1,  1,  1	
+            -1,  1, -1	
+            -1, -1,  1	
+            -1, -1, -l	
+            
+
+ + bb204916 + BOOL D3DXBoxBoundProbe([In] const D3DXVECTOR3* pMin,[In] const D3DXVECTOR3* pMax,[In] const D3DXVECTOR3* pRayPosition,[In] const D3DXVECTOR3* pRayDirection) + D3DXBoxBoundProbe +
+ + +

Loads a mesh from a resource.

+
+

Handle to the module where the resource is located, or null for the module associated with the image the operating system used to create the current process. See remarks.

+

Pointer to a string that specifies the resource to create the mesh from. See remarks.

+

Pointer to a string that specifies the resource type. See remarks.

+

Combination of one or more flags from the D3DXMESH enumeration that specify creation options for the mesh.

+

Pointer to an interface, the device object associated with the mesh.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh.

+

Address of a reference to an interface. When this method returns, this parameter is filled with an array of structures, containing information saved in the DirectX file.

+

Pointer to a buffer containing an array of effect instances, one per attribute group in the returned mesh. An effect instance is a particular instance of state information used to initialize an effect. See . For more information about accessing the buffer, see .

+

Pointer to the number of structures in the ppMaterials array, when the method returns.

+

Address of a reference to an interface, representing the loaded mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

See FindResource to find out more about the Module, Name and Type parameters.

All the meshes in the file will be collapsed into one output mesh. If the file contains a frame hierarchy, all the transformations will be applied to the mesh.

For mesh files that do not contain effect instance information, default effect instances will be generated from the material information in the .x file. A default effect instance will have default values that correspond to the members of the structure.

The default texture name is also filled in, but is handled differently. The name will be Texture0@Name, which corresponds to an effect variable by the name of "Texture0" with an annotation called "Name." This will contain the string file name for the texture.

+
+ + bb172893 + HRESULT D3DXLoadMeshFromXResource([In] HINSTANCE Module,[In] const char* Name,[In] const char* Type,[In] unsigned int Options,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXBuffer** ppAdjacency,[In] ID3DXBuffer** ppMaterials,[In] ID3DXBuffer** ppEffectInstances,[In] unsigned int* pNumMaterials,[In] ID3DXMesh** ppMesh) + D3DXLoadMeshFromXResource +
+ + +

Generates a simplified mesh using the provided weights that come as close as possible to the given MinValue.

+
+

Pointer to an interface, representing the source mesh.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh to be simplified.

+

Pointer to a structure, containing the weight for each vertex component. If this parameter is set to null, a default structure is used. See Remarks.

+

Pointer to an array of vertex weights. If this parameter is set to null, all vertex weights are set to 1.0.

+

Number of vertices or faces, depending on the flag set in the Options parameter, by which to simplify the source mesh.

+

Specifies simplification options for the mesh. One of the flags in D3DXMESHSIMP can be set.

+

Address of a reference to an interface, representing the returned simplification mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function generates a mesh that has MinValue vertices or faces.

If the simplification process cannot reduce the mesh to MinValue, the call still succeeds because MinValue is a desired minimum, not an absolute minimum.

If pVertexAttributeWeights is set to null, the following values are assigned to the default structure.

  AttributeWeights; AttributeWeights.Position  = 1.0;	
+            AttributeWeights.Boundary =  1.0;	
+            AttributeWeights.Normal   =  1.0;	
+            AttributeWeights.Diffuse  =  0.0;	
+            AttributeWeights.Specular =  0.0;	
+            AttributeWeights.Tex[8]   =  {0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0};	
+            

This default structure is what most applications should use because it considers only geometric and normal adjustment. Only in special cases will the other member fields need to be modified.

+
+ + bb205463 + HRESULT D3DXSimplifyMesh([In] ID3DXMesh* pMesh,[In] const unsigned int* pAdjacency,[In] const D3DXATTRIBUTEWEIGHTS* pVertexAttributeWeights,[In] const float* pVertexWeights,[In] unsigned int MinValue,[In] unsigned int Options,[In] ID3DXMesh** ppMesh) + D3DXSimplifyMesh +
+ + +

Computes a coordinate-axis oriented bounding box.

+
+

Pointer to the first position.

+

Number of vertices.

+

Count or number of bytes between vertices.

+

Pointer to a structure, describing the returned lower-left corner of the bounding box.

+

Pointer to a structure, describing the returned upper-right corner of the bounding box.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: .

+ + bb204920 + HRESULT D3DXComputeBoundingBox([In] const D3DXVECTOR3* pFirstPosition,[In] unsigned int NumVertices,[In] unsigned int dwStride,[In] D3DXVECTOR3* pMin,[In] D3DXVECTOR3* pMax) + D3DXComputeBoundingBox +
+ + +

Creates a mesh object using a flexible vertex format (FVF) code.

+
+

Number of faces for the mesh. The valid range for this number is greater than 0, and one less than the max DWORD value, typically 232 - 1, because the last index is reserved.

+

Number of vertices for the mesh. This parameter must be greater than 0.

+

Combination of one or more flags from the D3DXMESH enumeration, specifying creation options for the mesh.

+

Combination of that describes the vertex format for the returned mesh. This function does not support .

+

Pointer to an interface, the device object to be associated with the mesh.

+

Address of a reference to an interface, representing the created mesh object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb172781 + HRESULT D3DXCreateMeshFVF([In] unsigned int NumFaces,[In] unsigned int NumVertices,[In] unsigned int Options,[In] D3DFVF FVF,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXMesh** ppMesh) + D3DXCreateMeshFVF +
+ + +

Calculate per-triangle IMT's from from per-vertex data. This function allows you to calculate the IMT based off of any value in a mesh (color, normal, etc).

+
+

A reference to an input mesh (see ) which contains the object geometry for calculating the IMT.

+

A reference to an array of per-vertex data from which IMT will be computed. The array size is uSignalStride * v, where v is the number of vertices in the mesh.

+

The number of floats per vertex.

+

The number of bytes per vertex in the array. This must be a multiple of sizeof(float)

+

Texture wrap options. This is a combination of one or more FLAGS.

+

A reference to a callback function to monitor IMT computation progress.

+

A reference to a user-defined variable which is passed to the status callback function. Typically used by an application to pass a reference to a data structure that provides context information for the callback function.

+

A reference to the buffer (see ) containing the returned IMT array. This array can be provided as input to the D3DX UVAtlas Functions to prioritize texture-space allocation in the texture parameterization.

+

If the function succeeds, the return value is ; otherwise, the value is .

+ + bb172738 + HRESULT D3DXComputeIMTFromPerVertexSignal([In] ID3DXMesh* pMesh,[In] const float* pfVertexSignal,[In] unsigned int uSignalDimension,[In] unsigned int uSignalStride,[In] unsigned int dwOptions,[In] __function__stdcall* pStatusCallback,[In] void* pUserContext,[In] ID3DXBuffer** ppIMTData) + D3DXComputeIMTFromPerVertexSignal +
+ + +

Loads a mesh from an object.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

For mesh files that do not contain effect instance information, default effect instances will be generated from the material information in the .x file. A default effect instance will have default values that correspond to the members of the structure.

The default texture name is also filled in, but is handled differently. The name will be Texture0@Name, which corresponds to an effect variable by the name of "Texture0" with an annotation called "Name." This will contain the string file name for the texture.

+
+ + bb172892 + HRESULT D3DXLoadMeshFromXof([In] ID3DXFileData* pxofMesh,[In] unsigned int Options,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXBuffer** ppAdjacency,[In] ID3DXBuffer** ppMaterials,[In] ID3DXBuffer** ppEffectInstances,[In] unsigned int* pNumMaterials,[In] ID3DXMesh** ppMesh) + D3DXLoadMeshFromXof +
+ + +

Creates a mesh object using a declarator.

+
+

Number of faces for the mesh. The valid range for this number is greater than 0, and one less than the maximum DWORD (typically 65534), because the last index is reserved.

+

Number of vertices for the mesh. This parameter must be greater than 0.

+

Combination of one or more flags from the D3DXMESH enumeration, specifying options for the mesh.

+

Array of elements, describing the vertex format for the returned mesh. This parameter must map directly to a flexible vertex format (FVF).

+

Pointer to an interface, the device object to be associated with the mesh.

+

Address of a reference to an interface, representing the created mesh object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb172780 + HRESULT D3DXCreateMesh([In] unsigned int NumFaces,[In] unsigned int NumVertices,[In] unsigned int Options,[In] const D3DVERTEXELEMENT9* pDeclaration,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXMesh** ppMesh) + D3DXCreateMesh +
+ + +

Creates a mesh from a control-patch mesh.

+
+

Patch information structure. For more information, see .

+

Number of patches.

+

Number of control vertices in the patch.

+

Unused. Reserved for later use.

+

Array of elements, describing the vertex format for the returned mesh.

+

Pointer the device that creates the patch mesh. See .

+

Pointer to the object that is created.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This method takes an input patch mesh and converts it to a tessellated mesh. Patch meshes use 16-bit index buffers. Therefore, indices to LockIndexBuffer are 16 bits.

+
+ + bb172783 + HRESULT D3DXCreatePatchMesh([In] const D3DXPATCHINFO* pInfo,[In] unsigned int dwNumPatches,[In] unsigned int dwNumVertices,[In] unsigned int dwOptions,[In, Buffer] const D3DVERTEXELEMENT9* pDecl,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXPatchMesh** pPatchMesh) + D3DXCreatePatchMesh +
+ + +

Gets the size of the rectangle patch.

+
+

Number of segments per edge to tessellate.

+

Pointer to a DWORD that contains the number of triangles in the patch.

+

Pointer to a DWORD that contains the number of vertices in the patch.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb205423 + HRESULT D3DXRectPatchSize([In] const float* pfNumSegs,[Out] unsigned int* pdwTriangles,[Out] unsigned int* pdwVertices) + D3DXRectPatchSize +
+ + +

Tessellates a triangular higher-order surface patch into a triangle mesh.

+
+

Vertex buffer containing the patch data.

+

Pointer to an array of three floating-point values that identify the number of segments into which each edge of the triangle patch should be divided when tessellated. See .

+

Vertex declaration structure that defines the vertex data. See .

+

Describes a triangle patch. See .

+

Pointer to the created mesh. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Use to get the number of output vertices and indices that the tessellation function needs.

+
+ + bb205471 + HRESULT D3DXTessellateTriPatch([In] IDirect3DVertexBuffer9* pVB,[In] const float* pNumSegs,[In] const D3DVERTEXELEMENT9* pInDecl,[In] const D3DTRIPATCH_INFO* pTriPatchInfo,[In] ID3DXMesh* pMesh) + D3DXTessellateTriPatch +
+ + +

Computes a bounding sphere for the mesh.

+
+

Pointer to first position.

+

Number of vertices.

+

Number of bytes between position vectors. Use GetNumBytesPerVertex, , or to get the vertex stride.

+

structure, defining the coordinate center of the returned bounding sphere.

+

Radius of the returned bounding sphere.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: .

+ + bb172736 + HRESULT D3DXComputeBoundingSphere([In] const D3DXVECTOR3* pFirstPosition,[In] unsigned int NumVertices,[In] unsigned int dwStride,[In] D3DXVECTOR3* pCenter,[In] float* pRadius) + D3DXComputeBoundingSphere +
+ + +

Loads a mesh from a DirectX .x file.

+
+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Combination of one or more flags from the D3DXMESH enumeration, which specifies creation options for the mesh.

+

Pointer to an interface, the device object associated with the mesh.

+

Pointer to a buffer that contains adjacency data. The adjacency data contains an array of three DWORDs per face that specify the three neighbors for each face in the mesh. For more information about accessing the buffer, see .

+

Pointer to a buffer containing materials data. The buffer contains an array of structures, containing information from the DirectX file. For more information about accessing the buffer, see .

+

Pointer to a buffer containing an array of effect instances, one per attribute group in the returned mesh. An effect instance is a particular instance of state information used to initialize an effect. See . For more information about accessing the buffer, see .

+

Pointer to the number of structures in the ppMaterials array, when the method returns.

+

Address of a reference to an interface, representing the loaded mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXLoadMeshFromXA because ANSI strings are being used.

All the meshes in the file will be collapsed into one output mesh. If the file contains a frame hierarchy, all the transformations will be applied to the mesh.

For mesh files that do not contain effect instance information, default effect instances will be generated from the material information in the .x file. A default effect instance will have default values that correspond to the members of the structure.

The default texture name is also filled in, but is handled differently. The name will be Texture0@Name, which corresponds to an effect variable by the name of "Texture0" with an annotation called "Name." This will contain the string file name for the texture.

+
+ + bb172890 + HRESULT D3DXLoadMeshFromXW([In] const wchar_t* pFilename,[In] unsigned int Options,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXBuffer** ppAdjacency,[In] ID3DXBuffer** ppMaterials,[In] ID3DXBuffer** ppEffectInstances,[In] unsigned int* pNumMaterials,[In] ID3DXMesh** ppMesh) + D3DXLoadMeshFromXW +
+ + +

Loads a mesh from memory.

+
+

Pointer to the memory buffer which contains the mesh data.

+

Size of the file in memory, in bytes.

+

Combination of one or more flags from the D3DXMESH enumeration, specifying creation options for the mesh.

+

Pointer to an interface, the device object associated with the mesh.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh.

+

Address of a reference to an interface. When this method returns, this parameter is filled with an array of structures, containing information saved in the DirectX file.

+

Pointer to a buffer containing an array of effect instances, one per attribute group in the returned mesh. An effect instance is a particular instance of state information used to initialize an effect. See . For more information about accessing the buffer, see .

+

Pointer to the number of structures in the ppMaterials array, when the method returns.

+

Address of a reference to an interface, representing the loaded mesh.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

All the meshes in the file will be collapsed into one output mesh. If the file contains a frame hierarchy, all the transformations will be applied to the mesh.

For mesh files that do not contain effect instance information, default effect instances will be generated from the material information in the .x file. A default effect instance will have default values that correspond to the members of the structure.

The default texture name is also filled in, but is handled differently. The name will be Texture0@Name, which corresponds to an effect variable by the name of "Texture0" with an annotation called "Name." This will contain the string file name for the texture.

+
+ + bb172891 + HRESULT D3DXLoadMeshFromXInMemory([In] const void* Memory,[In] unsigned int SizeOfMemory,[In] unsigned int Options,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXBuffer** ppAdjacency,[In] ID3DXBuffer** ppMaterials,[In] ID3DXBuffer** ppEffectInstances,[In] unsigned int* pNumMaterials,[In] ID3DXMesh** ppMesh) + D3DXLoadMeshFromXInMemory +
+ + +

Convert the specified mesh subset into a series of strips.

+
+

Pointer to an interface, representing the mesh to convert to a strip.

+

Attribute ID of the mesh subset to convert to strips.

+

Combination of one or more flags from the D3DXMESH enumeration, specifying options for creating the index buffer. Cannot be . The index buffer will be created with 32-bit or 16-bit indices depending on the format of the index buffer of the mesh specified by the MeshIn parameter.

+

Pointer to an interface, representing index buffer containing the strip.

+

Number of indices in the buffer returned in the ppIndexBuffer parameter.

+

Buffer containing an array of one DWORD per strip, which specifies the number of triangles in the that strip.

+

Number of individual strips in the index buffer and corresponding strip length array.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

Before running this function, call Optimize or , with the flag set.

+
+ + bb172750 + HRESULT D3DXConvertMeshSubsetToStrips([In] ID3DXBaseMesh* MeshIn,[In] unsigned int AttribId,[In] unsigned int IBOptions,[In] IDirect3DIndexBuffer9** ppIndexBuffer,[In] unsigned int* pNumIndices,[In] ID3DXBuffer** ppStripLengths,[In] unsigned int* pNumStrips) + D3DXConvertMeshSubsetToStrips +
+ + +

Calculate per-triangle IMT's from per-texel data. This function is similar to , but it uses a float array to pass in the data, and it can calculate higher dimensional values than 4.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is ; otherwise, the value is .

+ + bb172737 + HRESULT D3DXComputeIMTFromPerTexelSignal([In] ID3DXMesh* pMesh,[In] unsigned int dwTextureIndex,[In] float* pfTexelSignal,[In] unsigned int uWidth,[In] unsigned int uHeight,[In] unsigned int uSignalDimension,[In] unsigned int uComponents,[In] unsigned int dwOptions,[In] __function__stdcall* pStatusCallback,[In] void* pUserContext,[In] ID3DXBuffer** ppIMTData) + D3DXComputeIMTFromPerTexelSignal +
+ + +

Gets the size of the triangle patch.

+
+

Number of segments per edge to tessellate.

+

Pointer to a DWORD that contains the number of triangles in the patch.

+

Pointer to a DWORD that contains the number of vertices in the triangle patch.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + Bb205476 + HRESULT D3DXTriPatchSize([In] const float* pfNumSegs,[Out] unsigned int* pdwTriangles,[Out] unsigned int* pdwVertices) + D3DXTriPatchSize +
+ + +

Computes unit normals for each vertex in a mesh. Provided to support legacy applications. Use for better results.

+
+ No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The input mesh must have the flag specified in its flexible vertex format (FVF).

A normal for a vertex is generated by averaging the normals of all faces that share that vertex.

If adjacency is provided, replicated vertices are ignored and "smoothed" over. If adjacency is not provided, replicated vertices will have normals averaged in from only the faces explicitly referencing them.

This function simply calls with the following input parameters:

 ( pMesh, D3DX_DEFAULT, 0, D3DX_DEFAULT, 0, D3DX_DEFAULT, 0, , 0,  | , pAdjacency, -1.01f, -0.01f, -1.01f, null, null);	
+            
+
+ + bb172742 + HRESULT D3DXComputeNormals([In] ID3DXBaseMesh* pMesh,[In] const unsigned int* pAdjacency) + D3DXComputeNormals +
+ + +

Preprocesses a shader without performing compilation. This resolves all #defines and #includes, providing a self-contained shader for subsequent compilation.

+
+

Pointer to a string that contains the shader.

+

Length of the data in bytes.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Returns a buffer containing a single large string that represents the resulting formatted token stream.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb205398 + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + D3DXPreprocessShader +
+ + +

Compile a shader file.

+
+

Pointer to a string that specifies the filename.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Pointer to the shader entry point function where execution begins.

+

Pointer to a shader profile which determines the shader instruction set. See or for a list of the profiles available.

+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Returns a buffer containing the created shader. This buffer contains the compiled shader code, as well as any embedded debug and symbol table information.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

Returns an interface, which can be used to access shader constants. This value can be null. If you compile your application as large address aware (that is, you use the /LARGEADDRESSAWARE linker option to handle addresses larger than 2 GB), you cannot use this parameter and must set it to null. Instead, you must use the function to retrieve the shader-constant table that is embedded inside the shader. In this call, you must pass the D3DXCONSTTABLE_LARGEADDRESSAWARE flag to the Flags parameter to specify to access up to 4 GB of virtual address space.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172732 + HRESULT D3DXCompileShaderFromFileW([In] const wchar_t* pSrcFile,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + D3DXCompileShaderFromFileW +
+ + +

Creates a texture shader object from the compiled shader.

+
+

Pointer to the function DWORD stream.

+

Returns an object which can be used to procedurally fill the contents of a texture using the functions.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172808 + HRESULT D3DXCreateTextureShader([In] const unsigned int* pFunction,[In] ID3DXTextureShader** ppTextureShader) + D3DXCreateTextureShader +
+ + +

Get the semantics for all shader output elements.

+
+

Pointer to the shader function DWORD stream.

+

Pointer to an array of structures. The function will fill this array with the semantics for each output element referenced by the shader. This array is assumed to contain at least MAXD3DDECLLENGTH elements. However, calling with pSemantics = null will return the number of elements needed for pCount.

+

Returns the number of elements in pSemantics.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172873 + HRESULT D3DXGetShaderOutputSemantics([In] const void* pFunction,[In, Out, Buffer] D3DXSEMANTIC* pSemantics,[InOut] unsigned int* pCount) + D3DXGetShaderOutputSemantics +
+ + +

Gets the semantics for the shader inputs. Use this method to determine the input vertex format.

+
+

Pointer to the shader function DWORD stream.

+

Pointer to an array of structures. The function will fill this array with the semantics for each input element referenced by the shader. This array is assumed to contain at least MAXD3DDECLLENGTH elements. However, calling with pSemantics = null will return the number of elements needed for pCount.

+

Returns the number of elements in pSemantics.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

Use to return a list of input semantics required by the shader. This is the way to find out what the input vertex format is for a high-level shader language (HLSL) shader. If the shader has additional inputs that your vertex declaration is missing, you could create an extra vertex stream that has a stride of 0 that has the missing components with default values. For instance, this technique could be used to provide default vertex color for models that do not specify it.

+
+ + bb172872 + HRESULT D3DXGetShaderInputSemantics([In] const void* pFunction,[In, Out, Buffer] D3DXSEMANTIC* pSemantics,[InOut] unsigned int* pCount) + D3DXGetShaderInputSemantics +
+ + +

Returns the name of the highest high-level shader language (HLSL) profile supported by a given device.

+
+

Pointer to the device. See .

+

The HLSL profile name.

If the device does not support pixel shaders then the function returns null.

+ +

A shader profile specifies the assembly shader version to use and the capabilities available to the HLSL compiler when compiling a shader. The following table lists the pixel shader profiles that are supported.

Shader ProfileDescription
ps_1_1Compile to ps_1_1 version.
ps_1_2Compile to ps_1_2 version.
ps_1_3Compile to ps_1_3 version.
ps_1_4Compile to ps_1_4 version.
ps_2_0Compile to ps_2_0 version.
ps_2_aSame as the ps_2_0 profile, with the following additional capabilities available for the compiler to target:
  • Number of Temporary Registers (r#) is greater than or equal to 22.
  • Arbitrary source swizzle.
  • Gradient instructions: dsx, dsy.
  • Predication.
  • No dependent texture read limit.
  • No limit for the number of texture instructions.
ps_2_bSame as the ps_2_0 profile, with the following additional capabilities available for the compiler to target:
  • Number of Temporary Registers (r#) is greater than or equal to 32.
  • No limit for the number of texture instructions.
ps_3_0Compile to ps_3_0 version.

?

For more information about the differences between shader versions, see Pixel Shader Differences.

+
+ + bb172870 + const char* D3DXGetPixelShaderProfile([In] IDirect3DDevice9* pDevice) + D3DXGetPixelShaderProfile +
+ + +

Searches through a shader for a particular comment. The comment is identified by a four-character code (FOURCC) in the first DWORD of the comment.

+
+

Pointer to the shader function DWORD stream.

+

FOURCC code that identifies the comment block. See FourCC Formats.

+

Returns a reference to the comment data (not including the comment token and FOURCC code). This value can be null.

+

Returns the size of the comment data in bytes. This value can be null.

+

If the function succeeds, the return value is . If the comment is not found, and no other error has occurred, S_FALSE is returned.

+ + bb172838 + HRESULT D3DXFindShaderComment([In] const void* pFunction,[In] unsigned int FourCC,[Out] const void** ppData,[Out] unsigned int* pSizeInBytes) + D3DXFindShaderComment +
+ + +

Assemble a shader.

+
+

Handle to a module containing the effect description. If this parameter is null, the current module will be used.

+

Pointer to a string that specifies the resource name. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Returns a buffer containing the created shader. This buffer contains the compiled shader code, as well as any embedded debug and symbol table information.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXAssembleShaderFromResourceA because ANSI strings are being used.

+
+ + bb172709 + HRESULT D3DXAssembleShaderFromResourceW([In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs) + D3DXAssembleShaderFromResourceW +
+ + +

Assemble a shader.

+
+

Pointer to a memory buffer that contains the shader data.

+

Length of the effect data, in bytes.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Returns a buffer containing the created shader. This buffer contains the compiled shader code, as well as any embedded debug and symbol table information.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172707 + HRESULT D3DXAssembleShader([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs) + D3DXAssembleShader +
+ + +

Compile a shader file.

+
+

Pointer to a string that contains the shader.

+

Length of the data in bytes.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Pointer to a string that contains the name of the shader entry point function where execution begins.

+

Pointer to a shader profile which determines the shader instruction set. See or for a list of the profiles available.

+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Returns a buffer containing the created shader. This buffer contains the compiled shader code, as well as any embedded debug and symbol table information.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

Returns an interface, which can be used to access shader constants. This value can be null. If you compile your application as large address aware (that is, you use the /LARGEADDRESSAWARE linker option to handle addresses larger than 2 GB), you cannot use this parameter and must set it to null. Instead, you must use the function to retrieve the shader-constant table that is embedded inside the shader. In this call, you must pass the D3DXCONSTTABLE_LARGEADDRESSAWARE flag to the Flags parameter to specify to access up to 4 GB of virtual address space.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172731 + HRESULT D3DXCompileShader([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + D3DXCompileShader +
+ + +

Get the sampler names referenced in a shader.

+
+

Pointer to the shader function DWORD stream.

+

Pointer to an array of LPCSTRs. The function will fill this array with references to the sampler names contained within pFunction. The maximum array size is the maximum number of sampler registers (16 for vs_3_0 and ps_3_0).

To find the number of samplers used, check pCount after calling with pSamplers = null.

+

Returns the number of samplers referenced by the shader.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172874 + HRESULT D3DXGetShaderSamplers([In] const void* pFunction,[In, Out, Buffer] const void** pSamplers,[InOut] unsigned int* pCount) + D3DXGetShaderSamplers +
+ + +

Gets the shader-constant table embedded inside a shader.

+
+

Pointer to the function DWORD stream.

+

Returns the constant table interface (see ) that manages the constant table.

+ +

A constant table is generated by and embedded in the shader body. If you need additional virtual address space, see .

+
+ + bb172871 + HRESULT D3DXGetShaderConstantTable([In] const void* pFunction,[Out] ID3DXConstantTable** ppConstantTable) + D3DXGetShaderConstantTable +
+ + +

Assemble a shader.

+
+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Returns a buffer containing the created shader. This buffer contains the compiled shader code, as well as any embedded debug and symbol table information.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXAssembleShaderFromFileA because ANSI strings are being used.

+
+ + bb172708 + HRESULT D3DXAssembleShaderFromFileW([In] const wchar_t* pSrcFile,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs) + D3DXAssembleShaderFromFileW +
+ + +

Gets the shader-constant table embedded inside a shader.

+
+

Pointer to the function DWORD stream.

+

Use the D3DXCONSTTABLE_LARGEADDRESSAWARE flag to access up to 4 GB of virtual address space (instead of the default of 2 GB). If you do not need the additional virtual address space, use .

+

Returns the constant table interface (see ) that manages the constant table.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

A constant table is generated by and embedded in the shader body.

+
+ + bb943959 + HRESULT D3DXGetShaderConstantTableEx([In] const void* pFunction,[In] unsigned int Flags,[In] ID3DXConstantTable** ppConstantTable) + D3DXGetShaderConstantTableEx +
+ + +

Returns the name of the highest high-level shader language (HLSL) profile supported by a given device.

+
+

Pointer to the device. See .

+

The HLSL profile name.

If the device does not support vertex shaders then the function returns null.

+ +

A shader profile specifies the assembly shader version to use and the capabilities available to the HLSL compiler when compiling a shader. The following table lists the vertex shader profiles that are supported.

Shader ProfileDescription
vs_1_1Compile to vs_1_1 version.
vs_2_0Compile to vs_2_0 version.
vs_2_aSame as the vs_2_0 profile, with the following additional capabilities available for the compiler to target:
  • Number of Temporary Registers (r#) is greater than or equal to 13.
  • Dynamic flow control instruction.
  • Predication.
vs_3_0Compile to vs_3_0 version.

?

For more information about the differences between shader versions, see Vertex Shader Differences.

+
+ + bb172877 + const char* D3DXGetVertexShaderProfile([In] IDirect3DDevice9* pDevice) + D3DXGetVertexShaderProfile +
+ + +

Preprocesses a shader resource without performing compilation. This resolves all #defines and #includes, providing a self-contained shader for subsequent compilation.

+
+

Handle to the module that holds the shader resource. If this value is null, the current module will be used.

+

String that represents the name of the resource in the module.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Returns a buffer containing a single large string that represents the resulting formatted token stream.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb205400 + HRESULT D3DXPreprocessShaderFromResourceW([In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + D3DXPreprocessShaderFromResourceW +
+ + +

Compile a shader file.

+
+

Handle to a module containing the effect description. If this parameter is null, the current module will be used.

+

Pointer to a string that specifies the resource name.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file, or will error when compiled from a resource or memory.

+

Pointer to the shader entry point function where execution begins.

+

Pointer to a shader profile which determines the shader instruction set. See or for a list of the profiles available.

+

Compile options identified by various flags. The Direct3D 10 HLSL compiler is now the default. See Flags for details.

+

Returns a buffer containing the created shader. This buffer contains the compiled shader code, as well as any embedded debug and symbol table information.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

Returns an interface, which can be used to access shader constants. This value can be null. If you compile your application as large address aware (that is, you use the /LARGEADDRESSAWARE linker option to handle addresses larger than 2 GB), you cannot use this parameter and must set it to null. Instead, you must use the function to retrieve the shader-constant table that is embedded inside the shader. In this call, you must pass the D3DXCONSTTABLE_LARGEADDRESSAWARE flag to the Flags parameter to specify to access up to 4 GB of virtual address space.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172733 + HRESULT D3DXCompileShaderFromResourceW([In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + D3DXCompileShaderFromResourceW +
+ + +

Disassemble a shader.

+
+

Pointer to a memory buffer that contains the shader data.

+

Enable color code to make it easier to read the disassembly.

+

An optional null-terminated comment string. This value may be null.

+

Returns a buffer containing the disassembled shader. See .

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb172820 + HRESULT D3DXDisassembleShader([In] const void* pShader,[In] BOOL EnableColorCode,[In] const char* pComments,[In] ID3DXBuffer** ppDisassembly) + D3DXDisassembleShader +
+ + +

Preprocesses a shader file without performing compilation. This resolves all #defines and #includes, providing a self-contained shader for subsequent compilation.

+
+

Pointer to a string that specifies the filename of the shader.

+

An optional null terminated array of structures. This value may be null.

+

Optional interface reference, , to use for handling #include directives. If this value is null, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

+

Returns a buffer containing a single large string that represents the resulting formatted token stream.

+

Returns a buffer containing a listing of errors and warnings that were encountered during the compile. These are the same messages the debugger displays when running in debug mode. This value may be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ + bb205399 + HRESULT D3DXPreprocessShaderFromFileW([In] const wchar_t* pSrcFile,[In, Buffer, Optional] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + D3DXPreprocessShaderFromFileW +
+ + +

Returns the size of the shader byte code, in bytes.

+
+

Pointer to the function DWORD stream.

+

Returns the size of the shader byte code, in bytes.

+ + bb172875 + unsigned int D3DXGetShaderSize([In] const void* pFunction) + D3DXGetShaderSize +
+ + +

Returns the shader version of the compiled shader.

+
+

Pointer to the function DWORD stream.

+

Returns the shader version of the given shader, or zero if the shader function is null.

+ + bb172876 + unsigned int D3DXGetShaderVersion([In] const void* pFunction) + D3DXGetShaderVersion +
+ + +

Uses a left-handed coordinate system to create a mesh containing a cylinder.

+
+

Pointer to an interface, representing the device associated with the created cylinder mesh.

+

Radius at the negative Z end. Value should be greater than or equal to 0.0f.

+

Radius at the positive Z end. Value should be greater than or equal to 0.0f.

+

Length of the cylinder along the z-axis.

+

Number of slices about the main axis.

+

Number of stacks along the main axis.

+

Address of a reference to the output shape, an interface.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh. null can be specified.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The created cylinder is centered at the origin, and its axis is aligned with the z-axis.

This function creates a mesh with the creation option and | flexible vertex format (FVF).

+
+ + bb172762 + HRESULT D3DXCreateCylinder([In] IDirect3DDevice9* pDevice,[In] float Radius1,[In] float Radius2,[In] float Length,[In] unsigned int Slices,[In] unsigned int Stacks,[In] ID3DXMesh** ppMesh,[In] ID3DXBuffer** ppAdjacency) + D3DXCreateCylinder +
+ + +

Uses a left-handed coordinate system to create a mesh containing a torus.

+
+

Pointer to an interface, representing the device associated with the created torus mesh.

+

Inner-radius of the torus. Value should be greater than or equal to 0.0f.

+

Outer-radius of the torus. Value should be greater than or equal to 0.0f.

+

Number of sides in a cross-section. Value must be greater than or equal to 3.

+

Number of rings making up the torus. Value must be greater than or equal to 3.

+

Address of a reference to the output shape, an interface.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh. null can be specified.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The created torus is centered at the origin, and its axis is aligned with the z-axis. The inner radius of the torus is the radius of the cross-section (the minor radius), and the outer radius of the torus is the radius of the central hole.

This function returns a mesh that can be used later for drawing or manipulation by the application.

This function creates a mesh with the creation option and | flexible vertex format (FVF).

+
+ + bb172809 + HRESULT D3DXCreateTorus([In] IDirect3DDevice9* pDevice,[In] float InnerRadius,[In] float OuterRadius,[In] unsigned int Sides,[In] unsigned int Rings,[In] ID3DXMesh** ppMesh,[In] ID3DXBuffer** ppAdjacency) + D3DXCreateTorus +
+ + +

Uses a left-handed coordinate system to create a mesh containing a sphere.

+
+

Pointer to an interface, representing the device associated with the created sphere mesh.

+

Radius of the sphere. This value should be greater than or equal to 0.0f.

+

Number of slices about the main axis.

+

Number of stacks along the main axis.

+

Address of a reference to the output shape, an interface.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh. null can be specified.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The created sphere is centered at the origin, and its axis is aligned with the z-axis.

This function creates a mesh with the creation option and | flexible vertex format (FVF).

+
+ + bb172795 + HRESULT D3DXCreateSphere([In] IDirect3DDevice9* pDevice,[In] float Radius,[In] unsigned int Slices,[In] unsigned int Stacks,[In] ID3DXMesh** ppMesh,[In] ID3DXBuffer** ppAdjacency) + D3DXCreateSphere +
+ + +

Uses a left-handed coordinate system to create a mesh containing a teapot.

+
+

Pointer to an interface, representing the device associated with the created teapot mesh.

+

Address of a reference to the output shape, an interface.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh. null can be specified.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function creates a mesh with the creation option and | flexible vertex format (FVF).

+
+ + bb172798 + HRESULT D3DXCreateTeapot([In] IDirect3DDevice9* pDevice,[In] ID3DXMesh** ppMesh,[In] ID3DXBuffer** ppAdjacency) + D3DXCreateTeapot +
+ + +

Uses a left-handed coordinate system to create a mesh containing an axis-aligned box.

+
+

Pointer to an interface, representing the device associated with the created box mesh.

+

Width of the box, along the x-axis.

+

Height of the box, along the y-axis.

+

Depth of the box, along the z-axis.

+

Address of a reference to the output shape, an interface.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh. null can be specified.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The created box is centered at the origin.

This function creates a mesh with the creation option and | flexible vertex format (FVF).

+
+ + bb172752 + HRESULT D3DXCreateBox([In] IDirect3DDevice9* pDevice,[In] float Width,[In] float Height,[In] float Depth,[In] ID3DXMesh** ppMesh,[In] ID3DXBuffer** ppAdjacency) + D3DXCreateBox +
+ + +

Uses a left-handed coordinate system to create a mesh containing an + n-sided polygon.

+
+

Pointer to an interface, representing the device associated with the created polygon mesh.

+

Length of each side.

+

Number of sides for the polygon. Value must be greater than or equal to 3.

+

Address of a reference to the output shape, an interface.

+

Address of a reference to an interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh. null can be specified.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The created polygon is centered at the origin.

This function creates a mesh with the creation option and | flexible vertex format (FVF).

+
+ + bb172785 + HRESULT D3DXCreatePolygon([In] IDirect3DDevice9* pDevice,[In] float Length,[In] unsigned int Sides,[In] ID3DXMesh** ppMesh,[In] ID3DXBuffer** ppAdjacency) + D3DXCreatePolygon +
+ + +

Creates a mesh containing the specified text, using the font associated with the device context.

+
+

Pointer to the device that created the mesh.

+

Device context, containing the font for output. The font selected by the device context must be a TrueType font.

+

Pointer to a string that specifies the text to generate. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Maximum chordal deviation from TrueType font outlines.

+

Amount to extrude text in the negative z-direction.

+

Pointer to the returned mesh.

+

Pointer to a buffer containing adjacency information. May be null.

+

Pointer to an array of GLYPHMETRICSFLOAT structures that contain the glyph metric data. Each element contains information about the position and orientation of the corresponding glyph in the string. The number of elements in the array should be equal to the number of characters in the string. Note that the origin in each structure is not relative to the entire string, but rather is relative to that character cell. To compute the entire bounding box, add the increment for each glyph while traversing the string. If you are not concerned with the glyph sizes, set this parameter to null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateTextA because ANSI strings are being used.

This function creates a mesh with the creation option and | flexible vertex format (FVF).

+
+ + bb172799 + HRESULT D3DXCreateTextW([In] IDirect3DDevice9* pDevice,[In] HDC hDC,[In] const wchar_t* pText,[In] float Deviation,[In] float Extrusion,[In] ID3DXMesh** ppMesh,[In] ID3DXBuffer** ppAdjacency,[In] LPGLYPHMETRICSFLOAT pGlyphMetrics) + D3DXCreateTextW +
+ + +

Retrieves information about a given image file in memory.

+
+

VOID reference to the source file in memory.

+

Size of file in memory, in bytes. .

+

Pointer to a structure to be filled with the description of the data in the source file.

+ + bb172868 + HRESULT D3DXGetImageInfoFromFileInMemory([In] const void* pSrcData,[In] unsigned int SrcDataSize,[Out] D3DXIMAGE_INFO* pSrcInfo) + D3DXGetImageInfoFromFileInMemory +
+ + +

Uses a compiled high-level shader language (HLSL) function to fill each texel of each mipmap level of a texture.

+
+

Pointer to an object, representing the texture to be filled.

+

Pointer to a texture shader object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following:D3DERR_NOTAVAILABLE, .

+ +

The texture target must be an HLSL function that takes contains the following semantics:

  • One input parameter must use a POSITION semantic.
  • One input parameter must use a PSIZE semantic.
  • The function must return a parameter that uses the COLOR semantic.

The input parameters can be in any order. For an example, see

+
+ + bb172836 + HRESULT D3DXFillVolumeTextureTX([In] IDirect3DVolumeTexture9* pVolumeTexture,[In] ID3DXTextureShader* pTextureShader) + D3DXFillVolumeTextureTX +
+ + +

Creates an empty cube texture, adjusting the calling parameters as needed.

+
+

Pointer to an interface, representing the device to be associated with the texture.

+

Width and height of the cube texture, in pixels. For example, if the cube texture is an 8-pixel by 8-pixel cube, the value for this parameter should be 8.

+

Number of mip levels requested. If this value is zero or D3DX_DEFAULT, a complete mipmap chain is created.

+

0, , or . Setting this flag to indicates that the surface is to be used as a render target. The resource can then be passed to the pNewRenderTarget parameter of the SetRenderTarget method. If is specified, the application should check that the device supports this operation by calling CheckDeviceFormat. For more information about using dynamic textures, see Using Dynamic Textures.

+

Member of the enumerated type, describing the requested pixel format for the cube texture. The returned cube texture might have a different format from that specified by Format. Applications should check the format of the returned cube texture.

+

Member of the enumerated type, describing the memory class into which the cube texture should be placed.

+

Address of a reference to an interface, representing the created cube texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , E_OUTOFMEMORY.

+ +

Cube textures differ from other surfaces in that they are collections of surfaces.

Internally, uses to adjust the calling parameters. Therefore, calls to will often succeed where calls to CreateCubeTexture would fail.

+
+ + bb172755 + HRESULT D3DXCreateCubeTexture([In] IDirect3DDevice9* pDevice,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] IDirect3DCubeTexture9** ppCubeTexture) + D3DXCreateCubeTexture +
+ + +

Creates a volume texture from a file. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

When skipping mipmap levels while loading a .dds file, use the D3DX_SKIP_DDS_MIP_LEVELS macro to generate the MipFilter value. This macro takes the number of levels to skip and the filter type and returns the filter value, which would then be passed into the MipFilter parameter.

+
+ + bb172814 + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Depth,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + D3DXCreateVolumeTextureFromFileInMemoryEx +
+ + +

Uses a compiled high-level shader language (HLSL) function to fill each texel of each mipmap level of a texture.

+
+

Pointer to an object, representing the texture to be filled.

+

Pointer to a texture shader object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , .

+ +

The texture target must be an HLSL function that takes contains the following semantics:

  • One input parameter must use a POSITION semantic.
  • One input parameter must use a PSIZE semantic.
  • The function must return a parameter that uses the COLOR semantic.

The following is an example of such an HLSL function:

 float4 TextureGradientFill( float2 vTexCoord : POSITION,  float2 vTexelSize : PSIZE) : COLOR  { float r,g, b, xSq,ySq, a; xSq = 2.f*vTexCoord.x-1.f; xSq *= xSq; ySq = 2.f*vTexCoord.y-1.f; ySq *= ySq; a = sqrt(xSq+ySq); if (a > 1.0f) { a = 1.0f-(a-1.0f); } else if (a < 0.2f) { a = 0.2f; } r = 1-vTexCoord.x; g = 1-vTexCoord.y; b = vTexCoord.x; return float4(r, g, b, a); };	
+            

Note that the input parameters can be in any order, but both input semantics must be represented.

+
+ + bb172834 + HRESULT D3DXFillTextureTX([In] IDirect3DTexture9* pTexture,[In] ID3DXTextureShader* pTextureShader) + D3DXFillTextureTX +
+ + +

Checks cube-texture-creation parameters.

+
+

Pointer to an interface, representing the device to be associated with the cube texture.

+

Pointer to the requested width and height in pixels, or null. Returns the corrected size.

+

Pointer to the number of requested mipmap levels, or null. Returns the corrected number of mipmap levels.

+

0 or . Setting this flag to indicates that the surface is to be used as a render target. The resource can then be passed to the pNewRenderTarget parameter of the SetRenderTarget method. If is specified, the application should check that the device supports this operation by calling CheckDeviceFormat.

+

Pointer to a member of the enumerated type. Specifies the desired pixel format, or null. Returns the corrected format.

+

Member of the enumerated type, describing the memory class into which the texture should be placed.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , .

+ +

If parameters to this function are invalid, this function returns corrected parameters.

Cube textures differ from other surfaces in that they are collections of surfaces. To call SetRenderTarget with a cube texture, you must select an individual face using GetCubeMapSurface and pass the resulting surface to SetRenderTarget.

+
+ + bb172715 + HRESULT D3DXCheckCubeTextureRequirements([In] IDirect3DDevice9* pDevice,[InOut] unsigned int* pSize,[InOut] unsigned int* pNumMipLevels,[In] unsigned int Usage,[InOut] D3DFORMAT* pFormat,[In] D3DPOOL Pool) + D3DXCheckCubeTextureRequirements +
+ + +

Creates a texture from a file.

+
+

Pointer to an interface, representing the device to be associated with the texture.

+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Address of a reference to an interface, representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateTextureFromFileA because ANSI strings are being used.

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

The function is equivalent to (pDevice, pSrcFile, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppTexture).

Mipmapped textures automatically have each level filled with the loaded texture.

When loading images into mipmapped textures, some devices are unable to go to a 1x1 image and this function will fail. If this happens, the images need to be loaded manually.

Note that a resource created with this function will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

For the best performance when using :

  1. Doing image scaling and format conversion at load time can be slow. Store images in the format and resolution they will be used. If the target hardware requires power of two dimensions, create and store images using power of two dimensions.
  2. Consider using DirectDraw surface (DDS) files. Because DDS files can be used to represent any Direct3D 9 texture format, they are very easy for D3DX to read. Also, they can store mipmaps, so any mipmap-generation algorithms can be used to author the images.
+
+ + bb172801 + HRESULT D3DXCreateTextureFromFileW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] IDirect3DTexture9** ppTexture) + D3DXCreateTextureFromFileW +
+ + +

Loads a surface from a file.

+
+

Pointer to an interface. Specifies the destination surface, which receives the image.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination rectangle. Set this parameter to null to specify the entire surface.

+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Pointer to a structure. Specifies the source rectangle. Set this parameter to null to specify the entire image.

+

Combination of one or more controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys Thus, for opaque black, the value would be equal to 0xFF000000.

+

Pointer to a structure to be filled with a description of the data in the source image file, or null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXLoadSurfaceFromFileA because ANSI strings are being used.

This function handles conversion to and from compressed texture formats and supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Writing to a non-level-zero surface will not cause the dirty rectangle to be updated. If is called and the surface was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call AddDirtyRect on the surface.

+
+ + bb172900 + HRESULT D3DXLoadSurfaceFromFileW([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const wchar_t* pSrcFile,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + D3DXLoadSurfaceFromFileW +
+ + +

Creates an empty volume texture, adjusting the calling parameters as needed.

+
+

Pointer to an interface, representing the device to be associated with the volume texture.

+

Width in pixels. This value must be nonzero. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Height in pixels. This value must be nonzero. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Depth in pixels. This value must be nonzero. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Number of mip levels requested. If this value is zero or D3DX_DEFAULT, a complete mipmap chain is created.

+

0 or . For more information about using dynamic textures, see Using Dynamic Textures.

+

Member of the enumerated type, describing the requested pixel format for the volume texture. The returned volume texture might have a different format from that specified by Format. Applications should check the format of the returned volume texture.

+

Member of the enumerated type, describing the memory class into which the volume texture should be placed.

+

Address of a reference to an interface, representing the created volume texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , E_OUTOFMEMORY .

+ +

Internally, uses to adjust the calling parameters. Therefore, calls to will often succeed where calls to CreateVolumeTexture would fail.

+
+ + bb172810 + HRESULT D3DXCreateVolumeTexture([In] IDirect3DDevice9* pDevice,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Depth,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + D3DXCreateVolumeTexture +
+ + +

Loads a volume from a file.

+
+

Pointer to an interface. Specifies the destination volume.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination box. Set this parameter to null to specify the entire volume.

+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Pointer to a structure. Specifies the source box. Set this parameter to null to specify the entire volume.

+

Combination of one or more , controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

Pointer to a structure to be filled with a description of the data in the source image file, or null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXLoadVolumeFromFileA because ANSI strings are being used.

This function handles conversion to and from compressed texture formats and supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Writing to a non-level-zero surface of the volume texture will not cause the dirty rectangle to be updated. If is called and the texture was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call on the volume texture.

+
+ + bb172905 + HRESULT D3DXLoadVolumeFromFileW([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const wchar_t* pSrcFile,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + D3DXLoadVolumeFromFileW +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT D3DXLoadSurfaceFromResourceW([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + D3DXLoadSurfaceFromResourceW + + + +

Retrieves information about a given image file.

+
+

File name of image to retrieve information about. If UNICODE or _UNICODE are defined, this parameter type is LPCWSTR, otherwise, the type is LPCSTR.

+

Pointer to a structure to be filled with the description of the data in the source file.

+ +

This function supports both Unicode and ANSI strings.

+
+ + bb172867 + HRESULT D3DXGetImageInfoFromFileW([In] const wchar_t* pSrcFile,[Out] D3DXIMAGE_INFO* pSrcInfo) + D3DXGetImageInfoFromFileW +
+ + +

Converts a height map into a normal map. The (x,y,z) components of each normal are mapped to the (r,g,b) channels of the output texture.

+
+

Pointer to an interface, representing the destination texture.

+

Pointer to an interface, representing the source height-map texture.

+

Pointer to a type that contains the source palette of 256 colors or null.

+

One or more flags that control generation of normal maps.

+

One flag specifying the source of height information.

+

Constant value multiplier that increases (or decreases) the values in the normal map. Higher values usually make bumps more visible, lower values usually make bumps less visible.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following value: .

+ +

This method computes the normal by using the central difference with a kernel size of 3x3. The central differencing denominator used is 2.0. RGB channels in the destination contain biased (x,y,z) components of the normal.

+
+ + bb172741 + HRESULT D3DXComputeNormalMap([In] IDirect3DTexture9* pTexture,[In] IDirect3DTexture9* pSrcTexture,[Out, Buffer] const PALETTEENTRY* pSrcPalette,[In] unsigned int Flags,[In] unsigned int Channel,[In] float Amplitude) + D3DXComputeNormalMap +
+ + +

Checks volume-texture-creation parameters.

+
+

Pointer to an interface, representing the device to be associated with the volume texture.

+

Pointer to the requested width in pixels, or null. Returns the corrected size.

+

Pointer to the requested height in pixels, or null. Returns the corrected size.

+

Pointer to the requested depth in pixels, or null. Returns the corrected size.

+

Pointer to the number of requested mipmap levels, or null. Returns the corrected number of mipmap levels.

+

Currently not used, set to 0.

+

Pointer to a member of the enumerated type. Specifies the desired pixel format, or null. Returns the corrected format.

+

Member of the enumerated type, describing the memory class into which the volume texture should be placed.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , .

+ +

If parameters to this function are invalid, this function returns corrected parameters.

+
+ + bb172718 + HRESULT D3DXCheckVolumeTextureRequirements([In] IDirect3DDevice9* pDevice,[InOut] unsigned int* pWidth,[InOut] unsigned int* pHeight,[InOut] unsigned int* pDepth,[InOut] unsigned int* pNumMipLevels,[In] unsigned int Usage,[InOut] D3DFORMAT* pFormat,[In] D3DPOOL Pool) + D3DXCheckVolumeTextureRequirements +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + D3DXLoadSurfaceFromFileInMemory + + + +

Creates a texture from a file in memory.

+
+

Pointer to an interface representing the device to be associated with the texture.

+

Pointer to the file in memory from which to create the texture.

+

Size in bytes of the file in memory.

+

Address of a reference to an interface representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The function is equivalent to (pDevice, pSrcData, SrcDataSize, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppTexture).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

+
+ + bb172803 + HRESULT D3DXCreateTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DTexture9** ppTexture) + D3DXCreateTextureFromFileInMemory +
+ + +

Creates a volume texture from a file in memory.

+
+

Pointer to an interface, representing the device to be associated with the volume texture.

+

Pointer to the file in memory from which to create the volume texture.

+

Size of the file in memory, in bytes.

+

Address of a reference to an interface, representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

The function is equivalent to (pDevice, pSrcFile, SrcData, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppVolumeTexture).

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

+
+ + bb172813 + HRESULT D3DXCreateVolumeTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + D3DXCreateVolumeTextureFromFileInMemory +
+ + +

Loads a volume from another volume.

+
+

Pointer to an interface. Specifies the destination volume, which receives the image.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination box. Set this parameter to null to specify the entire volume.

+

A Pointer to an interface. Specifies the source volume.

+

Pointer to a structure, the source palette of 256 colors or null.

+

Pointer to a structure. Specifies the source box. Set this parameter to null to specify the entire volume.

+

A combination of one or more , controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

Writing to a non-level-zero surface of the volume texture will not cause the dirty rectangle to be updated. If is called and the surface was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call on the surface.

+
+ + bb172909 + HRESULT D3DXLoadVolumeFromVolume([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] IDirect3DVolume9* pSrcVolume,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey) + D3DXLoadVolumeFromVolume +
+ + +

Saves a texture to a file.

+
+

Pointer to a string that specifies the file name of the destination image. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

specifying the file format to use when saving. This function supports saving to all formats except Portable Pixmap (.ppm) and Targa/Truevision Graphics Adapter (.tga).

+

Pointer to interface, containing the texture to be saved.

+

Pointer to a structure containing a palette of 256 colors. This parameter can be null.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following:

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXSaveTextureToFileA because ANSI strings are being used.

This function handles conversion to and from compressed texture formats.

If the volume is nondynamic (because of a usage parameter set to 0 at the creation) and located in video memory (the memory pool set to ), will fail because D3DX cannot lock nondynamic volumes located in video memory.

+
+ + bb205433 + HRESULT D3DXSaveTextureToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DBaseTexture9* pSrcTexture,[In, Buffer] const PALETTEENTRY* pSrcPalette) + D3DXSaveTextureToFileW +
+ + +

Creates a cube texture from a file.

+
+

Pointer to an interface, representing the device to be associated with the cube texture.

+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Address of a reference to an interface, representing the created cube texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateCubeTextureFromFileA because ANSI strings are being used.

The function is equivalent to (pDevice, pSrcFile, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppCubeTexture).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

uses the DirectDraw surface (DDS) file format. The DirectX Texture Editor (Dxtex.exe) enables you to generate a cube map from other file formats and save it in the DDS file format.

+
+ + bb172756 + HRESULT D3DXCreateCubeTextureFromFileW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] IDirect3DCubeTexture9** ppCubeTexture) + D3DXCreateCubeTextureFromFileW +
+ + +

Creates a cube texture from a file in memory. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Cube textures differ from other surfaces in that they are collections of surfaces. To call SetRenderTarget with a cube texture, you must select an individual face using GetCubeMapSurface and pass the resulting surface to SetRenderTarget .

This method is designed to be used for loading image files stored as RT_RCDATA, which is an application-defined resource (raw data). Otherwise this method will fail.

For details on , see the Platform SDK. Note that as of DirectX 8.0, the peFlags member of the structure does not function as documented in the Platform SDK. The peFlags member is now the alpha channel for 8-bit palettized formats.

uses the DirectDraw surface (DDS) file format. The DirectX Texture Editor (Dxtex.exe) enables you to generate a cube map from other file formats and save it in the DDS file format

When skipping mipmap levels while loading a .dds file, use the D3DX_SKIP_DDS_MIP_LEVELS macro to generate the MipFilter value. This macro takes the number of levels to skip and the filter type and returns the filter value, which would then be passed into the MipFilter parameter.

+
+ + bb172759 + HRESULT D3DXCreateCubeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + D3DXCreateCubeTextureFromFileInMemoryEx +
+ + +

Creates a texture from a resource. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateTextureFromResourceExA because ANSI strings are being used.

The resource being loaded must be of type RT_BITMAP or RT_RCDATA. Resource type RT_RCDATA is used to load formats other than bitmaps (such as .tga, .jpg, and .dds).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

+
+ + bb172806 + HRESULT D3DXCreateTextureFromResourceExW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] D3DXIMAGE_INFO* pSrcInfo,[In] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + D3DXCreateTextureFromResourceExW +
+ + +

Uses a user-provided function to fill each texel of each mip level of a given cube texture.

+
+

Pointer to an interface, representing the filled texture.

+

Pointer to a user-provided evaluator function, which will be used to compute the value of each texel. The function follows the prototype of LPD3DXFILL3D.

+

Pointer to an arbitrary block of user-defined data. This reference will be passed to the function provided in pFunction.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: .

+ +

Here is an example that creates a function called ColorCubeFill, which relies on .

 // Define a function that matches the prototype of LPD3DXFILL3D	
+            VOID WINAPI ColorCubeFill (* pOut, const * pTexCoord, 	
+            const * pTexelSize, LPVOID pData)	
+            { *pOut = (pTexCoord->x, pTexCoord->y, pTexCoord->z, 0.0f);	
+            } // Fill the texture using 	
+            if (FAILED (hr =  (m_pTexture, ColorCubeFill, null)))	
+            { return hr;	
+            }	
+            
+
+ + bb172831 + HRESULT D3DXFillCubeTexture([In] IDirect3DCubeTexture9* pCubeTexture,[In] __function__stdcall* pFunction,[In] void* pData) + D3DXFillCubeTexture +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT D3DXFilterTexture([In] IDirect3DBaseTexture9* pBaseTexture,[In, Buffer] const PALETTEENTRY* pPalette,[In] unsigned int SrcLevel,[In] D3DX_FILTER Filter) + D3DXFilterTexture + + + +

Saves a texture to an image file.

+
+

specifying the file format to use when saving. This function supports saving to all formats except Portable Pixmap (.ppm) and Targa/Truevision Graphics Adapter (.tga).

+

Pointer to interface containing the image to be saved.

+

Pointer to a structure containing a palette of 256 colors. This parameter can be null.

+

Address of a reference to an that will store the image.

+ +

This function handles conversion to and from compressed texture formats.

+
+ + bb205434 + HRESULT D3DXSaveTextureToFileInMemory([Out] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DBaseTexture9* pSrcTexture,[In, Buffer] const PALETTEENTRY* pSrcPalette) + D3DXSaveTextureToFileInMemory +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT D3DXCheckTextureRequirements([In] IDirect3DDevice9* pDevice,[InOut] unsigned int* pWidth,[InOut] unsigned int* pHeight,[InOut] unsigned int* pNumMipLevels,[In] unsigned int Usage,[InOut] D3DFORMAT* pFormat,[In] D3DPOOL Pool) + D3DXCheckTextureRequirements + + + +

Saves a volume to a file on disk.

+
+

Pointer to a string that specifies the file name of the destination image. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

specifying the file format to use when saving. This function supports saving to all formats except Portable Pixmap (.ppm) and Targa/Truevision Graphics Adapter (.tga).

+

Pointer to interface containing the image to be saved.

+

Pointer to a structure containing a palette of 256 colors. This parameter can be null.

+

Pointer to a structure. Specifies the source box. Set this parameter to null to specify the entire volume.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following:

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to >D3DXSaveVolumeToFileA because ANSI strings are being used.

This function handles conversion to and from compressed texture formats.

If the volume is nondynamic (because of a usage parameter set to 0 at the creation) and located in video memory (the memory pool set to ), will fail because D3DX cannot lock nondynamic volumes located in video memory.

+
+ + bb205435 + HRESULT D3DXSaveVolumeToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox) + D3DXSaveVolumeToFileW +
+ + +

Loads a volume from a resource.

+
+

Pointer to an interface. Specifies the destination volume.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination box. Set this parameter to null to specify the entire volume.

+

Handle to the module where the resource is located, or null for module associated with the image the operating system used to create the current process.

+

Pointer to a string that specifies the file name of the source image. If UNICODE or _UNICODE are defined, this parameter type is LPCWSTR, otherwise, the type is LPCSTR.

+

Pointer to a structure. Specifies the source box. Set this parameter to null to specify the entire volume.

+

Combination of one or more , controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

Pointer to a structure to be filled with a description of the data in the source image file, or null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA.

+ +

The resource being loaded must be a bitmap resource(RT_BITMAP).

This function handles conversion to and from compressed texture formats.

Writing to a non-level-zero surface of the volume texture will not cause the dirty rectangle to be updated. If is called and the texture was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call on the volume texture.

This function supports both Unicode and ANSI strings.

+
+ + bb172908 + HRESULT D3DXLoadVolumeFromResourceW([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + D3DXLoadVolumeFromResourceW +
+ + +

Creates a volume texture from a resource specified by a string. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateVolumeTextureFromResourceExA because ANSI strings are being used.

The resource being loaded must be an application-defined resource (RT_RCDATA).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

+
+ + bb172816 + HRESULT D3DXCreateVolumeTextureFromResourceExW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Depth,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] D3DXIMAGE_INFO* pSrcInfo,[In] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + D3DXCreateVolumeTextureFromResourceExW +
+ + +

Creates a cube texture from a resource.

+
+

Pointer to an interface, representing the device to be associated with the cube texture.

+

Handle to the module where the resource is located, or null for the module associated with the image the operating system used to create the current process.

+

Pointer to a string that specifies the resource name. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Address of a reference to an interface, representing the created cube texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateCubeTextureFromResourceA because ANSI strings are being used.

The function is equivalent to (pDevice, hSrcModule, pSrcResource, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppCubeTexture).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

uses the DirectDraw surface (DDS) file format. The DirectX Texture Editor (Dxtex.exe) enables you to generate a cube map from other file formats and save it in the DDS file format.

+
+ + bb172760 + HRESULT D3DXCreateCubeTextureFromResourceW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] IDirect3DCubeTexture9** ppCubeTexture) + D3DXCreateCubeTextureFromResourceW +
+ + +

Saves a surface to a file.

+
+

Pointer to a string that specifies the file name of the destination image. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

specifying the file format to use when saving. This function supports saving to all formats except Portable Pixmap (.ppm) and Targa/Truevision Graphics Adapter (.tga).

+

Pointer to interface, containing the image to be saved.

+

Pointer to a structure containing a palette of 256 colors. This parameter can be null.

+

Pointer to a structure. Specifies the source rectangle. Set this parameter to null to specify the entire image.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following:

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXSaveSurfaceToFileA because ANSI strings are being used.

This function handles conversion to and from compressed texture formats.

+
+ + bb205431 + HRESULT D3DXSaveSurfaceToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + D3DXSaveSurfaceToFileW +
+ + +

Creates a cube texture from a file. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateCubeTextureFromFileExA because ANSI strings are being used.

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Cube textures differ from other surfaces in that they are collections of surfaces. To call SetRenderTarget with a cube texture, you must select an individual face using GetCubeMapSurface and pass the resulting surface to SetRenderTarget.

uses the DirectDraw surface (DDS) file format. The DirectX Texture Editor (Dxtex.exe) enables you to generate a cube map from other file formats and save it in the DDS file format.

When skipping mipmap levels while loading a .dds file, use the D3DX_SKIP_DDS_MIP_LEVELS macro to generate the MipFilter value. This macro takes the number of levels to skip and the filter type and returns the filter value, which would then be passed into the MipFilter parameter.

+
+ + bb172757 + HRESULT D3DXCreateCubeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + D3DXCreateCubeTextureFromFileExW +
+ + +

Retrieves information about a given image in a resource.

+
+

Module where the resource is loaded. Set this parameter to null to specify the module associated with the image that the operating system used to create the current process.

+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Pointer to a structure to be filled with the description of the data in the source file.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXGetImageInfoFromResourceA because ANSI strings are being used.

+
+ + bb172869 + HRESULT D3DXGetImageInfoFromResourceW([In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[Out] D3DXIMAGE_INFO* pSrcInfo) + D3DXGetImageInfoFromResourceW +
+ + +

Uses a compiled high-level shader language (HLSL) function to fill each texel of each mipmap level of a texture.

+
+

Pointer to an object, representing the texture to be filled.

+

Pointer to a texture shader object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , .

+ +

The texture target must be an HLSL function that takes contains the following semantics:

  • One input parameter must use a POSITION semantic.
  • One input parameter must use a PSIZE semantic.
  • The function must return a parameter that uses the COLOR semantic.

The input parameters can be in any order. For an example, see

+
+ + bb172832 + HRESULT D3DXFillCubeTextureTX([In] IDirect3DCubeTexture9* pCubeTexture,[In] ID3DXTextureShader* pTextureShader) + D3DXFillCubeTextureTX +
+ + +

Uses a user-provided function to fill each texel of each mip level of a given texture.

+
+

Pointer to an interface, representing the filled texture.

+

Pointer to a user-provided evaluator function, which will be used to compute the value of each texel. The function follows the prototype of LPD3DXFILL2D.

+

Pointer to an arbitrary block of user-defined data. This reference will be passed to the function provided in pFunction.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: .

+ +

Here is an example that creates a function called ColorFill, which relies on .

 // Define a function that matches the prototype of LPD3DXFILL3D	
+            VOID WINAPI ColorFill (* pOut, const * pTexCoord, 	
+            const * pTexelSize, LPVOID pData)	
+            { *pOut = (pTexCoord->x, pTexCoord->y, 0.0f, 0.0f);	
+            } // Fill the texture using 	
+            if (FAILED (hr =  (m_pTexture, ColorFill, null)))	
+            { return hr;	
+            }	
+            
+
+ + bb172833 + HRESULT D3DXFillTexture([In] IDirect3DTexture9* pTexture,[In] __function__stdcall* pFunction,[In] void* pData) + D3DXFillTexture +
+ + +

Saves a surface to an image file.

+
+

Address of a reference to an that will store the image.

+

specifying the file format to use when saving. This function supports saving to all formats except Portable Pixmap (.ppm) and Targa/Truevision Graphics Adapter (.tga).

+

Pointer to interface containing the image to be saved.

+

Pointer to a structure containing a palette of 256 colors. This parameter can be null.

+

Pointer to a structure. Specifies the source rectangle. Set this parameter to null to specify the entire image.

+

If the function succeeds, the return value is . If the function fails, the return value can be the following: .

+ +

This function handles conversion to and from compressed texture formats.

+
+ + bb205432 + HRESULT D3DXSaveSurfaceToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + D3DXSaveSurfaceToFileInMemory +
+ + +

Creates a cube texture from a resource specified by a string. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateCubeTextureFromResourceExA because ANSI strings are being used.

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Cube textures differ from other surfaces in that they are collections of surfaces. To call SetRenderTarget with a cube texture, you must select an individual face using GetCubeMapSurface and pass the resulting surface to SetRenderTarget.

uses the DirectDraw surface (DDS) file format. The DirectX Texture Editor (Dxtex.exe) enables you to generate a cube map from other file formats and save it in the DDS file format.

+
+ + bb172761 + HRESULT D3DXCreateCubeTextureFromResourceExW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] D3DXIMAGE_INFO* pSrcInfo,[In] PALETTEENTRY* pPalette,[In] IDirect3DCubeTexture9** ppCubeTexture) + D3DXCreateCubeTextureFromResourceExW +
+ + +

Creates a volume texture from a file.

+
+

Pointer to an interface, representing the device to be associated with the volume texture.

+

Pointer to a string that specifies the file name. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Address of a reference to an interface representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateVolumeTextureFromFileA because ANSI strings are being used.

The function is equivalent to (pDevice, pSrcFile, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppVolumeTexture).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Mipmapped textures automatically have each level filled with the loaded texture.

When loading images into mipmapped textures, some devices are unable to go to a 1x1 image and this function will fail. If this happens, then the images need to be loaded manually.

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

+
+ + bb172811 + HRESULT D3DXCreateVolumeTextureFromFileW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + D3DXCreateVolumeTextureFromFileW +
+ + +

Creates a texture from a resource.

+
+

Pointer to an interface, representing the device to be associated with the texture.

+

Handle to the module where the resource is located, or null for module associated with the image the operating system used to create the current process.

+

Pointer to a string that specifies the resource name. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Address of a reference to an interface, representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateTextureFromResourceA because ANSI strings are being used.

The function is equivalent to (pDevice, hSrcModule, pSrcResource, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppTexture).

The resource being loaded must be of type RT_BITMAP or RT_RCDATA. Resource type RT_RCDATA is used to load formats other than bitmaps (such as .tga, .jpg, and .dds).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

+
+ + bb172805 + HRESULT D3DXCreateTextureFromResourceW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] IDirect3DTexture9** ppTexture) + D3DXCreateTextureFromResourceW +
+ + +

Loads a volume from memory.

+
+

Pointer to an interface. Specifies the destination volume, which receives the image.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination box. Set this parameter to null to specify the entire volume.

+

Pointer to the top-left corner of the source volume in memory.

+

Member of the enumerated type, the pixel format of the source volume.

+

Pitch of source image, in bytes. For DXT formats (compressed texture formats), this number should represent the size of one row of cells, in bytes.

+

Pitch of source image, in bytes. For DXT formats (compressed texture formats), this number should represent the size of one slice of cells, in bytes.

+

Pointer to a structure, the source palette of 256 colors or null.

+

Pointer to a structure. Specifies the source box. null is not a valid value for this parameter.

+

A combination of one or more controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA.

+ +

Writing to a non-level-zero surface of the volume texture will not cause the dirty rectangle to be updated. If is called and the texture was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call on the volume texture.

+
+ + Bb172907 + HRESULT D3DXLoadVolumeFromMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcRowPitch,[In] unsigned int SrcSlicePitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey) + D3DXLoadVolumeFromMemory +
+ + +

Creates a volume texture from a file.

+
+

Pointer to an interface, representing the device to be associated with the texture.

+

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Width in pixels. If this value is zero or D3DX_DEFAULT, the dimensions are taken from the file. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Height, in pixels. If this value is zero or D3DX_DEFAULT, the dimensions are taken from the file. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Depth, in pixels. If this value is zero or D3DX_DEFAULT, the dimensions are taken from the file. The maximum dimension that a driver supports (for width, height, and depth) can be found in MaxVolumeExtent in .

+

Number of mip levels requested. If this value is zero or D3DX_DEFAULT, a complete mipmap chain is created.

+

0, , or . Setting this flag to indicates that the surface is to be used as a render target. The resource can then be passed to the pNewRenderTarget parameter of the SetRenderTarget method. If either or is specified, Pool must be set to , and the application should check that the device supports this operation by calling CheckDeviceFormat. indicates that the surface should be handled dynamically. For more information about using dynamic textures, see Using Dynamic Textures.

+

Member of the enumerated type, describing the requested pixel format for the texture. The returned texture might have a different format from that specified by Format. Applications should check the format of the returned texture. If , the format is taken from the file. If D3DFMT_FROM_FILE, the format is taken exactly as it is in the file, and the call will fail if this violates device capabilities.

+

Member of the enumerated type, describing the memory class into which the texture should be placed.

+

A combination of one or more controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

A combination of one or more controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying . In addition, use bits 27-31 to specify the number of mip levels to be skipped (from the top of the mipmap chain) when a .dds texture is loaded into memory; this allows you to skip up to 32 levels.

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

Pointer to a structure to be filled in with a description of the data in the source image file, or null.

+

Pointer to a structure, representing a 256-color palette to fill in, or null.

+

Address of a reference to an interface, representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateVolumeTextureFromFileExA because ANSI strings are being used.

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Mipmapped textures automatically have each level filled with the loaded volume texture. When loading images into mipmapped textures, some devices are unable to go to a 1x1 image and this function will fail. If this happens, then the images need to be loaded manually.

When skipping mipmap levels while loading a .dds file, use the D3DX_SKIP_DDS_MIP_LEVELS macro to generate the MipFilter value. This macro takes the number of levels to skip and the filter type and returns the filter value, which would then be passed into the MipFilter parameter.

+
+ + bb172812 + HRESULT D3DXCreateVolumeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Depth,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + D3DXCreateVolumeTextureFromFileExW +
+ + +

Creates a texture from a file in memory. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

For details about , see the Platform SDK. Note that as of DirectX 8.0, the peFlags member of the structure does not function as documented in the Platform SDK. The peFlags member is now the alpha channel for 8-bit palettized formats.

When skipping mipmap levels while loading a .dds file, use the D3DX_SKIP_DDS_MIP_LEVELS macro to generate the MipFilter value. This macro takes the number of levels to skip and the filter type and returns the filter value, which would then be passed into the MipFilter parameter.

+
+ + bb172804 + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + D3DXCreateTextureFromFileInMemoryEx +
+ + +

Saves a volume to a buffer. The method creates an buffer to store the data, and returns that object.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be the following:

+ + bb205436 + HRESULT D3DXSaveVolumeToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox) + D3DXSaveVolumeToFileInMemory +
+ + +

Creates a volume texture from a resource.

+
+

Pointer to an interface, representing the device to be associated with the volume texture.

+

Handle to the module where the resource is located, or null for the module associated with the image the operating system used to create the current process.

+

Pointer to a string that specifies the resource name. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

+

Address of a reference to an interface representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateVolumeTextureFromResourceA because ANSI strings are being used.

The function is equivalent to (pDevice, hSrcModule, pSrcResource, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppVolumeTexture).

The resource being loaded must be an application-defined resource (RT_RCDATA).

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

+
+ + bb172815 + HRESULT D3DXCreateVolumeTextureFromResourceW([In] IDirect3DDevice9* pDevice,[In] HINSTANCE hSrcModule,[In] const wchar_t* pSrcResource,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + D3DXCreateVolumeTextureFromResourceW +
+ + +

Creates a cube texture from a file in memory.

+
+

Pointer to an interface, representing the device to be associated with the cube texture.

+

Pointer to the file in memory from which to create the cubemap. See Remarks.

+

Size of the file in memory, in bytes.

+

Address of a reference to an interface, representing the created cube texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

The function is equivalent to (pDevice, pSrcData, SrcDataSize, D3DX_DEFAULT, D3DX_DEFAULT, 0, , , D3DX_DEFAULT, D3DX_DEFAULT, 0, null, null, ppCubeTexture).

Note that a resource created with this function when called from a object will be placed in the memory class denoted by . When this method is called from a object the resource will be placed in the memory class denoted by .

This method is designed to be used for loading image files stored as RT_RCDATA, which is an application-defined resource (raw data). Otherwise this method will fail.

Filtering is automatically applied to a texture created using this method. The filtering is equivalent to | in .

uses the DirectDraw surface (DDS) file format. The DirectX Texture Editor (Dxtex.exe) enables you to generate a cube map from other file formats and save it in the DDS file format.

+
+ + bb172758 + HRESULT D3DXCreateCubeTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DCubeTexture9** ppCubeTexture) + D3DXCreateCubeTextureFromFileInMemory +
+ + +

Creates an empty texture, adjusting the calling parameters as needed.

+
+

Pointer to an interface, representing the device to be associated with the texture.

+

Width in pixels. If this value is 0, a value of 1 is used. See Remarks.

+

Height in pixels. If this value is 0, a value of 1 is used. See Remarks.

+

Number of mip levels requested. If this value is zero or D3DX_DEFAULT, a complete mipmap chain is created.

+

0, , or . Setting this flag to indicates that the surface is to be used as a render target by calling the SetRenderTarget method. If either or is specified, the application should check that the device supports this operation by calling CheckDeviceFormat. For more information about using dynamic textures, see Using Dynamic Textures.

+

Member of the enumerated type, describing the requested pixel format for the texture. The returned texture may be of a different format from that specified, if the device does not support the requested format. Applications should check the format of the returned texture to see if it matches the format requested.

+

Member of the enumerated type, describing the memory class into which the texture should be placed.

+

Address of a reference to an interface, representing the created texture object.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , E_OUTOFMEMORY.

+ +

Internally, uses to adjust the calling parameters. Therefore, calls to will often succeed where calls to CreateTexture would fail.

If both Height and Width are set to D3DX_DEFAULT, a value of 256 is used for both parameters. If either Height or Width is set to D3DX_DEFAULT And the other parameter is set to a numeric value, the texture will be square with both the height and width equal to the numeric value.

+
+ + bb172800 + HRESULT D3DXCreateTexture([In] IDirect3DDevice9* pDevice,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] IDirect3DTexture9** ppTexture) + D3DXCreateTexture +
+ + +

Uses a user-provided function to fill each texel of each mip level of a given volume texture.

+
+

Pointer to an interface, representing the filled texture.

+

Pointer to a user-provided evaluator function, which will be used to compute the value of each texel. The function follows the prototype of LPD3DXFILL3D.

+

Pointer to an arbitrary block of user-defined data. This reference will be passed to the function provided in pFunction.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: .

+ +

If the volume is non-dynamic (because usage is set to 0 when it is created), and located in video memory (the memory pool set to ), will fail because the volume cannot be locked.

This example creates a function called ColorVolumeFill, which relies on .

 // Define a function that matches the prototype of LPD3DXFILL3D	
+            VOID WINAPI ColorVolumeFill (* pOut, const * pTexCoord, 	
+            const * pTexelSize, LPVOID pData)	
+            { *pOut = (pTexCoord->x, pTexCoord->y, pTexCoord->z, 0.0f);	
+            } // Fill volume texture	
+            if (FAILED (hr =  (m_pTexture, ColorVolumeFill, null)))	
+            { return hr;	
+            }	
+            
+
+ + bb172835 + HRESULT D3DXFillVolumeTexture([In] IDirect3DVolumeTexture9* pVolumeTexture,[In] __function__stdcall* pFunction,[In] void* pData) + D3DXFillVolumeTexture +
+ + +

Loads a surface from memory.

+
+

Pointer to an interface. Specifies the destination surface, which receives the image.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination rectangle. Set this parameter to null to specify the entire surface.

+

Pointer to the upper left corner of the source image in memory.

+

Member of the enumerated type, the pixel format of the source image.

+

Pitch of source image, in bytes. For DXT formats, this number should represent the width of one row of cells, in bytes.

+

Pointer to a structure, the source palette of 256 colors or null.

+

Pointer to a structure. Specifies the dimensions of the source image in memory. This value cannot be null.

+

Combination of one or more controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA.

+ +

This function handles conversion to and from compressed texture formats.

Writing to a non-level-zero surface will not cause the dirty rectangle to be updated. If is called and the surface was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call AddDirtyRect on the surface.

+
+ + bb172902 + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + D3DXLoadSurfaceFromMemory +
+ + +

Loads a surface from another surface with color conversion.

+
+

Pointer to an interface. Specifies the destination surface, which receives the image.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination rectangle. Set this parameter to null to specify the entire surface.

+

Pointer to an interface, representing the source surface.

+

Pointer to a structure, the source palette of 256 colors or null.

+

Pointer to a structure. Specifies the source rectangle. Set this parameter to null to specify the entire surface.

+

A combination of one or more , controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

This function handles conversion to and from compressed texture formats.

Writing to a non-level-zero surface will not cause the dirty rectangle to be updated. If is called and the surface was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call AddDirtyRect on the surface.

+
+ + bb172904 + HRESULT D3DXLoadSurfaceFromSurface([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + D3DXLoadSurfaceFromSurface +
+ + +

Loads a volume from a file in memory.

+
+

Pointer to an interface. Specifies the destination volume.

+

Pointer to a structure, the destination palette of 256 colors or null.

+

Pointer to a structure. Specifies the destination box. Set this parameter to null to specify the entire volume.

+

Pointer to the file in memory from which to load the volume.

+

Size in bytes of the file in memory.

+

Pointer to a structure. Specifies the source box. Set this parameter to null to specify the entire volume.

+

Combination of one or more , controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | .

+

value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

+

Pointer to a structure to be filled with a description of the data in the source image file, or null.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

This function handles conversion to and from compressed texture formats and supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Writing to a non-level-zero surface of the volume texture will not cause the dirty rectangle to be updated. If is called and the texture was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call on the volume texture.

+
+ + bb172906 + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + D3DXLoadVolumeFromFileInMemory +
+ + +

Creates a texture from a file. This is a more advanced function than .

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: , , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to . Otherwise, the function call resolves to D3DXCreateTextureFromFileExA because ANSI strings are being used.

Use to determine if your device can support the texture given the current state.

This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. See .

Mipmapped textures automatically have each level filled with the loaded texture. When loading images into mipmapped textures, some devices are unable to go to a 1x1 image and this function will fail. If this happens, then the images need to be loaded manually.

For the best performance when using :

  1. Doing image scaling and format conversion at load time can be slow. Store images in the format and resolution they will be used. If the target hardware requires power of 2 dimensions, then create and store images using power of 2 dimensions.
  2. For mipmap image creation at load time, filter using . A box filter is much faster than other filter types such as .
  3. Consider using DDS files. Since DDS files can be used to represent any Direct3D 9 texture format, they are very easy for D3DX to read. Also, they can store mipmaps, so any mipmap-generation algorithms can be used to author the images.

When skipping mipmap levels while loading a .dds file, use the D3DX_SKIP_DDS_MIP_LEVELS macro to generate the MipFilter value. This macro takes the number of levels to skip and the filter type and returns the filter value, which would then be passed into the MipFilter parameter.

+
+ + bb172802 + HRESULT D3DXCreateTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Width,[In] unsigned int Height,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + D3DXCreateTextureFromFileExW +
+ + +

Creates an instance of an object.

+
+ No documentation. +

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: E_POINTER, E_OUTOFMEMORY.

+ +

After using this function, use RegisterTemplates or RegisterEnumTemplates to register templates, CreateEnumObject to create an enumerator object, or CreateSaveObject to create a save object.

+
+ + bb172830 + HRESULT D3DXFileCreate([In] ID3DXFile** lplpDirectXFile) + D3DXFileCreate +
+ + + Functions + + + + + Constant ConflictingRenderState. + D3DERR_CONFLICTINGRENDERSTATE + + + Constant ConflictingTextureFilter. + D3DERR_CONFLICTINGTEXTUREFILTER + + + Constant ConflictingTexturePalette. + D3DERR_CONFLICTINGTEXTUREPALETTE + + + Constant DeviceHung. + D3DERR_DEVICEHUNG + + + Constant DeviceLost. + D3DERR_DEVICELOST + + + Constant DeviceNotReset. + D3DERR_DEVICENOTRESET + + + Constant DeviceRemoved. + D3DERR_DEVICEREMOVED + + + Constant DriverInternalError. + D3DERR_DRIVERINTERNALERROR + + + Constant InvalidCall. + D3DERR_INVALIDCALL + + + Constant InvalidDevice. + D3DERR_INVALIDDEVICE + + + Constant MoreData. + D3DERR_MOREDATA + + + Constant NoAutomaticGeneration. + D3DOK_NOAUTOGEN + + + Constant NotAvailable. + D3DERR_NOTAVAILABLE + + + Constant NotFound. + D3DERR_NOTFOUND + + + Constant OutOfVideoMemory. + D3DERR_OUTOFVIDEOMEMORY + + + Constant PresentModeChanged. + S_PRESENT_MODE_CHANGED + + + Constant PresentOccluded. + S_PRESENT_OCCLUDED + + + Constant ResidentInSharedMemory. + S_RESIDENT_IN_SHARED_MEMORY + + + Constant Success. + D3D_OK + + + Constant TooManyOperations. + D3DERR_TOOMANYOPERATIONS + + + Constant UnsupportedAlphaArgument. + D3DERR_UNSUPPORTEDALPHAARG + + + Constant UnsupportedAlphaOperation. + D3DERR_UNSUPPORTEDALPHAOPERATION + + + Constant UnsupportedColorArgument. + D3DERR_UNSUPPORTEDCOLORARG + + + Constant UnsupportedColorOperation. + D3DERR_UNSUPPORTEDCOLOROPERATION + + + Constant UnsupportedFactorValue. + D3DERR_UNSUPPORTEDFACTORVALUE + + + Constant UnsupportedTextureFilter. + D3DERR_UNSUPPORTEDTEXTUREFILTER + + + Constant WasStillDrawing. + D3DERR_WASSTILLDRAWING + + + Constant WrongTextureFormat. + D3DERR_WRONGTEXTUREFORMAT + + + +

An application implements this interface to handle callbacks in animation sets generated by calls to .

+
+ +

The LPD3DXANIMATIONCALLBACKHANDLER type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXANIMATIONCALLBACKHANDLER;	
+            
+
+ + bb205624 + ID3DXAnimationCallbackHandler + ID3DXAnimationCallbackHandler +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

The application implements this method. This method is called when a callback occurs for an animation set in one of the tracks during a call to .

+
+ No documentation. + No documentation. +

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR.

+ + bb205625 + HRESULT ID3DXAnimationCallbackHandler::HandleCallback([In] unsigned int Track,[In] void* pCallbackData) + ID3DXAnimationCallbackHandler::HandleCallback +
+ + +

This interface is used to control animation functionality, connecting animation sets with the transformation frames that are being animated. The interface has methods to mix multiple animations and to modify blending parameters over time to enable smooth transitions and other effects.

+
+ +

Create an animation controller object with .

The LPD3DXANIMATIONCONTROLLER type is defined as a reference to the interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXANIMATIONCONTROLLER;	
+            

The D3DXEVENTHANDLE type is defined as an event handle to animation controller events.

 typedef DWORD D3DXEVENTHANDLE;	
+            

The LPD3DXEVENTHANDLE type is defined as a reference to an event handle to animation controller events.

 typedef D3DXEVENTHANDLE *LPD3DXEVENTHANDLE;	
+            
+
+ + bb205626 + ID3DXAnimationController + ID3DXAnimationController +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get the maximum number of animation outputs the animation controller can support.

+
+

The maximum number of animation outputs the controller can manage.

+ + bb205634 + unsigned int ID3DXAnimationController::GetMaxNumAnimationOutputs() + ID3DXAnimationController::GetMaxNumAnimationOutputs +
+ + +

Gets the maximum number of animation sets the animation controller can support.

+
+

The maximum number of animation sets the controller can manage.

+ + bb205635 + unsigned int ID3DXAnimationController::GetMaxNumAnimationSets() + ID3DXAnimationController::GetMaxNumAnimationSets +
+ + +

Gets the maximum number of tracks in the animation controller.

+
+

Number of tracks.

+ +

The maximum number of tracks the controller can manage.

+
+ + bb205637 + unsigned int ID3DXAnimationController::GetMaxNumTracks() + ID3DXAnimationController::GetMaxNumTracks +
+ + +

Gets the maximum number of events the animation controller can support.

+
+

The maximum number of events the controller can manage.

+ + bb205636 + unsigned int ID3DXAnimationController::GetMaxNumEvents() + ID3DXAnimationController::GetMaxNumEvents +
+ + +

Adds an animation output to the animation controller and registers references for scale, rotate, and translate (SRT) transformations.

+
+

Name of the animation output.

+

Pointer to a structure containing SRT transformation data. Can be null.

+

Pointer to a vector that describes the scale of the animation set. Can be null.

+

Pointer to a quaternion that describes the rotation of the animation set. Can be null.

+

Pointer to a vector that describes the translation of the animation set. Can be null.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

If the animation output is already registered, pMatrix will be filled with the input transformation data.

Animation sets created with automatically register all loaded animation sets.

+
+ + bb205650 + HRESULT ID3DXAnimationController::RegisterAnimationOutput([In] const char* pName,[In] D3DXMATRIX* pMatrix,[In] D3DXVECTOR3* pScale,[In] D3DXQUATERNION* pRotation,[In] D3DXVECTOR3* pTranslation) + ID3DXAnimationController::RegisterAnimationOutput +
+ + +

Adds an animation set to the animation controller.

+
+

Pointer to the animation set to add.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb205651 + HRESULT ID3DXAnimationController::RegisterAnimationSet([In] ID3DXAnimationSet* pAnimSet) + ID3DXAnimationController::RegisterAnimationSet +
+ + +

Removes an animation set from the animation controller.

+
+

Pointer to the animation set to remove.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , .

+ + bb205664 + HRESULT ID3DXAnimationController::UnregisterAnimationSet([In] ID3DXAnimationSet* pAnimSet) + ID3DXAnimationController::UnregisterAnimationSet +
+ + +

Returns the number of animation sets currently registered in the animation controller.

+
+

Number of animation sets.

+ +

The controller contains any number of animations sets and tracks. Animation sets can be registered with RegisterAnimationOutput. An animation controller created by a call to will automatically register loaded animation sets.

+
+ + bb205638 + unsigned int ID3DXAnimationController::GetNumAnimationSets() + ID3DXAnimationController::GetNumAnimationSets +
+ + +

Gets an animation set.

+
+

Index of the animation set.

+

Pointer to the animation set.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

The animation controller contains an array of animation sets. This method returns one of them at the given index.

+
+ + bb205629 + HRESULT ID3DXAnimationController::GetAnimationSet([In] unsigned int Index,[Out] ID3DXAnimationSet** ppAnimationSet) + ID3DXAnimationController::GetAnimationSet +
+ + +

Gets an animation set, given its name.

+
+

String containing the name of the animation set.

+

Pointer to the animation set.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

The animation controller contains an array of animation sets. This method returns an animation set that has the given name.

+
+ + bb205630 + HRESULT ID3DXAnimationController::GetAnimationSetByName([In] const char* szName,[In] ID3DXAnimationSet** ppAnimationSet) + ID3DXAnimationController::GetAnimationSetByName +
+ + +

Animates the mesh and advances the global animation time by a specified amount.

+
+

Amount, in seconds, by which to advance the global animation time. TimeDelta value must be non-negative or zero.

+

Pointer to a user-defined animation callback handler interface, .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205627 + HRESULT ID3DXAnimationController::AdvanceTime([In] double TimeDelta,[In] ID3DXAnimationCallbackHandler* pCallbackHandler) + ID3DXAnimationController::AdvanceTime +
+ + +

Resets the global animation time to zero. Any pending events will retain their original schedules, but in the new timeframe.

+
+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

This method is typically used when the global animation time value is nearing the maximum precision of DOUBLE storage, or 264 - 1.

+
+ + bb205652 + HRESULT ID3DXAnimationController::ResetTime() + ID3DXAnimationController::ResetTime +
+ + +

Gets the global animation time.

+
+

Returns the global animation time.

+ +

Animations are designed using a local animation time and mixed into global time with AdvanceTime.

+
+ + bb205640 + double ID3DXAnimationController::GetTime() + ID3DXAnimationController::GetTime +
+ + +

Applies the animation set to the specified track.

+
+

Identifier of the track to which the animation set is applied.

+

Pointer to the animation set to be added to the track.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

This method sets the animation set to the specified track for mixing. The animation set for each track is blended according to the track weight and speed when AdvanceTime is called.

+
+ + bb205654 + HRESULT ID3DXAnimationController::SetTrackAnimationSet([In] unsigned int Track,[In] ID3DXAnimationSet* pAnimSet) + ID3DXAnimationController::SetTrackAnimationSet +
+ + +

Gets the animation set for the given track.

+
+

Track identifier.

+

Pointer to the animation set for the given track.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205641 + HRESULT ID3DXAnimationController::GetTrackAnimationSet([In] unsigned int Track,[Out] ID3DXAnimationSet** ppAnimSet) + ID3DXAnimationController::GetTrackAnimationSet +
+ + +

Sets the priority blending weight for the specified animation track.

+
+

Track identifier.

+

Track priority. This parameter should be set to one of the constants from .

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb205658 + HRESULT ID3DXAnimationController::SetTrackPriority([In] unsigned int Track,[In] D3DXPRIORITY_TYPE Priority) + ID3DXAnimationController::SetTrackPriority +
+ + +

Sets the track speed. The track speed is similar to a multiplier that is used to speed up or slow down the playback of the track.

+
+

Identifier of the track to set the speed on.

+

New speed.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205659 + HRESULT ID3DXAnimationController::SetTrackSpeed([In] unsigned int Track,[In] float Speed) + ID3DXAnimationController::SetTrackSpeed +
+ + +

Sets the track weight. The weight is used to determine how to blend multiple tracks together.

+
+

Identifier of the track to set the weight on.

+

Weight value.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205660 + HRESULT ID3DXAnimationController::SetTrackWeight([In] unsigned int Track,[In] float Weight) + ID3DXAnimationController::SetTrackWeight +
+ + +

Sets the track to the specified local animation time.

+
+

Track identifier.

+

Local animation time value to assign to the track.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205657 + HRESULT ID3DXAnimationController::SetTrackPosition([In] unsigned int Track,[In] double Position) + ID3DXAnimationController::SetTrackPosition +
+ + +

Enables or disables a track in the animation controller.

+
+

Identifier of the track to be mixed.

+

Enable value. Set to TRUE to enable this track in the controller, or to to prevent it from being mixed.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ +

To mix a track with other tracks, the Enable flag must be set to TRUE. Conversely, setting the flag to will prevent the track from being mixed with other tracks.

+
+ + bb205656 + HRESULT ID3DXAnimationController::SetTrackEnable([In] unsigned int Track,[In] BOOL Enable) + ID3DXAnimationController::SetTrackEnable +
+ + +

Sets the track description.

+
+

Identifier of the track to modify.

+

Description of the track.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205655 + HRESULT ID3DXAnimationController::SetTrackDesc([In] unsigned int Track,[In] D3DXTRACK_DESC* pDesc) + ID3DXAnimationController::SetTrackDesc +
+ + +

Gets the track description.

+
+

Track identifier.

+

Pointer to the track description. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205642 + HRESULT ID3DXAnimationController::GetTrackDesc([In] unsigned int Track,[In] D3DXTRACK_DESC* pDesc) + ID3DXAnimationController::GetTrackDesc +
+ + +

Sets the priority blending weight used by the animation controller.

+
+

Priority blending weight used by the animation controller.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: .

+ +

The blend weight is used to blend high and low priority tracks together.

+
+ + bb205653 + HRESULT ID3DXAnimationController::SetPriorityBlend([In] float BlendWeight) + ID3DXAnimationController::SetPriorityBlend +
+ + +

Gets the current priority blending weight used by the animation controller.

+
+

Returns the current priority blending weight.

+ +

The priority blending weight is used to blend high and low priority tracks together.

+
+ + bb205639 + float ID3DXAnimationController::GetPriorityBlend() + ID3DXAnimationController::GetPriorityBlend +
+ + +

Sets an event key that changes the rate of play of an animation track.

+
+

Identifier of the track to modify.

+

New speed of the animation track.

+

Global time key. Specifies the global time when the change will take place.

+

Transition time, which specifies how long the smooth transition will take to complete.

+

Specifies the transition type used for transitioning between speeds. See .

+

Event handle to the priority blend event. null is returned if one or more of the input parameters is invalid, or no free event is available.

+ + bb205648 + unsigned int ID3DXAnimationController::KeyTrackSpeed([In] unsigned int Track,[In] float NewSpeed,[In] double StartTime,[In] double Duration,[In] D3DXTRANSITION_TYPE Transition) + ID3DXAnimationController::KeyTrackSpeed +
+ + +

Sets an event key that changes the weight of an animation track. The weight is used as a multiplier when combining multiple tracks together.

+
+

Identifier of the track to modify.

+

New weight of the track.

+

Global time key. Specifies the global time when the change will take place.

+

Transition time, which specifies how long the smooth transition will take to complete.

+

Specifies the transition type used for transitioning between weights. See .

+

Event handle to the priority blend event. null is returned if one or more of the input parameters is invalid, or no free event is available.

+ +

The weight is used like a multiplier to determine how much of this track to blend together with other tracks.

+
+ + bb205649 + unsigned int ID3DXAnimationController::KeyTrackWeight([In] unsigned int Track,[In] float NewWeight,[In] double StartTime,[In] double Duration,[In] D3DXTRANSITION_TYPE Transition) + ID3DXAnimationController::KeyTrackWeight +
+ + +

Sets an event key that changes the local time of an animation track.

+
+

Identifier of the track to modify.

+

New local time of the animation track.

+

Global time key. Specifies the global time when the change will take place.

+

Event handle to the priority blend event. null is returned if Track is invalid, or if no free event is available.

+ + bb205647 + unsigned int ID3DXAnimationController::KeyTrackPosition([In] unsigned int Track,[In] double NewPosition,[In] double StartTime) + ID3DXAnimationController::KeyTrackPosition +
+ + +

Sets an event key that enables or disables an animation track.

+
+

Identifier of the animation track to modify.

+

Enable flag. Set this to TRUE to enable the animation track, or to to disable the track.

+

Global time key. Specifies the global time when the change will take place.

+

Event handle to the priority blend event. null is returned if Track is invalid.

+ + bb205646 + unsigned int ID3DXAnimationController::KeyTrackEnable([In] unsigned int Track,[In] BOOL NewEnable,[In] double StartTime) + ID3DXAnimationController::KeyTrackEnable +
+ + +

Sets blending event keys for the specified animation track.

+
+

Number between 0 and 1 that is used to blend tracks together.

+

Global time to start the blend.

+

Global time duration of the blend.

+

Specifies the transition type used for the duration of the blend. See .

+

Event handle to the priority blend event. null is returned if one or more of the input parameters is invalid, or no free event is available.

+ +

The animation controller blends in three phases: low priority tracks are blended first, high priority tracks are blended second, and then the results of both are blended.

+
+ + bb205645 + unsigned int ID3DXAnimationController::KeyPriorityBlend([In] float NewBlendWeight,[In] double StartTime,[In] double Duration,[In] D3DXTRANSITION_TYPE Transition) + ID3DXAnimationController::KeyPriorityBlend +
+ + +

Removes a specified event from an animation track, preventing the execution of the event.

+
+

Event handle to the event to be removed from the animation track.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb205663 + HRESULT ID3DXAnimationController::UnkeyEvent([In] unsigned int hEvent) + ID3DXAnimationController::UnkeyEvent +
+ + +

Removes all events from a specified animation track.

+
+

Identifier of the track on which all events should be removed.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

This method prevents the execution of all events previously scheduled on the track, and discards all data associated with those events.

+
+ + bb205662 + HRESULT ID3DXAnimationController::UnkeyAllTrackEvents([In] unsigned int Track) + ID3DXAnimationController::UnkeyAllTrackEvents +
+ + +

Removes all scheduled priority blend events from the animation controller.

+
+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb205661 + HRESULT ID3DXAnimationController::UnkeyAllPriorityBlends() + ID3DXAnimationController::UnkeyAllPriorityBlends +
+ + +

Returns an event handle to the event currently running on the specified animation track.

+
+

Track identifier.

+

Type of event to query.

+

Event handle to the event currently running on the specified track. null is returned if no event is running on the specified track.

+ + bb205632 + unsigned int ID3DXAnimationController::GetCurrentTrackEvent([In] unsigned int Track,[In] D3DXEVENT_TYPE EventType) + ID3DXAnimationController::GetCurrentTrackEvent +
+ + +

Returns an event handle to a priority blend event that is currently running.

+
+

Event handle to the currently running priority blend event. null is returned if no priority blend event is currently running.

+ + bb205631 + unsigned int ID3DXAnimationController::GetCurrentPriorityBlend() + ID3DXAnimationController::GetCurrentPriorityBlend +
+ + +

Returns an event handle to the next event scheduled to occur after a specified event on an animation track.

+
+

Track identifier.

+

Event handle to a specified event after which to search for a following event. If set to null, then the method will return the next scheduled event.

+

Event handle to the next event scheduled to run on the specified track. null is returned if no new event is scheduled.

+ +

This method can be used iteratively to locate a desired event by repeatedly passing in null for hEvent.

Note??Do not iterate further after the method has returned null.

+
+ + bb205644 + unsigned int ID3DXAnimationController::GetUpcomingTrackEvent([In] unsigned int Track,[In] unsigned int hEvent) + ID3DXAnimationController::GetUpcomingTrackEvent +
+ + +

Returns an event handle to the next priority blend event scheduled to occur after a specified event.

+
+

Event handle to a specified event after which to search for a following priority blend event. If set to null, then the method will return the next scheduled priority blend event.

+

Event handle to the next scheduled priority blend event. null is returned if no new priority blend event is scheduled.

+ +

This method can be used iteratively to locate a desired priority blend event by repeatedly passing in null for hEvent.

Note??Do not iterate further after the method has returned null.

+
+ + bb205643 + unsigned int ID3DXAnimationController::GetUpcomingPriorityBlend([In] unsigned int hEvent) + ID3DXAnimationController::GetUpcomingPriorityBlend +
+ + +

Checks whether a specified event handle is valid and the animation event has not yet completed.

+
+

Event handle to an animation event.

+

Returns if the event handle is valid and the event has not yet completed.

Returns E_FAIL if the event handle is invalid and/or the event has completed.

+ +

The method will indicate that an event handle is valid even if the event is running but has not yet completed.

+
+ + bb205665 + HRESULT ID3DXAnimationController::ValidateEvent([In] unsigned int hEvent) + ID3DXAnimationController::ValidateEvent +
+ + +

Gets a description of a specified animation event.

+
+

Event handle to an animation event to describe.

+

Pointer to a structure that contains a description of the animation event.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb205633 + HRESULT ID3DXAnimationController::GetEventDesc([In] unsigned int hEvent,[In] D3DXEVENT_DESC* pDesc) + ID3DXAnimationController::GetEventDesc +
+ + +

Clones, or copies, an animation controller.

+
+

Maximum number of animation outputs the controller can support.

+

Maximum number of animation sets the controller can support.

+

Maximum number of tracks the controller can support.

+

Maximum number of events the controller can support.

+

Address of a reference to the cloned animation controller.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb205628 + HRESULT ID3DXAnimationController::CloneAnimationController([In] unsigned int MaxNumAnimationOutputs,[In] unsigned int MaxNumAnimationSets,[In] unsigned int MaxNumTracks,[In] unsigned int MaxNumEvents,[In] ID3DXAnimationController** ppAnimController) + ID3DXAnimationController::CloneAnimationController +
+ + +

Get the maximum number of animation outputs the animation controller can support.

+
+ + bb205634 + GetMaxNumAnimationOutputs + GetMaxNumAnimationOutputs + unsigned int ID3DXAnimationController::GetMaxNumAnimationOutputs() +
+ + +

Gets the maximum number of animation sets the animation controller can support.

+
+ + bb205635 + GetMaxNumAnimationSets + GetMaxNumAnimationSets + unsigned int ID3DXAnimationController::GetMaxNumAnimationSets() +
+ + +

Gets the maximum number of tracks in the animation controller.

+
+ +

The maximum number of tracks the controller can manage.

+
+ + bb205637 + GetMaxNumTracks + GetMaxNumTracks + unsigned int ID3DXAnimationController::GetMaxNumTracks() +
+ + +

Gets the maximum number of events the animation controller can support.

+
+ + bb205636 + GetMaxNumEvents + GetMaxNumEvents + unsigned int ID3DXAnimationController::GetMaxNumEvents() +
+ + +

Returns the number of animation sets currently registered in the animation controller.

+
+ +

The controller contains any number of animations sets and tracks. Animation sets can be registered with RegisterAnimationOutput. An animation controller created by a call to will automatically register loaded animation sets.

+
+ + bb205638 + GetNumAnimationSets + GetNumAnimationSets + unsigned int ID3DXAnimationController::GetNumAnimationSets() +
+ + +

Gets the global animation time.

+
+ +

Animations are designed using a local animation time and mixed into global time with AdvanceTime.

+
+ + bb205640 + GetTime + GetTime + double ID3DXAnimationController::GetTime() +
+ + +

Gets or sets the current priority blending weight used by the animation controller.

+
+ +

The priority blending weight is used to blend high and low priority tracks together.

+
+ + bb205639 + GetPriorityBlend / SetPriorityBlend + GetPriorityBlend + float ID3DXAnimationController::GetPriorityBlend() +
+ + +

Returns an event handle to a priority blend event that is currently running.

+
+ + bb205631 + GetCurrentPriorityBlend + GetCurrentPriorityBlend + unsigned int ID3DXAnimationController::GetCurrentPriorityBlend() +
+ + +

This interface encapsulates the minimum functionality required of an animation set by an animation controller. Advanced users might want to implement this interface themselves to suit their specialized needs; for most users, however, the derived and interfaces should suffice.

+
+ +

An animation set consists of animations for many nodes for the same animation.

The LPD3DXANIMATIONSET type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXANIMATIONSET;	
+            
+
+ + bb205667 + ID3DXAnimationSet + ID3DXAnimationSet +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the animation set name.

+
+

Name of the animation set.

+ + bb205671 + const char* ID3DXAnimationSet::GetName() + ID3DXAnimationSet::GetName +
+ + +

Gets the period of the animation set.

+
+

Period of the animation set.

+ +

The period is the range of time that the animation key frames are valid. For looping animations, this is the period of the loop. The time units that the key frames are specified in (for example, seconds) is determined by the application.

+
+ + bb205673 + double ID3DXAnimationSet::GetPeriod() + ID3DXAnimationSet::GetPeriod +
+ + +

Returns time position in the local timeframe of an animation set.

+
+

Local time of the animation set.

+

Time position as measured in the timeframe of the animation set. This value will be bounded by the period of the animation set.

+ +

The time position returned by this method can be used as the PeriodicPosition parameter of .

+
+ + bb205674 + double ID3DXAnimationSet::GetPeriodicPosition([In] double Position) + ID3DXAnimationSet::GetPeriodicPosition +
+ + +

Gets the number of animations in the animation set.

+
+

Number of animations in the animation set.

+ + bb205672 + unsigned int ID3DXAnimationSet::GetNumAnimations() + ID3DXAnimationSet::GetNumAnimations +
+ + +

Gets the name of an animation, given its index.

+
+

Index of the animation.

+

Address of a reference to a string that receives the animation name.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR.

+ + bb205669 + HRESULT ID3DXAnimationSet::GetAnimationNameByIndex([In] unsigned int Index,[In] const char** ppName) + ID3DXAnimationSet::GetAnimationNameByIndex +
+ + +

Gets the index of an animation, given its name.

+
+

Name of the animation.

+

Pointer to the animation index.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR.

+ + bb205668 + HRESULT ID3DXAnimationSet::GetAnimationIndexByName([In] const char* pName,[In] unsigned int* pIndex) + ID3DXAnimationSet::GetAnimationIndexByName +
+ + +

Gets the scale, rotation, and translation values of the animation set.

+
+

Position of the animation set. The position can be obtained by calling .

+

Animation index.

+

Pointer to the vector that describes the scale of the animation set.

+

Pointer to the quaternion that describes the rotation of the animation set.

+

Pointer to the vector that describes the translation of the animation set.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR.

+ + bb205675 + HRESULT ID3DXAnimationSet::GetSRT([In] double PeriodicPosition,[In] unsigned int Animation,[Out] D3DXVECTOR3* pScale,[Out] D3DXQUATERNION* pRotation,[Out] D3DXVECTOR3* pTranslation) + ID3DXAnimationSet::GetSRT +
+ + +

Gets information about a specific callback in the animation set.

+
+

Position from which to find callbacks.

+

Callback search flags. This parameter can be set to a combination of one or more flags from .

+

Pointer to the position of the callback.

+

Address of the callback data reference.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR.

+ + bb205670 + HRESULT ID3DXAnimationSet::GetCallback([In] double Position,[In] unsigned int Flags,[Out] double* pCallbackPosition,[In] void** ppCallbackData) + ID3DXAnimationSet::GetCallback +
+ + +

Gets the animation set name.

+
+ + bb205671 + GetName + GetName + const char* ID3DXAnimationSet::GetName() +
+ + +

Gets the period of the animation set.

+
+ +

The period is the range of time that the animation key frames are valid. For looping animations, this is the period of the loop. The time units that the key frames are specified in (for example, seconds) is determined by the application.

+
+ + bb205673 + GetPeriod + GetPeriod + double ID3DXAnimationSet::GetPeriod() +
+ + +

Gets the number of animations in the animation set.

+
+ + bb205672 + GetNumAnimations + GetNumAnimations + unsigned int ID3DXAnimationSet::GetNumAnimations() +
+ + +

Applications use the methods of the interface to manipulate and query mesh and progressive mesh objects.

+
+ +

A mesh is an object made up of a set of polygonal faces. A mesh defines a set of vertices and a set of faces (the faces are defined in terms of the vertices and normals of the mesh).

The LPD3DXBASEMESH type is defined as a reference to the interface.

 typedef struct  *LPD3DXBASEMESH;	
+            
+
+ + bb205731 + ID3DXBaseMesh + ID3DXBaseMesh +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Draws a subset of a mesh.

+
+

DWORD that specifies which subset of the mesh to draw. This value is used to differentiate faces in a mesh as belonging to one or more attribute groups.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

The subset that is specified by AttribId will be rendered by the method, using the primitive type, so an index buffer must be properly initialized.

An attribute table is used to identify areas of the mesh that need to be drawn with different textures, render states, materials, and so on. In addition, the application can use the attribute table to hide portions of a mesh by not drawing a given attribute identifier (AttribId) when drawing the frame.

+
+ + bb205736 + HRESULT ID3DXBaseMesh::DrawSubset([In] unsigned int AttribId) + ID3DXBaseMesh::DrawSubset +
+ + +

Retrieves the number of faces in the mesh.

+
+

Returns the number of faces in the mesh.

+ + bb205744 + unsigned int ID3DXBaseMesh::GetNumFaces() + ID3DXBaseMesh::GetNumFaces +
+ + +

Retrieves the number of vertices in the mesh.

+
+

Returns the number of vertices in the mesh.

+ + bb205745 + unsigned int ID3DXBaseMesh::GetNumVertices() + ID3DXBaseMesh::GetNumVertices +
+ + +

Gets the fixed function vertex value.

+
+

Returns the flexible vertex format (FVF) codes.

+ +

This method can return 0 if the vertex format cannot be mapped directly to an FVF code. This will occur for a mesh created from a vertex declaration that doesn't have the same order and elements supported by the FVF codes.

+
+ + bb205741 + unsigned int ID3DXBaseMesh::GetFVF() + ID3DXBaseMesh::GetFVF +
+ + +

Retrieves a declaration describing the vertices in the mesh.

+
+

Array of elements describing the vertex format of the mesh vertices. The upper limit of this declarator array is . The vertex element array ends with the D3DDECL_END macro.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

The array of elements includes the D3DDECL_END macro, which ends the declaration.

+
+ + bb205739 + HRESULT ID3DXBaseMesh::GetDeclaration([In] D3DVERTEXELEMENT9* Declaration) + ID3DXBaseMesh::GetDeclaration +
+ + +

Gets the number of bytes per vertex.

+
+

Returns the number of bytes per vertex.

+ + bb205743 + unsigned int ID3DXBaseMesh::GetNumBytesPerVertex() + ID3DXBaseMesh::GetNumBytesPerVertex +
+ + +

Retrieves the mesh options enabled for this mesh at creation time.

+
+

Returns a combination of one or more of the following flags, indicating the options enabled for this mesh at creation time.

ValueDescription
Use 32-bit indices.
Use the usage flag for vertex and index buffers.
Equivalent to specifying both and .
Use the usage flag for vertex and index buffers.
Specifying this flag causes the vertex and index buffer of the mesh to be created with flag. This is required if the mesh object is to be rendered using N-Patch enhancement.
Equivalent to specifying both and .
Use the usage flag for vertex and index buffers.
Use the usage flag for index buffers.
Use the memory class for index buffers.
Use the memory class for index buffers.
Use the usage flag for index buffers.
Equivalent to specifying both and .
Use the usage flag for vertex buffers.
Use the memory class for vertex buffers.
Use the memory class for vertex buffers.
Use the usage flag for vertex buffers.
Equivalent to specifying both and .

?

+ + bb205746 + unsigned int ID3DXBaseMesh::GetOptions() + ID3DXBaseMesh::GetOptions +
+ + +

Retrieves the device associated with the mesh.

+
+

Address of a reference to an interface, representing the Direct3D device object associated with the mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Calling this method will increase the internal reference count on the interface. Be sure to call when you are done using this interface or you will have a memory leak.

+
+ + bb205740 + HRESULT ID3DXBaseMesh::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXBaseMesh::GetDevice +
+ + +

Clones a mesh using a flexible vertex format (FVF) code.

+
+

A combination of one or more D3DXMESH flags specifying creation options for the mesh.

+

Combination of FVF codes, which specifies the vertex format for the vertices in the output mesh. For the values of the codes, see .

+

Pointer to an interface representing the device object associated with the mesh.

+

Address of a reference to an interface, representing the cloned mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

is used to reformat and change the vertex data layout. This is done by creating a new mesh object. For example, use it to to add space for normals, texture coordinates, colors, weights, etc. that were not present before.

updates the vertex declaration with different semantic information without changing the layout of the vertex buffer. This method does not modify the contents of the vertex buffer. For example, use it to relabel a 3D texture coordinate as a binormal or tangent or vice versa.

+
+ + bb205733 + HRESULT ID3DXBaseMesh::CloneMeshFVF([In] unsigned int Options,[In] unsigned int FVF,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXMesh** ppCloneMesh) + ID3DXBaseMesh::CloneMeshFVF +
+ + +

Clones a mesh using a declarator.

+
+

A combination of one or more D3DXMESH flags specifying creation options for the mesh.

+

An array of elements, which specify the vertex format for the vertices in the output mesh.

+

Pointer to an interface, representing the device object associated with the mesh.

+

Address of a reference to an interface, representing the cloned mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

is used to reformat and change the vertex data layout. This is done by creating a new mesh object. For example, use it to add space for normals, texture coordinates, colors, weights, etc. that were not present before.

updates the vertex declaration with different semantic information without changing the layout of the vertex buffer. This method does not modify the contents of the vertex buffer. For example, use it to relabel a 3D texture coordinate as a binormal or tangent or vice versa.

+
+ + Bb205732 + HRESULT ID3DXBaseMesh::CloneMesh([In] unsigned int Options,[In] const D3DVERTEXELEMENT9* pDeclaration,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXMesh** ppCloneMesh) + ID3DXBaseMesh::CloneMesh +
+ + +

Retrieves the vertex buffer associated with the mesh.

+
+

Address of a reference to an interface, representing the vertex buffer object associated with the mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205747 + HRESULT ID3DXBaseMesh::GetVertexBuffer([Out] IDirect3DVertexBuffer9** ppVB) + ID3DXBaseMesh::GetVertexBuffer +
+ + +

Retrieves the data in an index buffer.

+
+

Address of a reference to an interface, representing the index buffer object associated with the mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205742 + HRESULT ID3DXBaseMesh::GetIndexBuffer([Out] IDirect3DIndexBuffer9** ppIB) + ID3DXBaseMesh::GetIndexBuffer +
+ + +

Locks a vertex buffer and obtains a reference to the vertex buffer memory.

+
+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

VOID* reference to a buffer containing the vertex data.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

When working with vertex buffers, you are allowed to make multiple lock calls; however, you must ensure that the number of lock calls match the number of unlock calls. DrawPrimitive calls will not succeed with any outstanding lock count on any currently set vertex buffer.

+
+ + bb205749 + HRESULT ID3DXBaseMesh::LockVertexBuffer([In] unsigned int Flags,[In] void** ppData) + ID3DXBaseMesh::LockVertexBuffer +
+ + +

Unlocks a vertex buffer.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205751 + HRESULT ID3DXBaseMesh::UnlockVertexBuffer() + ID3DXBaseMesh::UnlockVertexBuffer +
+ + +

Locks an index buffer and obtains a reference to the index buffer memory.

+
+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

VOID* reference to a buffer containing the index data. The count of indices in this buffer will be equal to * 3.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

When working with index buffers, you are allowed to make multiple lock calls. However, you must ensure that the number of lock calls match the number of unlock calls. DrawPrimitive calls will not succeed with any outstanding lock count on any currently set index buffer.

+
+ + bb205748 + HRESULT ID3DXBaseMesh::LockIndexBuffer([In] unsigned int Flags,[In] void** ppData) + ID3DXBaseMesh::LockIndexBuffer +
+ + +

Unlocks an index buffer.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205750 + HRESULT ID3DXBaseMesh::UnlockIndexBuffer() + ID3DXBaseMesh::UnlockIndexBuffer +
+ + +

Retrieves either an attribute table for a mesh, or the number of entries stored in an attribute table for a mesh.

+
+

Pointer to an array of structures, representing the entries in the mesh's attribute table. Specify null to retrieve the value for pAttribTableSize.

+

Pointer to either the number of entries stored in pAttribTable or a value to be filled in with the number of entries stored in the attribute table for the mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

An attribute table is created by and passing for the Flags parameter.

An attribute table is used to identify areas of the mesh that need to be drawn with different textures, render states, materials, and so on. In addition, the application can use the attribute table to hide portions of a mesh by not drawing a given attribute identifier when drawing the frame.

+
+ + bb205738 + HRESULT ID3DXBaseMesh::GetAttributeTable([Out] D3DXATTRIBUTERANGE* pAttribTable,[Out] unsigned int* pAttribTableSize) + ID3DXBaseMesh::GetAttributeTable +
+ + +

Converts point representative data to mesh adjacency information.

+
+

Pointer to an array of one DWORD per vertex of the mesh that contains point representative data. This parameter is optional. Supplying a null value will cause this parameter to be interpreted as an "identity" array.

+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh. The number of bytes in this array must be at least 3 * * sizeof(DWORD).

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb205735 + HRESULT ID3DXBaseMesh::ConvertPointRepsToAdjacency([In] const unsigned int* pPRep,[In] unsigned int* pAdjacency) + ID3DXBaseMesh::ConvertPointRepsToAdjacency +
+ + +

Converts mesh adjacency information to an array of point representatives.

+
+

Pointer to an array of three DWORDs per face that specify the three neighbors for each face in the mesh. The number of bytes in this array must be at least 3 * * sizeof(DWORD).

+

Pointer to an array of one DWORD per vertex of the mesh that will be filled with point representative data.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb205734 + HRESULT ID3DXBaseMesh::ConvertAdjacencyToPointReps([In] const unsigned int* pAdjacency,[In] unsigned int* pPRep) + ID3DXBaseMesh::ConvertAdjacencyToPointReps +
+ + +

Generate a list of mesh edges, as well as a list of faces that share each edge.

+
+

Specifies that vertices that differ in position by less than epsilon should be treated as coincident.

+

Pointer to an array of three DWORDs per face to be filled with the indices of adjacent faces. The number of bytes in this array must be at least 3 * * sizeof(DWORD).

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

After an application generates adjacency information for a mesh, the mesh data can be optimized for better drawing performance.

The order of the entries in the adjacency buffer is determined by the order of the vertex indices in the index buffer. The adjacent triangle 0 always corresponds to the edge between the indices of the corners 0 and 1. The adjacent triangle 1 always corresponds to the edge between the indices of the corners 1 and 2 while the adjacent triangle 2 corresponds to the edge between the indices of the corners 2 and 0.

+
+ + bb205737 + HRESULT ID3DXBaseMesh::GenerateAdjacency([In] float Epsilon,[In] unsigned int* pAdjacency) + ID3DXBaseMesh::GenerateAdjacency +
+ + +

This method allows the user to change the mesh declaration without changing the data layout of the vertex buffer. The call is valid only if the old and new declaration formats have the same vertex size.

+
+

An array of elements, describing the vertex format of the mesh vertices. The upper limit of this declarator array is .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

is used to reformat and change the vertex data layout. For example, use it to to add space for normals, texture coordinates, colors, weights, etc. that were not present before.

is a method for updating the vertex declaration with different semantic information, without changing the layout of the vertex buffer. For example, use it to relabel a 3D texture coordinate as a binormal or tangent, or vice versa.

+
+ + bb205752 + HRESULT ID3DXBaseMesh::UpdateSemantics([In] D3DVERTEXELEMENT9* Declaration) + ID3DXBaseMesh::UpdateSemantics +
+ + +

Gets the fixed function vertex value.

+
+ +

This method can return 0 if the vertex format cannot be mapped directly to an FVF code. This will occur for a mesh created from a vertex declaration that doesn't have the same order and elements supported by the FVF codes.

+
+ + bb205741 + GetFVF + GetFVF + unsigned int ID3DXBaseMesh::GetFVF() +
+ + +

Gets the number of bytes per vertex.

+
+ + bb205743 + GetNumBytesPerVertex + GetNumBytesPerVertex + unsigned int ID3DXBaseMesh::GetNumBytesPerVertex() +
+ + +

Retrieves the mesh options enabled for this mesh at creation time.

+
+ + bb205746 + GetOptions + GetOptions + unsigned int ID3DXBaseMesh::GetOptions() +
+ + +

Retrieves the device associated with the mesh.

+
+ +

Calling this method will increase the internal reference count on the interface. Be sure to call when you are done using this interface or you will have a memory leak.

+
+ + bb205740 + GetDevice + GetDevice + HRESULT ID3DXBaseMesh::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Retrieves the vertex buffer associated with the mesh.

+
+ + bb205747 + GetVertexBuffer + GetVertexBuffer + HRESULT ID3DXBaseMesh::GetVertexBuffer([Out] IDirect3DVertexBuffer9** ppVB) +
+ + +

Retrieves the data in an index buffer.

+
+ + bb205742 + GetIndexBuffer + GetIndexBuffer + HRESULT ID3DXBaseMesh::GetIndexBuffer([Out] IDirect3DIndexBuffer9** ppIB) +
+ + +

An application uses the methods of this interface to implement a key frame animation set stored in a compressed data format.

+
+ +

Create a compressed-format key frame animation set with .

The LPD3DXCOMPRESSEDANIMATIONSET type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXCOMPRESSEDANIMATIONSET;	
+            
+
+ + bb205756 + ID3DXCompressedAnimationSet + ID3DXCompressedAnimationSet +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the type of the animation set playback loop.

+
+

Type of the animation set playback loop. See .

+ + bb205760 + D3DXPLAYBACK_TYPE ID3DXCompressedAnimationSet::GetPlaybackType() + ID3DXCompressedAnimationSet::GetPlaybackType +
+ + +

Gets the number of animation key frame ticks that occur per second.

+
+

Number of animation key frame ticks that occur per second.

+ + bb205761 + double ID3DXCompressedAnimationSet::GetSourceTicksPerSecond() + ID3DXCompressedAnimationSet::GetSourceTicksPerSecond +
+ + +

Gets the data buffer that stores compressed key frame animation data.

+
+

Address of a reference to the data buffer that receives compressed key frame animation data.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb205758 + HRESULT ID3DXCompressedAnimationSet::GetCompressedData([Out] ID3DXBuffer** ppCompressedData) + ID3DXCompressedAnimationSet::GetCompressedData +
+ + +

Gets the number of callback keys in the animation set.

+
+

Number of callback keys in the animation set.

+ + bb205759 + unsigned int ID3DXCompressedAnimationSet::GetNumCallbackKeys() + ID3DXCompressedAnimationSet::GetNumCallbackKeys +
+ + +

Fills an array with callback key data used for key frame animation.

+
+

Pointer to a user-allocated array of structures that the method is to fill with callback data.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb205757 + HRESULT ID3DXCompressedAnimationSet::GetCallbackKeys([In] D3DXKEY_CALLBACK* pCallbackKeys) + ID3DXCompressedAnimationSet::GetCallbackKeys +
+ + +

Gets the type of the animation set playback loop.

+
+ + bb205760 + GetPlaybackType + GetPlaybackType + D3DXPLAYBACK_TYPE ID3DXCompressedAnimationSet::GetPlaybackType() +
+ + +

Gets the number of animation key frame ticks that occur per second.

+
+ + bb205761 + GetSourceTicksPerSecond + GetSourceTicksPerSecond + double ID3DXCompressedAnimationSet::GetSourceTicksPerSecond() +
+ + +

Gets the data buffer that stores compressed key frame animation data.

+
+ + bb205758 + GetCompressedData + GetCompressedData + HRESULT ID3DXCompressedAnimationSet::GetCompressedData([Out] ID3DXBuffer** ppCompressedData) +
+ + +

Gets the number of callback keys in the animation set.

+
+ + bb205759 + GetNumCallbackKeys + GetNumCallbackKeys + unsigned int ID3DXCompressedAnimationSet::GetNumCallbackKeys() +
+ + +

This is a user-implemented interface that allows a user to set the device state from an effect. Each of the methods in this interface must be implemented by the user and will then be used as callbacks to the application when either of the following occur:

  • An effect calls .
  • Effect state is dynamically updated by calling the appropriate state change API. See individual method pages for details.

When an application uses the state manager to implement custom callbacks, an effect no longer automatically saves and restores state when calling and . Because the application has implemented a custom save and restore behavior in the callbacks, this automatic behavior is bypassed.

+
+ +

A user creates an interface by implementing a class that derives from this interface, and implementing all the interface methods. Once the interface is created, you can get or set the state manager within an effect using and .

The LPD3DXEFFECTSTATEMANAGER type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXEFFECTSTATEMANAGER;	
+            
+
+ + bb205795 + ID3DXEffectStateManager + ID3DXEffectStateManager +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

A callback function that must be implemented by a user to set a transform.

+
+

The type of transform to apply the matrix to. See .

+

A transformation matrix. See .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205809 + HRESULT ID3DXEffectStateManager::SetTransform([In] D3DTRANSFORMSTATETYPE State,[In] const D3DMATRIX* pMatrix) + ID3DXEffectStateManager::SetTransform +
+ + +

A callback function that must be implemented by a user to set material state.

+
+

A reference to the material state. See .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205799 + HRESULT ID3DXEffectStateManager::SetMaterial([In] const D3DMATERIAL9* pMaterial) + ID3DXEffectStateManager::SetMaterial +
+ + +

A callback function that must be implemented by a user to set a light.

+
+

The zero-based index of the light. This is the same index in .

+

The light object. See .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205798 + HRESULT ID3DXEffectStateManager::SetLight([In] unsigned int Index,[In] const D3DLIGHT9* pLight) + ID3DXEffectStateManager::SetLight +
+ + +

A callback function that must be implemented by a user to enable/disable a light.

+
+

The zero-based index of the light. This is the same index in .

+

True to enable the light, false otherwise.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205796 + HRESULT ID3DXEffectStateManager::LightEnable([In] unsigned int Index,[In] BOOL Enable) + ID3DXEffectStateManager::LightEnable +
+ + +

A callback function that must be implemented by a user to set render state.

+
+

The render state to set.

+

The render state value. See Effect States (Direct3D 9).

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205805 + HRESULT ID3DXEffectStateManager::SetRenderState([In] D3DRENDERSTATETYPE State,[In] unsigned int Value) + ID3DXEffectStateManager::SetRenderState +
+ + +

A callback function that must be implemented by a user to set a texture.

+
+

The stage to which the texture is assigned. This is the index value in or .

+

A reference to the texture object. This can be any of the Direct3D texture types (cube, volume, etc.). See .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205807 + HRESULT ID3DXEffectStateManager::SetTexture([In] unsigned int Stage,[In] IDirect3DBaseTexture9* pTexture) + ID3DXEffectStateManager::SetTexture +
+ + +

A callback function that must be implemented by a user to set the texture stage state.

+
+

The stage that the texture is assigned to. This is the index value in or .

+

Defines the type of operation that a texture stage will perform. See .

+

Can be either an operation () or an argument value (), depending on what is chosen for Type.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205808 + HRESULT ID3DXEffectStateManager::SetTextureStageState([In] unsigned int Stage,[In] D3DTEXTURESTAGESTATETYPE Type,[In] unsigned int Value) + ID3DXEffectStateManager::SetTextureStageState +
+ + +

A callback function that must be implemented by a user to set a sampler.

+
+

The zero-based sampler number.

+

Identifies sampler state, which can specify the filtering, addressing, or the border color. See .

+

A value from one of the sampler state types in Type.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205806 + HRESULT ID3DXEffectStateManager::SetSamplerState([In] unsigned int Sampler,[In] D3DSAMPLERSTATETYPE Type,[In] unsigned int Value) + ID3DXEffectStateManager::SetSamplerState +
+ + +

A callback function that must be implemented by a user to set the number of subdivision segments for N-patches.

+
+

Break the surface into this number of subdivisions. This is the same as the number used by .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205800 + HRESULT ID3DXEffectStateManager::SetNPatchMode([In] float NumSegments) + ID3DXEffectStateManager::SetNPatchMode +
+ + +

A callback function that must be implemented by a user to set a FVF code.

+
+

The FVF constant, that determines how to interpret vertex data. See .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205797 + HRESULT ID3DXEffectStateManager::SetFVF([In] D3DFVF FVF) + ID3DXEffectStateManager::SetFVF +
+ + +

A callback function that must be implemented by a user to set a vertex shader.

+
+

A reference to a vertex shader object. See .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205810 + HRESULT ID3DXEffectStateManager::SetVertexShader([In] IDirect3DVertexShader9* pShader) + ID3DXEffectStateManager::SetVertexShader +
+ + +

A callback function that must be implemented by a user to set an array of vertex shader floating-point constants.

+
+

The zero-based index of the first constant register.

+

An array of floating-point constants.

+

The number of registers in pConstantData.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205812 + HRESULT ID3DXEffectStateManager::SetVertexShaderConstantF([In] unsigned int RegisterIndex,[In] const float* pConstantData,[In] unsigned int RegisterCount) + ID3DXEffectStateManager::SetVertexShaderConstantF +
+ + +

A callback function that must be implemented by a user to set an array of vertex shader integer constants.

+
+

The zero-based index of the first constant register.

+

An array of integer constants.

+

The number of registers in pConstantData.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205813 + HRESULT ID3DXEffectStateManager::SetVertexShaderConstantI([In] unsigned int RegisterIndex,[In] const int* pConstantData,[In] unsigned int RegisterCount) + ID3DXEffectStateManager::SetVertexShaderConstantI +
+ + +

A callback function that must be implemented by a user to set an array of vertex shader Boolean constants.

+
+

The zero-based index of the first constant register.

+

An array of Boolean constants.

+

The number of registers in pConstantData.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205811 + HRESULT ID3DXEffectStateManager::SetVertexShaderConstantB([In] unsigned int RegisterIndex,[In] const BOOL* pConstantData,[In] unsigned int RegisterCount) + ID3DXEffectStateManager::SetVertexShaderConstantB +
+ + +

A callback function that must be implemented by a user to set a pixel shader.

+
+

A reference to a pixel shader object. See .

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205801 + HRESULT ID3DXEffectStateManager::SetPixelShader([In] IDirect3DPixelShader9* pShader) + ID3DXEffectStateManager::SetPixelShader +
+ + +

A callback function that must be implemented by a user to set an array of vertex shader floating-point constants.

+
+

The zero-based index of the first constant register.

+

An array of floating-point constants.

+

The number of registers in pConstantData.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205803 + HRESULT ID3DXEffectStateManager::SetPixelShaderConstantF([In] unsigned int RegisterIndex,[In] const float* pConstantData,[In] unsigned int RegisterCount) + ID3DXEffectStateManager::SetPixelShaderConstantF +
+ + +

A callback function that must be implemented by a user to set an array of vertex shader integer constants.

+
+

The zero-based index of the first constant register.

+

An array of integer constants.

+

The number of registers in pConstantData.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205804 + HRESULT ID3DXEffectStateManager::SetPixelShaderConstantI([In] unsigned int RegisterIndex,[In] const int* pConstantData,[In] unsigned int RegisterCount) + ID3DXEffectStateManager::SetPixelShaderConstantI +
+ + +

A callback function that must be implemented by a user to set an array of vertex shader Boolean constants.

+
+

The zero-based index of the first constant register.

+

An array of Boolean constants.

+

The number of registers in pConstantData.

+

The user-implemented method should return . If the callback fails when setting the device state, either of the following will occur:

  • The effect will fail during .
  • The dynamic effect state call (such as ) will fail.
+ + bb205802 + HRESULT ID3DXEffectStateManager::SetPixelShaderConstantB([In] unsigned int RegisterIndex,[In] const BOOL* pConstantData,[In] unsigned int RegisterCount) + ID3DXEffectStateManager::SetPixelShaderConstantB +
+ + +

A callback function that must be implemented by a user to set material state.

+
+ + bb205799 + SetMaterial + SetMaterial + HRESULT ID3DXEffectStateManager::SetMaterial([In] const D3DMATERIAL9* pMaterial) +
+ + +

A callback function that must be implemented by a user to set the number of subdivision segments for N-patches.

+
+ + bb205800 + SetNPatchMode + SetNPatchMode + HRESULT ID3DXEffectStateManager::SetNPatchMode([In] float NumSegments) +
+ + +

A callback function that must be implemented by a user to set a FVF code.

+
+ + bb205797 + SetFVF + SetFVF + HRESULT ID3DXEffectStateManager::SetFVF([In] D3DFVF FVF) +
+ + +

A callback function that must be implemented by a user to set a vertex shader.

+
+ + bb205810 + SetVertexShader + SetVertexShader + HRESULT ID3DXEffectStateManager::SetVertexShader([In] IDirect3DVertexShader9* pShader) +
+ + +

A callback function that must be implemented by a user to set a pixel shader.

+
+ + bb205801 + SetPixelShader + SetPixelShader + HRESULT ID3DXEffectStateManager::SetPixelShader([In] IDirect3DPixelShader9* pShader) +
+ + +

This interface is implemented by the application to allocate or free frame and mesh container objects. Methods on this are called during loading and destroying frame hierarchies.

+
+ +

The LPD3DXALLOCATEHIERARCHY type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXALLOCATEHIERARCHY;	
+            
+
+ + bb205619 + ID3DXAllocateHierarchy + ID3DXAllocateHierarchy +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Requests allocation of a frame object.

+
+

Name of the frame to be created.

+

Returns the created frame object.

+

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb205620 + HRESULT ID3DXAllocateHierarchy::CreateFrame([In] const char* Name,[In] D3DXFRAME** ppNewFrame) + ID3DXAllocateHierarchy::CreateFrame +
+ + +

Requests allocation of a mesh container object.

+
+

Name of the mesh.

+

Pointer to the mesh data structure. See .

+

Array of materials used in the mesh.

+

Array of effect instances used in the mesh. See .

+

Number of materials in the materials array.

+

Adjacency array for the mesh.

+

Pointer to the skin mesh object if skin data is found. See .

+

Returns the created mesh container. See .

+

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb205621 + HRESULT ID3DXAllocateHierarchy::CreateMeshContainer([In] const char* Name,[In] const D3DXMESHDATA* pMeshData,[In] const D3DXMATERIAL* pMaterials,[In] const D3DXEFFECTINSTANCE* pEffectInstances,[In] unsigned int NumMaterials,[In] const unsigned int* pAdjacency,[In] ID3DXSkinInfo* pSkinInfo,[In] D3DXMESHCONTAINER** ppNewMeshContainer) + ID3DXAllocateHierarchy::CreateMeshContainer +
+ + +

Requests deallocation of a frame object.

+
+

Pointer to the frame to be deallocated.

+

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb205622 + HRESULT ID3DXAllocateHierarchy::DestroyFrame([In] D3DXFRAME* pFrameToFree) + ID3DXAllocateHierarchy::DestroyFrame +
+ + +

Requests deallocation of a mesh container object.

+
+

Pointer to the mesh container object to be deallocated.

+

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb205623 + HRESULT ID3DXAllocateHierarchy::DestroyMeshContainer([In] D3DXMESHCONTAINER* pMeshContainerToFree) + ID3DXAllocateHierarchy::DestroyMeshContainer +
+ + +

This interface is implemented by the application to save any additional user data embedded in .x files. An instance of this interface is passed to , and D3DX calls the appropriate method on this interface every time the appropriate data is encountered. For example, for each frame object in the .x file, is called and passed the child data.

+
+ +

The LPD3DXLOADUSERDATA type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXLOADUSERDATA;	
+            
+
+ + bb174034 + ID3DXLoadUserData + ID3DXLoadUserData +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Load top level data from a .x file.

+
+

Pointer to a .x file data structure. This is defined in Dxfile.h.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb174037 + HRESULT ID3DXLoadUserData::LoadTopLevelData([In] ID3DXFileData* pXofChildData) + ID3DXLoadUserData::LoadTopLevelData +
+ + +

Load frame child data from a .x file.

+
+

Pointer to a mesh container. See .

+

Pointer to a .x file data structure. This is defined in Dxfile.h.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb174035 + HRESULT ID3DXLoadUserData::LoadFrameChildData([In] D3DXFRAME* pFrame,[In] ID3DXFileData* pXofChildData) + ID3DXLoadUserData::LoadFrameChildData +
+ + +

Load mesh child data from a .x file.

+
+

Pointer to a mesh container. See .

+

Pointer to a .x file data structure. This is defined in Dxfile.h.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb174036 + HRESULT ID3DXLoadUserData::LoadMeshChildData([In] D3DXMESHCONTAINER* pMeshContainer,[In] ID3DXFileData* pXofChildData) + ID3DXLoadUserData::LoadMeshChildData +
+ + +

is a user-implemented interface to provide callbacks for #include directives during shader compilation. Each of the methods in this interface must be implemented by the user which will then be used as callbacks to the application when one of the following occurs:

  • An HLSL shader that contains a #include is compiled by calling one of the *** functions.
  • An assembly shader #include is assembled by calling any of the *** functions.
  • An effect that contains a #include is compiled by by calling any of the *** or *** functions.
+
+ +

A user creates an interface by implementing a class that derives from this interface, and implementing all the interface methods.

The LPD3DXINCLUDE type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXINCLUDE;	
+            
+
+ + bb173986 + ID3DXInclude + ID3DXInclude +
+ + + A user-implemented method for opening and reading the contents of a shader #include file. + + A -typed value that indicates the location of the #include file. + Name of the #include file. + Pointer to the container that includes the #include file. + Stream that is associated with fileName to be read. This reference remains valid until is called. + HRESULT Open([None] D3D_INCLUDE_TYPE IncludeType,[None] const char* pFileName,[None] LPCVOID pParentData,[None] LPCVOID* ppData,[None] UINT* pBytes) + + + + A user-implemented method for closing a shader #include file. + + + If was successful, Close is guaranteed to be called before the API using the interface returns. + + This is a reference that was returned by the corresponding call. + HRESULT Close([None] LPCVOID pData) + + + +

Applications use the methods of the interface to manipulate an index buffer resource.

+
+ +

The interface is obtained by calling the method.

This interface inherits additional functionality from the interface.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DINDEXBUFFER9 and PDIRECT3DINDEXBUFFER9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DINDEXBUFFER9, *PDIRECT3DINDEXBUFFER9;	
+            
+
+ + bb205865 + IDirect3DIndexBuffer9 + IDirect3DIndexBuffer9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Locks a range of index data and obtains a reference to the index buffer memory.

+
+

Offset into the index data to lock, in bytes. Lock the entire index buffer by specifying 0 for both parameters, SizeToLock and OffsetToLock.

+

Size of the index data to lock, in bytes. Lock the entire index buffer by specifying 0 for both parameters, SizeToLock and OffsetToLock.

+

VOID* reference to a memory buffer containing the returned index data.

+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

As a general rule, do not hold a lock across more than one frame. When working with index buffers, you are allowed to make multiple lock calls. However, you must ensure that the number of lock calls match the number of unlock calls. calls will not succeed with any outstanding lock count on any currently set index buffer.

The and flags are valid only on buffers created with .

See Programming Tips (Direct3D 9) for information about using or .

+
+ + bb205867 + HRESULT IDirect3DIndexBuffer9::Lock([In] unsigned int OffsetToLock,[In] unsigned int SizeToLock,[Out] void** ppbData,[In] D3DLOCK Flags) + IDirect3DIndexBuffer9::Lock +
+ + +

Unlocks index data.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205868 + HRESULT IDirect3DIndexBuffer9::Unlock() + IDirect3DIndexBuffer9::Unlock +
+ + +

Retrieves a description of the index buffer resource.

+
+

Pointer to a structure, describing the returned index buffer.

+

If the method succeeds, the return value is . is returned if the argument is invalid.

+ + bb205866 + HRESULT IDirect3DIndexBuffer9::GetDesc([Out] D3DINDEXBUFFER_DESC* pDesc) + IDirect3DIndexBuffer9::GetDesc +
+ + + Initializes a new instance of the class. + + The device. + The size in bytes. + The usage. + The pool. + if set to true use 16bit index buffer, otherwise, use 32bit index buffer. + HRESULT IDirect3DDevice9::CreateIndexBuffer([In] unsigned int Length,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DIndexBuffer9** ppIndexBuffer,[In] void** pSharedHandle) + + + + Initializes a new instance of the class. + + The device. + The size in bytes. + The usage. + The pool. + if set to true use 16bit index buffer, otherwise, use 32bit index buffer. + The shared handle. + HRESULT IDirect3DDevice9::CreateIndexBuffer([In] unsigned int Length,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DIndexBuffer9** ppIndexBuffer,[In] void** pSharedHandle) + + + + Locks the specified index buffer. + + The offset in the buffer. + The size of the buffer to lock. + The lock flags. + A containing the locked index buffer. + HRESULT IDirect3DIndexBuffer9::Lock([In] unsigned int OffsetToLock,[In] unsigned int SizeToLock,[In] void** ppbData,[In] unsigned int Flags) + + + +

Retrieves a description of the index buffer resource.

+
+ + bb205866 + GetDesc + GetDesc + HRESULT IDirect3DIndexBuffer9::GetDesc([Out] D3DINDEXBUFFER_DESC* pDesc) +
+ + +

This interface is implemented by the application to save any additional user data embedded in .x files. An instance of this interface is passed to , and D3DX calls the appropriate method on this interface every time the appropriate data is encountered. For example, for each frame object in the .x file, is called and passed the child data.

+
+ +

The LPD3DXSAVEUSERDATA type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXSAVEUSERDATA;	
+            
+
+ + bb174199 + ID3DXSaveUserData + ID3DXSaveUserData +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Add child data to the frame.

+
+

Pointer to a mesh container. See .

+

Pointer to a .x file save object. Use the reference to call to add a child data object. Do not save the data with .

+

Pointer to a .x file data node. Use the reference to call to add a child data object.

+

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ +

and provide a mechanism for adding a template to a .x file for saving user data.

+
+ + bb174200 + HRESULT ID3DXSaveUserData::AddFrameChildData([In] const D3DXFRAME* pFrame,[In] ID3DXFileSaveObject* pXofSave,[In] ID3DXFileSaveData* pXofFrameData) + ID3DXSaveUserData::AddFrameChildData +
+ + +

Add child data to the mesh.

+
+

Pointer to a mesh container. See .

+

Pointer to a .x file save object. Use the reference to call to add a child data object. Do not save the data with .

+

Pointer to a .x file data node. Use the reference to call to add a child data object.

+

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb174201 + HRESULT ID3DXSaveUserData::AddMeshChildData([In] const D3DXMESHCONTAINER* pMeshContainer,[In] ID3DXFileSaveObject* pXofSave,[In] ID3DXFileSaveData* pXofMeshData) + ID3DXSaveUserData::AddMeshChildData +
+ + +

Add a top level object before the frame hierarchy.

+
+

Pointer to a .x file save object. Use this reference to call IDirectXFileSaveObject::CreateDataObject to create the data object to be saved. Then call IDirectXFileSaveObject::SaveData to save the data.

+

The return values of this method are implemented by an application programmer. In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb174203 + HRESULT ID3DXSaveUserData::AddTopLevelDataObjectsPre([In] ID3DXFileSaveObject* pXofSave) + ID3DXSaveUserData::AddTopLevelDataObjectsPre +
+ + +

Add a top level object after the frame hierarchy.

+
+

Pointer to a .x file save object. Use this reference to call IDirectXFileSaveObject::CreateDataObject to create the data object to be saved. Then call IDirectXFileSaveObject::SaveData to save the data.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ + bb174202 + HRESULT ID3DXSaveUserData::AddTopLevelDataObjectsPost([In] ID3DXFileSaveObject* pXofSave) + ID3DXSaveUserData::AddTopLevelDataObjectsPost +
+ + +

A callback for the user to register a .x file template.

+
+

Use this reference to register user-defined .x file templates. See . Do not use this parameter to add data objects.

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ +

and provide a mechanism for adding a template to a .x file for saving user data.

+
+ + bb174204 + HRESULT ID3DXSaveUserData::RegisterTemplates([In] ID3DXFile* pXFileApi) + ID3DXSaveUserData::RegisterTemplates +
+ + +

A callback for the user to save a .x file template.

+
+

Pointer to a .x file save object. Do not use this parameter to add data objects. See .

+

The return values of this method are implemented by an application programmer.In general, if no error occurs, program the method to return . Otherwise, program the method to return an appropriate error message from D3DERR or D3DXERR, as this will cause to fail also, and return the error.

+ +

and provide a mechanism for adding a template to a .x file for saving user data.

+
+ + bb174205 + HRESULT ID3DXSaveUserData::SaveTemplates([In] ID3DXFileSaveObject* pXofSave) + ID3DXSaveUserData::SaveTemplates +
+ + +

An application uses the methods of this interface to implement a key frame animation set.

+
+ +

Create a keyframed animation set with .

The LPD3DXKEYFRAMEDANIMATIONSET type is defined as a reference to this interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXKEYFRAMEDANIMATIONSET;	
+            
+
+ + bb173989 + ID3DXKeyframedAnimationSet + ID3DXKeyframedAnimationSet +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the type of the animation set playback loop.

+
+

Type of the animation set playback loop. See .

+ + bb173997 + D3DXPLAYBACK_TYPE ID3DXKeyframedAnimationSet::GetPlaybackType() + ID3DXKeyframedAnimationSet::GetPlaybackType +
+ + +

Gets the number of animation key frame ticks that occur per second.

+
+

Number of animation key frame ticks that occur per second.

+ + bb174004 + double ID3DXKeyframedAnimationSet::GetSourceTicksPerSecond() + ID3DXKeyframedAnimationSet::GetSourceTicksPerSecond +
+ + +

Gets the number of scale keys in the specified key frame animation.

+
+

Animation index.

+

Number of scale keys in the specified key frame animation.

+ + bb173995 + unsigned int ID3DXKeyframedAnimationSet::GetNumScaleKeys([In] unsigned int Animation) + ID3DXKeyframedAnimationSet::GetNumScaleKeys +
+ + +

Fills an array with scale key data used for key frame animation.

+
+

Animation index.

+

Pointer to a user-allocated array of vectors that the method is to fill with animation scale data.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174003 + HRESULT ID3DXKeyframedAnimationSet::GetScaleKeys([In] unsigned int Animation,[In] D3DXKEY_VECTOR3* pScaleKeys) + ID3DXKeyframedAnimationSet::GetScaleKeys +
+ + +

Get scale information for a specific key frame in the animation set.

+
+

Animation index.

+

Key frame.

+

Pointer to the scale data. See .

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174002 + HRESULT ID3DXKeyframedAnimationSet::GetScaleKey([In] unsigned int Animation,[In] unsigned int Key,[In] D3DXKEY_VECTOR3* pScaleKey) + ID3DXKeyframedAnimationSet::GetScaleKey +
+ + +

Set scale information for a specific key frame in the animation set.

+
+

Animation index.

+

Key frame.

+

Pointer to the scale data. See .

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174010 + HRESULT ID3DXKeyframedAnimationSet::SetScaleKey([In] unsigned int Animation,[In] unsigned int Key,[In] D3DXKEY_VECTOR3* pScaleKey) + ID3DXKeyframedAnimationSet::SetScaleKey +
+ + +

Gets the number of rotation keys in the specified key frame animation.

+
+

Animation index.

+

Number of rotation keys in the specified key frame animation.

+ + bb173994 + unsigned int ID3DXKeyframedAnimationSet::GetNumRotationKeys([In] unsigned int Animation) + ID3DXKeyframedAnimationSet::GetNumRotationKeys +
+ + +

Fills an array with rotational key data used for key frame animation.

+
+

Animation index.

+

Pointer to a user-allocated array of quaternions that the method is to fill with animation rotation data.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174001 + HRESULT ID3DXKeyframedAnimationSet::GetRotationKeys([In] unsigned int Animation,[In] D3DXKEY_QUATERNION* pRotationKeys) + ID3DXKeyframedAnimationSet::GetRotationKeys +
+ + +

Get rotation information for a specific key frame in the animation set.

+
+

Animation index.

+

Key frame.

+

Pointer to the rotation data. See .

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb173998 + HRESULT ID3DXKeyframedAnimationSet::GetRotationKey([In] unsigned int Animation,[In] unsigned int Key,[In] D3DXKEY_QUATERNION* pRotationKey) + ID3DXKeyframedAnimationSet::GetRotationKey +
+ + +

Set rotation information for a specific key frame in the animation set.

+
+

Animation index.

+

Key frame.

+

Pointer to the rotation data. See .

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174009 + HRESULT ID3DXKeyframedAnimationSet::SetRotationKey([In] unsigned int Animation,[In] unsigned int Key,[In] D3DXKEY_QUATERNION* pRotationKey) + ID3DXKeyframedAnimationSet::SetRotationKey +
+ + +

Gets the number of translation keys in the specified key frame animation.

+
+

Animation index.

+

Number of translation keys in the specified key frame animation.

+ + bb173996 + unsigned int ID3DXKeyframedAnimationSet::GetNumTranslationKeys([In] unsigned int Animation) + ID3DXKeyframedAnimationSet::GetNumTranslationKeys +
+ + +

Fills an array with translational key data used for key frame animation.

+
+

Animation index.

+

Pointer to a user-allocated array of vectors that the method is to fill with animation translation data.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174006 + HRESULT ID3DXKeyframedAnimationSet::GetTranslationKeys([In] unsigned int Animation,[In] D3DXKEY_VECTOR3* pTranslationKeys) + ID3DXKeyframedAnimationSet::GetTranslationKeys +
+ + +

Get translation information for a specific key frame in the animation set.

+
+

Animation index.

+

Key Frame.

+

Pointer to the rotation information. See .

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174005 + HRESULT ID3DXKeyframedAnimationSet::GetTranslationKey([In] unsigned int Animation,[In] unsigned int Key,[In] D3DXKEY_VECTOR3* pTranslationKey) + ID3DXKeyframedAnimationSet::GetTranslationKey +
+ + +

Set translation information for a specific key frame in the animation set.

+
+

Animation index.

+

Key Frame.

+

Pointer to the translation data. See .

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174011 + HRESULT ID3DXKeyframedAnimationSet::SetTranslationKey([In] unsigned int Animation,[In] unsigned int Key,[In] D3DXKEY_VECTOR3* pTranslationKey) + ID3DXKeyframedAnimationSet::SetTranslationKey +
+ + +

Gets the number of callback keys in the animation set.

+
+

Number of callback keys in the animation set.

+ + bb173993 + unsigned int ID3DXKeyframedAnimationSet::GetNumCallbackKeys() + ID3DXKeyframedAnimationSet::GetNumCallbackKeys +
+ + +

Fills an array with callback key data used for key frame animation.

+
+

Pointer to a user-allocated array of structures that the method is to fill with callback data.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb173992 + HRESULT ID3DXKeyframedAnimationSet::GetCallbackKeys([In] D3DXKEY_CALLBACK* pCallbackKeys) + ID3DXKeyframedAnimationSet::GetCallbackKeys +
+ + +

Gets information about a specific callback in the animation set.

+
+

Animation index.

+

Pointer to the callback function.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb173991 + HRESULT ID3DXKeyframedAnimationSet::GetCallbackKey([In] unsigned int Key,[In] D3DXKEY_CALLBACK* pCallbackKey) + ID3DXKeyframedAnimationSet::GetCallbackKey +
+ + +

Sets information about a specific callback in the animation set.

+
+

Animation index.

+

Pointer to the callback function.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174008 + HRESULT ID3DXKeyframedAnimationSet::SetCallbackKey([In] unsigned int Key,[In] D3DXKEY_CALLBACK* pCallbackKey) + ID3DXKeyframedAnimationSet::SetCallbackKey +
+ + +

Removes the scale data at the specified key frame.

+
+

Animation identifier.

+

Key frame.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

This method is slow and should not be used after an animation has begun to play.

+
+ + bb174014 + HRESULT ID3DXKeyframedAnimationSet::UnregisterScaleKey([In] unsigned int Animation,[In] unsigned int Key) + ID3DXKeyframedAnimationSet::UnregisterScaleKey +
+ + +

Removes the rotation data at the specified key frame.

+
+

Animation identifier.

+

Key frame.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

This method is slow and should not be used after an animation has begun to play.

+
+ + bb174013 + HRESULT ID3DXKeyframedAnimationSet::UnregisterRotationKey([In] unsigned int Animation,[In] unsigned int Key) + ID3DXKeyframedAnimationSet::UnregisterRotationKey +
+ + +

Removes the translation data at the specified key frame.

+
+

Animation identifier.

+

Key frame.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ +

This method is slow and should not be used after an animation has begun to play.

+
+ + bb174015 + HRESULT ID3DXKeyframedAnimationSet::UnregisterTranslationKey([In] unsigned int Animation,[In] unsigned int Key) + ID3DXKeyframedAnimationSet::UnregisterTranslationKey +
+ + +

Register the scale, rotate, and translate (SRT) key frame data for an animation.

+
+

Pointer to the animation name.

+

Number of scale keys.

+

Number of rotation keys.

+

Number of translation keys.

+

Address of a reference to a user-allocated array of vectors that the method fills with scale data.

+

Address of a reference to a user-allocated array of quaternions that the method fills with rotation data.

+

Address of a reference to a user-allocated array of vectors that the method fills with translation data.

+

Returns the animation index.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned:

+ + bb174007 + HRESULT ID3DXKeyframedAnimationSet::RegisterAnimationSRTKeys([In] const char* pName,[In] unsigned int NumScaleKeys,[In] unsigned int NumRotationKeys,[In] unsigned int NumTranslationKeys,[In] const D3DXKEY_VECTOR3* pScaleKeys,[In] const D3DXKEY_QUATERNION* pRotationKeys,[In] const D3DXKEY_VECTOR3* pTranslationKeys,[In] unsigned int* pAnimationIndex) + ID3DXKeyframedAnimationSet::RegisterAnimationSRTKeys +
+ + +

Transforms animations in an animation set into a compressed format and returns a reference to the buffer that stores the compressed data.

+
+

One of the values that define the compression mode used for storing compressed animation set data. is the only value currently supported.

+

Desired compression loss ratio, in the range from 0 to 1.

+

Pointer to a transformation frame hierarchy. Can be null.

+

Address of a reference to the compressed animation set.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: , E_OUTOFMEMORY.

+ + bb173990 + HRESULT ID3DXKeyframedAnimationSet::Compress([In] unsigned int Flags,[In] float Lossiness,[In] D3DXFRAME* pHierarchy,[In] ID3DXBuffer** ppCompressedData) + ID3DXKeyframedAnimationSet::Compress +
+ + +

Remove the animation data from the animation set.

+
+

The animation index.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: .

+ + bb174012 + HRESULT ID3DXKeyframedAnimationSet::UnregisterAnimation([In] unsigned int Index) + ID3DXKeyframedAnimationSet::UnregisterAnimation +
+ + +

Gets the type of the animation set playback loop.

+
+ + bb173997 + GetPlaybackType + GetPlaybackType + D3DXPLAYBACK_TYPE ID3DXKeyframedAnimationSet::GetPlaybackType() +
+ + +

Gets the number of animation key frame ticks that occur per second.

+
+ + bb174004 + GetSourceTicksPerSecond + GetSourceTicksPerSecond + double ID3DXKeyframedAnimationSet::GetSourceTicksPerSecond() +
+ + +

Gets the number of callback keys in the animation set.

+
+ + bb173993 + GetNumCallbackKeys + GetNumCallbackKeys + unsigned int ID3DXKeyframedAnimationSet::GetNumCallbackKeys() +
+ + +

The interface implements line drawing using textured triangles.

+
+ +

Create a line drawing object with .

The LPD3DXLINE type is defined as a reference to the interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXLINE;	
+            
+
+ + bb174016 + ID3DXLine + ID3DXLine +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the Direct3D device associated with the line object.

+
+

Address of a reference to an interface, representing the Direct3D device object associated with the line object.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174022 + HRESULT ID3DXLine::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXLine::GetDevice +
+ + +

Prepares a device for drawing lines.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

Calling is optional. If called outside of a / sequence, the draw functions will internally call and . To avoid extra overhead, this method should be used if more than one draw function will be called successively.

This method must be called from inside an and sequence.

cannot be used as a substitute for either or .

+
+ + bb174017 + HRESULT ID3DXLine::Begin() + ID3DXLine::Begin +
+ + +

Draws a line strip in screen space. Input is in the form of an array that defines points (of ) on the line strip.

+
+ No documentation. + No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174018 + HRESULT ID3DXLine::Draw([In] const void* pVertexList,[In] unsigned int dwVertexListCount,[In] D3DCOLOR Color) + ID3DXLine::Draw +
+ + +

Draws a line strip in screen space with a specified input transformation matrix.

+
+

Array of vertices that make up the line. See .

+

Number of vertices in the vertex list.

+

A scale, rotate, and translate (SRT) matrix for transforming the points. See . If this matrix is a projection matrix, any stippled lines will be drawn with a perspective-correct stippling pattern. Or, you can transform the vertices and use to draw the line with a nonperspective-correct stipple pattern.

+

Color of the line. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174019 + HRESULT ID3DXLine::DrawTransform([In] const void* pVertexList,[In] unsigned int dwVertexListCount,[In] const D3DXMATRIX* pTransform,[In] D3DCOLOR Color) + ID3DXLine::DrawTransform +
+ + +

Applies a stipple pattern to the line.

+
+

Describes the stipple pattern: 1 is opaque, 0 is transparent.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174031 + HRESULT ID3DXLine::SetPattern([In] unsigned int dwPattern) + ID3DXLine::SetPattern +
+ + +

Gets the line stipple pattern.

+
+

Returns the line stipple pattern: 1 is opaque, 0 is transparent.

+ + bb174024 + unsigned int ID3DXLine::GetPattern() + ID3DXLine::GetPattern +
+ + +

Stretches the stipple pattern along the line direction.

+
+

Stipple pattern scaling value. 1.0f is the default value and represents no scaling. A value less than 1.0f shrinks the pattern, and a value greater than 1.0 stretches the pattern.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174032 + HRESULT ID3DXLine::SetPatternScale([In] float fPatternScale) + ID3DXLine::SetPatternScale +
+ + +

Gets the stipple-pattern scale value.

+
+

Returns the value used to scale the stipple-pattern. 1.0f is the default value and represents no scaling. A value less than 1.0f shrinks the pattern, and a value greater than 1.0 stretches the pattern.

+ + bb174025 + float ID3DXLine::GetPatternScale() + ID3DXLine::GetPatternScale +
+ + +

Specifies the thickness of the line.

+
+

Describes the line width.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174033 + HRESULT ID3DXLine::SetWidth([In] float fWidth) + ID3DXLine::SetWidth +
+ + +

Gets the thickness of the line.

+
+

The line thickness.

+ + bb174026 + float ID3DXLine::GetWidth() + ID3DXLine::GetWidth +
+ + +

Toggles line antialiasing.

+
+

Toggles antialiasing on and off. TRUE turns antialiasing on, and turns antialiasing off.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174029 + HRESULT ID3DXLine::SetAntialias([In] BOOL bAntialias) + ID3DXLine::SetAntialias +
+ + +

Gets the line antialiasing state.

+
+

Returns the antialiasing switch value. TRUE means antialiasing is on, and means antialiasing is off.

+ + bb174021 + BOOL ID3DXLine::GetAntialias() + ID3DXLine::GetAntialias +
+ + +

Toggles the mode to draw OpenGL-style lines.

+
+

Toggles OpenGL-style line drawing. TRUE enables OpenGL-style lines, and enables Direct3D-style lines.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174030 + HRESULT ID3DXLine::SetGLLines([In] BOOL bGLLines) + ID3DXLine::SetGLLines +
+ + +

Gets the OpenGL-style line-drawing mode.

+
+

Returns TRUE if OpenGL-style lines are enabled, and if Direct3D-style lines are enabled.

+ + bb174023 + BOOL ID3DXLine::GetGLLines() + ID3DXLine::GetGLLines +
+ + +

Restores the device state to how it was when was called.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

cannot be used as a substitute for either or .

+
+ + bb174020 + HRESULT ID3DXLine::End() + ID3DXLine::End +
+ + +

Use this method to release all references to video memory resources and delete all stateblocks. This method should be called whenever a device is lost, or before resetting a device.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method should be called whenever the device is lost or before the user calls . Even if the device was not actually lost, is responsible for freeing stateblocks and other resources that may need to be released before resetting the device. As a result, the font object cannot be used again before calling and then .

+
+ + bb174027 + HRESULT ID3DXLine::OnLostDevice() + ID3DXLine::OnLostDevice +
+ + +

Use this method to re-acquire resources and save initial state.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

should be called each time the device is reset (using ), before any other methods are called. This is a good place to re-acquire video-memory resources and capture state blocks.

+
+ + bb174028 + HRESULT ID3DXLine::OnResetDevice() + ID3DXLine::OnResetDevice +
+ + + Instantiates a left-handed coordinate system to create a . + + Pointer to an interface, representing the device associated with the created box mesh. + + This function creates a mesh with the creation option and | Flexible Vertex Format (FVF). + + HRESULT D3DXCreateLine([In] IDirect3DDevice9* pDevice,[Out, Fast] ID3DXLine** ppLine) + + + + Draws a line strip in screen space. Input is in the form of an array that defines points (of ) on the line strip. + + No documentation. + No documentation. + HRESULT ID3DXLine::Draw([In] const void* pVertexList,[In] unsigned int dwVertexListCount,[In] D3DCOLOR Color) + + + + Draws a line strip in screen space. Input is in the form of an array that defines points (of ) on the line strip. + + No documentation. + No documentation. + HRESULT ID3DXLine::Draw([In] const void* pVertexList,[In] unsigned int dwVertexListCount,[In] D3DCOLOR Color) + + + + Draws a line strip in screen space with a specified input transformation matrix. + + Array of vertices that make up the line. See . + A scale, rotate, and translate (SRT) matrix for transforming the points. See . If this matrix is a projection matrix, any stippled lines will be drawn with a perspective-correct stippling pattern. Or, you can transform the vertices and use to draw the line with a nonperspective-correct stipple pattern. + Color of the line. See . + If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA. + HRESULT ID3DXLine::DrawTransform([In] const void* pVertexList,[In] unsigned int dwVertexListCount,[In] const D3DXMATRIX* pTransform,[In] D3DCOLOR Color) + + + + Draws a line strip in screen space with a specified input transformation matrix. + + Array of vertices that make up the line. See . + A scale, rotate, and translate (SRT) matrix for transforming the points. See . If this matrix is a projection matrix, any stippled lines will be drawn with a perspective-correct stippling pattern. Or, you can transform the vertices and use to draw the line with a nonperspective-correct stipple pattern. + Color of the line. See . + If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA. + HRESULT ID3DXLine::DrawTransform([In] const void* pVertexList,[In] unsigned int dwVertexListCount,[In] const D3DXMATRIX* pTransform,[In] D3DCOLOR Color) + + + +

Retrieves the Direct3D device associated with the line object.

+
+ + bb174022 + GetDevice + GetDevice + HRESULT ID3DXLine::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Gets or sets the line stipple pattern.

+
+ + bb174024 + GetPattern / SetPattern + GetPattern + unsigned int ID3DXLine::GetPattern() +
+ + +

Gets or sets the stipple-pattern scale value.

+
+ + bb174025 + GetPatternScale / SetPatternScale + GetPatternScale + float ID3DXLine::GetPatternScale() +
+ + +

Gets or sets the thickness of the line.

+
+ + bb174026 + GetWidth / SetWidth + GetWidth + float ID3DXLine::GetWidth() +
+ + +

Gets or sets the line antialiasing state.

+
+ + bb174021 + GetAntialias / SetAntialias + GetAntialias + BOOL ID3DXLine::GetAntialias() +
+ + +

Gets or sets the OpenGL-style line-drawing mode.

+
+ + bb174023 + GetGLLines / SetGLLines + GetGLLines + BOOL ID3DXLine::GetGLLines() +
+ + +

Applications use the methods of the interface to manipulate mesh objects.

+
+ +

To obtain the interface, call either the or function.

This interface inherits additional functionality from the interface.

The LPD3DXMESH type is defined as a reference to the interface.

 typedef struct  *LPD3DXMESH;	
+            
+
+ + bb174069 + ID3DXMesh + ID3DXMesh +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Locks the mesh buffer that contains the mesh attribute data, and returns a reference to it.

+
+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

Address of a reference to a buffer containing a DWORD for each face in the mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If has been called, the mesh will also have an attribute table that can be accessed using the method.

+
+ + bb174070 + HRESULT ID3DXMesh::LockAttributeBuffer([In] unsigned int Flags,[In] unsigned int** ppData) + ID3DXMesh::LockAttributeBuffer +
+ + +

Unlocks an attribute buffer.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174074 + HRESULT ID3DXMesh::UnlockAttributeBuffer() + ID3DXMesh::UnlockAttributeBuffer +
+ + +

Generates a new mesh with reordered faces and vertices to optimize drawing performance.

+
+

Specifies the type of optimization to perform. This parameter can be set to a combination of one or more flags from D3DXMESHOPT and D3DXMESH (except , , and ).

+

Pointer to an array of three DWORDs per face that specifies the three neighbors for each face in the source mesh. If the edge has no adjacent faces, the value is 0xffffffff. See Remarks.

+

Pointer to an array of three DWORDs per face that specifies the three neighbors for each face in the optimized mesh. If the edge has no adjacent faces, the value is 0xffffffff.

+

An array of DWORDs, one per face, that identifies the original mesh face that corresponds to each face in the optimized mesh. If the value supplied for this argument is null, face remap data is not returned.

+

Address of a reference to an interface, which contains a DWORD for each vertex that specifies how the new vertices map to the old vertices. This remap is useful if you need to alter external data based on the new vertex mapping.

+

Address of a reference to an interface, representing the optimized mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This method generates a new mesh. Before running Optimize, an application must generate an adjacency buffer by calling . The adjacency buffer contains adjacency data, such as a list of edges and the faces that are adjacent to each other.

This method is very similar to the method, except that it can perform optimization while generating the new clone of the mesh. The output mesh inherits all of the creation parameters of the input mesh.

+
+ + bb174071 + HRESULT ID3DXMesh::Optimize([In] unsigned int Flags,[In] const unsigned int* pAdjacencyIn,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pFaceRemap,[In] ID3DXBuffer** ppVertexRemap,[In] ID3DXMesh** ppOptMesh) + ID3DXMesh::Optimize +
+ + +

Generates a mesh with reordered faces and vertices to optimize drawing performance. This method reorders the existing mesh.

+
+

Combination of one or more D3DXMESHOPT flags, specifying the type of optimization to perform.

+

Pointer to an array of three DWORDs per face that specifies the three neighbors for each face in the source mesh. If the edge has no adjacent faces, the value is 0xffffffff.

+

Pointer to an array of three DWORDs per face that specifies the three neighbors for each face in the optimized mesh. If the edge has no adjacent faces, the value is 0xffffffff. If the value supplied for this argument is null, adjacency data is not returned.

+

An array of DWORDs, one per face, that identifies the original mesh face that corresponds to each face in the optimized mesh. If the value supplied for this argument is null, face remap data is not returned.

+

Address of a reference to an interface, which contains a DWORD for each vertex that specifies how the new vertices map to the old vertices. This remap is useful if you need to alter external data based on the new vertex mapping. If the value supplied for this argument is null, vertex remap data is not returned.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_CANNOTATTRSORT, E_OUTOFMEMORY.

+ +

Before running , an application must generate an adjacency buffer by calling . The adjacency buffer contains adjacency data, such as a list of edges and the faces that are adjacent to each other.

Note??This method will fail if the mesh is sharing its vertex buffer with another mesh, unless the is set in Flags.

+
+ + bb174072 + HRESULT ID3DXMesh::OptimizeInplace([In] unsigned int Flags,[In] const unsigned int* pAdjacencyIn,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pFaceRemap,[In] ID3DXBuffer** ppVertexRemap) + ID3DXMesh::OptimizeInplace +
+ + +

Sets the attribute table for a mesh and the number of entries stored in the table.

+
+

Pointer to an array of structures, representing the entries in the mesh attribute table.

+

Number of attributes in the mesh attribute table.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

If an application keeps track of the information in an attribute table, and rearranges the table as a result of changes to attributes or faces, this method allows the application to update the attribute tables instead of calling again.

+
+ + bb174073 + HRESULT ID3DXMesh::SetAttributeTable([In] const D3DXATTRIBUTERANGE* pAttribTable,[In] unsigned int cAttribTableSize) + ID3DXMesh::SetAttributeTable +
+ + +

This interface encapsulates patch mesh functionality.

+
+ +

A patch mesh is a mesh that consists of a series of patches.

To obtain the interface, call the function.

The LPD3DXPATCHMESH type is defined as a reference to the interface, as follows:

 typedef struct  *LPD3DXPATCHMESH;	
+            
+
+ + bb174075 + ID3DXPatchMesh + ID3DXPatchMesh +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the number of patches in the mesh.

+
+

The number of patches.

+ + bb174083 + unsigned int ID3DXPatchMesh::GetNumPatches() + ID3DXPatchMesh::GetNumPatches +
+ + +

Gets the number of vertices in the mesh.

+
+

The number of vertices.

+ + bb174084 + unsigned int ID3DXPatchMesh::GetNumVertices() + ID3DXPatchMesh::GetNumVertices +
+ + +

Gets the vertex declaration.

+
+

Array of elements describing the vertex format of the mesh vertices. The dimension of this declarator array is . The vertex element array ends with the D3DDECL_END macro.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The array of elements includes the D3DDECL_END macro, which ends the declaration.

+
+ + bb174079 + HRESULT ID3DXPatchMesh::GetDeclaration([In] D3DVERTEXELEMENT9* Declaration) + ID3DXPatchMesh::GetDeclaration +
+ + +

Gets the number of control vertices per patch.

+
+

The number of control vertices per patch.

+ + bb174078 + unsigned int ID3DXPatchMesh::GetControlVerticesPerPatch() + ID3DXPatchMesh::GetControlVerticesPerPatch +
+ + +

Gets the type of patch.

+
+

The patch type.

+ +

For more information about patch types, see .

+
+ + bb174085 + unsigned int ID3DXPatchMesh::GetOptions() + ID3DXPatchMesh::GetOptions +
+ + +

Gets the device that created the mesh.

+
+

Pointer to the device.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb174080 + HRESULT ID3DXPatchMesh::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXPatchMesh::GetDevice +
+ + +

Gets the attributes of the patch.

+
+

Pointer to the structures containing the patch attributes. For more information about patch attributes, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ + bb174086 + HRESULT ID3DXPatchMesh::GetPatchInfo([In] D3DXPATCHINFO* PatchInfo) + ID3DXPatchMesh::GetPatchInfo +
+ + +

Gets the mesh vertex buffer.

+
+

Pointer to the vertex buffer.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This method assumes uniform tessellation.

+
+ + bb174088 + HRESULT ID3DXPatchMesh::GetVertexBuffer([Out] IDirect3DVertexBuffer9** ppVB) + ID3DXPatchMesh::GetVertexBuffer +
+ + +

Gets the mesh index buffer.

+
+

Pointer to the index buffer.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The index buffer contains the vertex ordering in the vertex buffer. The index buffer is used to access the vertex buffer when the mesh is rendered.

+
+ + bb174082 + HRESULT ID3DXPatchMesh::GetIndexBuffer([Out] IDirect3DIndexBuffer9** ppIB) + ID3DXPatchMesh::GetIndexBuffer +
+ + +

Lock the vertex buffer.

+
+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

VOID* reference to a memory buffer containing the returned vertex data.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The vertex buffer is usually locked, written to, and then unlocked for reading.

Patch meshes use 16-bit index buffers.

+
+ + bb174091 + HRESULT ID3DXPatchMesh::LockVertexBuffer([In] unsigned int flags,[In] void** ppData) + ID3DXPatchMesh::LockVertexBuffer +
+ + +

Unlock the vertex buffer.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The vertex buffer is usually locked, written to, and then unlocked for reading.

+
+ + bb174098 + HRESULT ID3DXPatchMesh::UnlockVertexBuffer() + ID3DXPatchMesh::UnlockVertexBuffer +
+ + +

Lock the index buffer.

+
+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

VOID* reference to a memory buffer containing the returned index data.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The index buffer is usually locked, written to, and then unlocked for reading. Patch mesh index buffers are 16-bit buffers.

+
+ + bb174090 + HRESULT ID3DXPatchMesh::LockIndexBuffer([In] unsigned int flags,[In] void** ppData) + ID3DXPatchMesh::LockIndexBuffer +
+ + +

Unlock the index buffer.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The index buffer is usually locked, written to, and then unlocked for reading.

+
+ + bb174097 + HRESULT ID3DXPatchMesh::UnlockIndexBuffer() + ID3DXPatchMesh::UnlockIndexBuffer +
+ + +

Locks the attribute buffer.

+
+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

Address of a reference to a buffer containing a DWORD for each face in the mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The attribute buffer is usually locked, written to, and then unlocked for reading.

+
+ + bb174089 + HRESULT ID3DXPatchMesh::LockAttributeBuffer([In] unsigned int flags,[In] unsigned int** ppData) + ID3DXPatchMesh::LockAttributeBuffer +
+ + +

Unlock the attribute buffer.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

The attribute buffer is usually locked, written to, and then unlocked for reading.

+
+ + bb174096 + HRESULT ID3DXPatchMesh::UnlockAttributeBuffer() + ID3DXPatchMesh::UnlockAttributeBuffer +
+ + +

Gets the size of the tessellated mesh, given a tessellation level.

+
+

Tessellation level.

+

Adaptive tessellation. For adaptive tessellation, set this value to TRUE and set fTessLevel to the maximum tessellation value. This will result in the maximum mesh size necessary for adaptive tessellation.

+

Pointer to the number of triangles generated by the tessellated mesh.

+

Pointer to the number of vertices generated by the tessellated mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This method assumes uniform tessellation.

+
+ + bb174087 + HRESULT ID3DXPatchMesh::GetTessSize([In] float fTessLevel,[In] unsigned int Adaptive,[Out] unsigned int* NumTriangles,[Out] unsigned int* NumVertices) + ID3DXPatchMesh::GetTessSize +
+ + +

Generate a list of mesh edges and the patches that share each edge.

+
+

Specifies that vertices that differ in position by less than the tolerance should be treated as coincident.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

After an application generates adjacency information for a mesh, the mesh data can be optimized for better drawing performance. This method determines which patches are adjacent (within the provided tolerance). This information is used internally to optimize tessellation.

+
+ + bb174077 + HRESULT ID3DXPatchMesh::GenerateAdjacency([In] float Tolerance) + ID3DXPatchMesh::GenerateAdjacency +
+ + +

Creates a new patch mesh with the specified vertex declaration.

+
+

Combination of one or more D3DXMESH flags that specify creation options for the mesh.

+

Array of elements that specify the vertex format for the vertices in the output mesh.

+

Address of a reference to an interface that represents the cloned mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

CloneMesh converts the vertex buffer to the new vertex declaration. Entries in the vertex declaration that are new to the original mesh are set to 0. If the current mesh has adjacency, the new mesh will also have adjacency.

+
+ + bb174076 + HRESULT ID3DXPatchMesh::CloneMesh([In] unsigned int Options,[In] const D3DVERTEXELEMENT9* pDecl,[In] ID3DXPatchMesh** pMesh) + ID3DXPatchMesh::CloneMesh +
+ + +

Optimizes the patch mesh for efficient tessellation.

+
+

Currently unused.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_CANNOTATTRSORT.

+ +

After an application generates adjacency information for a mesh, the mesh data can be optimized (reordered) for better drawing performance. This method determines which patches are adjacent (within the provided tolerance).

Adjacency information is also used to optimize tessellation. Generate adjacency information once and tessellate repeatedly by calling . The optimization performed is independent of the actual tessellation level used. However, if the mesh vertices are changed, you must regenerate the adjacency information.

+
+ + bb174092 + HRESULT ID3DXPatchMesh::Optimize([In] unsigned int flags) + ID3DXPatchMesh::Optimize +
+ + +

Sets mesh geometry displacement parameters.

+
+

Texture containing the displacement data.

+

Minification level. For more information, see .

+

Magnification level. For more information, see .

+

Mip filter level. For more information, see .

+

Texture address wrap mode. For more information, see

+

Level of detail bias value.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Displacement maps can only be 2D textures. Mipmapping is ignored for nonadaptive tessellation.

+
+ + bb174093 + HRESULT ID3DXPatchMesh::SetDisplaceParam([In] IDirect3DBaseTexture9* Texture,[In] D3DTEXTUREFILTERTYPE MinFilter,[In] D3DTEXTUREFILTERTYPE MagFilter,[In] D3DTEXTUREFILTERTYPE MipFilter,[In] D3DTEXTUREADDRESS Wrap,[In] unsigned int dwLODBias) + ID3DXPatchMesh::SetDisplaceParam +
+ + +

Gets mesh geometry displacement parameters.

+
+

Texture containing the displacement data.

+

Minification level. For more information, see .

+

Magnification level. For more information, see .

+

Mip filter level. For more information, see .

+

Texture address wrap mode. For more information, see .

+

Level of detail bias value.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Displacement maps can only be 2D textures. Mipmapping is ignored for nonadaptive tessellation.

+
+ + bb174081 + HRESULT ID3DXPatchMesh::GetDisplaceParam([Out] IDirect3DBaseTexture9** Texture,[Out] D3DTEXTUREFILTERTYPE* MinFilter,[Out] D3DTEXTUREFILTERTYPE* MagFilter,[Out] D3DTEXTUREFILTERTYPE* MipFilter,[Out] D3DTEXTUREADDRESS* Wrap,[Out] unsigned int* dwLODBias) + ID3DXPatchMesh::GetDisplaceParam +
+ + +

Performs uniform tessellation based on the tessellation level.

+
+

Tessellation level. This is the number of vertices introduced between existing vertices. The range of this float parameter is 0 < fTessLevel <= 32.

+

Resulting tessellated mesh. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This function will perform more efficiently if the patch mesh has been optimized using .

+
+ + bb174094 + HRESULT ID3DXPatchMesh::Tessellate([In] float fTessLevel,[In] ID3DXMesh* pMesh) + ID3DXPatchMesh::Tessellate +
+ + +

Performs adaptive tessellation based on the z-based adaptive tessellation criterion.

+
+

Specifies a 4D vector that is dotted with the vertices to get the per-vertex adaptive tessellation amount. Each edge is tessellated to the average value of the tessellation levels for the two vertices it connects.

+

Maximum limit for adaptive tessellation. This is the number of vertices introduced between existing vertices. This integer value can range from 1 to 32, inclusive.

+

Minimum limit for adaptive tessellation. This is the number of vertices introduced between existing vertices. This integer value can range from 1 to 32, inclusive.

+

Resulting tessellated mesh. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

This function will perform more efficiently if the patch mesh has been optimized using .

+
+ + bb174095 + HRESULT ID3DXPatchMesh::TessellateAdaptive([In] const D3DXVECTOR4* pTrans,[In] unsigned int dwMaxTessLevel,[In] unsigned int dwMinTessLevel,[In] ID3DXMesh* pMesh) + ID3DXPatchMesh::TessellateAdaptive +
+ + +

Gets the number of patches in the mesh.

+
+ + bb174083 + GetNumPatches + GetNumPatches + unsigned int ID3DXPatchMesh::GetNumPatches() +
+ + +

Gets the number of vertices in the mesh.

+
+ + bb174084 + GetNumVertices + GetNumVertices + unsigned int ID3DXPatchMesh::GetNumVertices() +
+ + +

Gets the number of control vertices per patch.

+
+ + bb174078 + GetControlVerticesPerPatch + GetControlVerticesPerPatch + unsigned int ID3DXPatchMesh::GetControlVerticesPerPatch() +
+ + +

Gets the type of patch.

+
+ +

For more information about patch types, see .

+
+ + bb174085 + GetOptions + GetOptions + unsigned int ID3DXPatchMesh::GetOptions() +
+ + +

Gets the device that created the mesh.

+
+ + bb174080 + GetDevice + GetDevice + HRESULT ID3DXPatchMesh::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Gets the mesh vertex buffer.

+
+ +

This method assumes uniform tessellation.

+
+ + bb174088 + GetVertexBuffer + GetVertexBuffer + HRESULT ID3DXPatchMesh::GetVertexBuffer([Out] IDirect3DVertexBuffer9** ppVB) +
+ + +

Gets the mesh index buffer.

+
+ +

The index buffer contains the vertex ordering in the vertex buffer. The index buffer is used to access the vertex buffer when the mesh is rendered.

+
+ + bb174082 + GetIndexBuffer + GetIndexBuffer + HRESULT ID3DXPatchMesh::GetIndexBuffer([Out] IDirect3DIndexBuffer9** ppIB) +
+ + +

Applications use the methods of the interface to encapsulate the functionality of a pixel shader.

+
+ +

The LPDIRECT3DPIXELSHADER9 and PDIRECT3DPIXELSHADER9 types are defined as references to the interface.

typedef struct  *LPDIRECT3DPIXELSHADER9, *PDIRECT3DPIXELSHADER9;
+
+ + bb205869 + IDirect3DPixelShader9 + IDirect3DPixelShader9 +
+ + Constant MaxDynamicFlowControlDepth. + D3DPS20_MAX_DYNAMICFLOWCONTROLDEPTH + + + Constant MinDynamicFlowControlDepth. + D3DPS20_MIN_DYNAMICFLOWCONTROLDEPTH + + + Constant MaxTemps. + D3DPS20_MAX_NUMTEMPS + + + Constant MinTemps. + D3DPS20_MIN_NUMTEMPS + + + Constant MaxStaticFlowControlDepth. + D3DPS20_MAX_STATICFLOWCONTROLDEPTH + + + Constant MinStaticFlowControlDepth. + D3DPS20_MIN_STATICFLOWCONTROLDEPTH + + + Constant MaxInstructionSlots. + D3DPS20_MAX_NUMINSTRUCTIONSLOTS + + + Constant MinInstructionSlots. + D3DPS20_MIN_NUMINSTRUCTIONSLOTS + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the device.

+
+

Pointer to the interface that is returned.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205870 + HRESULT IDirect3DPixelShader9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DPixelShader9::GetDevice +
+ + +

Gets a reference to the shader data.

+
+

Pointer to a buffer that contains the shader data. The application needs to allocate enough room for this.

+

Size of the data, in bytes. To get the buffer size that is needed to retrieve the data, set pData = null when calling GetFunction. Then call GetFunction with the returned size, to get the buffer data.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ + bb205871 + HRESULT IDirect3DPixelShader9::GetFunction([In] void* arg0,[InOut] unsigned int* pSizeOfData) + IDirect3DPixelShader9::GetFunction +
+ + + Initializes a new instance of the class. + + The device. + The function. + HRESULT IDirect3DDevice9::CreatePixelShader([In] const void* pFunction,[Out, Fast] IDirect3DPixelShader9** ppShader) + + + +

Gets the device.

+
+ + bb205870 + GetDevice + GetDevice + HRESULT IDirect3DPixelShader9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + + Gets the bytecode associated to this shader.. + + + + + No documentation. + + + bb281283 + ID3DXPMesh + ID3DXPMesh + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXPMesh::ClonePMeshFVF([In] unsigned int Options,[In] unsigned int FVF,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXPMesh** ppCloneMesh) + ID3DXPMesh::ClonePMeshFVF + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXPMesh::ClonePMesh([In] unsigned int Options,[In] const D3DVERTEXELEMENT9* pDeclaration,[In] IDirect3DDevice9* pD3DDevice,[In] ID3DXPMesh** ppCloneMesh) + ID3DXPMesh::ClonePMesh + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXPMesh::SetNumFaces([In] unsigned int Faces) + ID3DXPMesh::SetNumFaces + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXPMesh::SetNumVertices([In] unsigned int Vertices) + ID3DXPMesh::SetNumVertices + + + + No documentation. + + No documentation. + + unsigned int ID3DXPMesh::GetMaxFaces() + ID3DXPMesh::GetMaxFaces + + + + No documentation. + + No documentation. + + unsigned int ID3DXPMesh::GetMinFaces() + ID3DXPMesh::GetMinFaces + + + + No documentation. + + No documentation. + + unsigned int ID3DXPMesh::GetMaxVertices() + ID3DXPMesh::GetMaxVertices + + + + No documentation. + + No documentation. + + unsigned int ID3DXPMesh::GetMinVertices() + ID3DXPMesh::GetMinVertices + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXPMesh::Save([In] IStream* pStream,[In] const D3DXMATERIAL* pMaterials,[In] const D3DXEFFECTINSTANCE* pEffectInstances,[In] unsigned int NumMaterials) + ID3DXPMesh::Save + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXPMesh::Optimize([In] unsigned int Flags,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pFaceRemap,[In] ID3DXBuffer** ppVertexRemap,[In] ID3DXMesh** ppOptMesh) + ID3DXPMesh::Optimize + + + + No documentation. + + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXPMesh::OptimizeBaseLOD([In] unsigned int Flags,[In] unsigned int* pFaceRemap) + ID3DXPMesh::OptimizeBaseLOD + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXPMesh::TrimByFaces([In] unsigned int NewFacesMin,[In] unsigned int NewFacesMax,[In] unsigned int* rgiFaceRemap,[In] unsigned int* rgiVertRemap) + ID3DXPMesh::TrimByFaces + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXPMesh::TrimByVertices([In] unsigned int NewVerticesMin,[In] unsigned int NewVerticesMax,[In] unsigned int* rgiFaceRemap,[In] unsigned int* rgiVertRemap) + ID3DXPMesh::TrimByVertices + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXPMesh::GetAdjacency([Out] unsigned int* pAdjacency) + ID3DXPMesh::GetAdjacency + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXPMesh::GenerateVertexHistory([In] unsigned int* pVertexHistory) + ID3DXPMesh::GenerateVertexHistory + + + + No documentation. + + + GetMaxFaces + GetMaxFaces + unsigned int ID3DXPMesh::GetMaxFaces() + + + + No documentation. + + + GetMinFaces + GetMinFaces + unsigned int ID3DXPMesh::GetMinFaces() + + + + No documentation. + + + GetMaxVertices + GetMaxVertices + unsigned int ID3DXPMesh::GetMaxVertices() + + + + No documentation. + + + GetMinVertices + GetMinVertices + unsigned int ID3DXPMesh::GetMinVertices() + + + + No documentation. + + + GetAdjacency + GetAdjacency + HRESULT ID3DXPMesh::GetAdjacency([Out] unsigned int* pAdjacency) + + + +

Applications use the methods of the interface to perform asynchronous queries on a driver.

+
+ +

The LPDIRECT3DQUERY9 and PDIRECT3DQUERY9 types are defined as references to the interface.

typedef struct  *LPDIRECT3DQUERY9, *PDIRECT3DQUERY9;
+
+ + bb205872 + IDirect3DQuery9 + IDirect3DQuery9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the device that is being queried.

+
+

Pointer to the device being queried. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205875 + HRESULT IDirect3DQuery9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DQuery9::GetDevice +
+ + +

Gets the query type.

+
+

Returns the query type. See .

+ + bb205876 + D3DQUERYTYPE IDirect3DQuery9::GetType() + IDirect3DQuery9::GetType +
+ + +

Gets the number of bytes in the query data.

+
+

Returns the number of bytes of query data.

+ + bb205874 + unsigned int IDirect3DQuery9::GetDataSize() + IDirect3DQuery9::GetDataSize +
+ + +

Issue a query.

+
+

Query flags specify the type of state change for the query. See and .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A signaled query means the query has completed, the data is available, and will return .

+
+ + bb205877 + HRESULT IDirect3DQuery9::Issue([In] D3DISSUE dwIssueFlags) + IDirect3DQuery9::Issue +
+ + +

Polls a queried resource to get the query state or a query result. For more information about queries, see Queries (Direct3D 9).

+
+ No documentation. + No documentation. + No documentation. +

The return type identifies the query state (see Queries (Direct3D 9)). The method returns if the query data is available and S_FALSE if it is not. These are considered successful return values. If the method fails when D3DGETDATA_FLUSH is used, the return value can be .

+ +

It is possible to lose the device while polling for query status. When D3DGETDATA_FLUSH is specified, this method will return in response to a lost device. This allows an application to prevent threads from endlessly polling due to a lost device (which cannot respond to the query).

An application must never write code that only invokes GetData ( ... , 0 ), expecting that GetData will eventually return by itself over time. This is true, even if the application has used the FLUSH flag with GetData in the past. For example:

// Enables an infinite loop:	
+            while( pQuery->GetData( ... , 0 ) == S_FALSE ) ; // Still enables an infinite loop:	
+            pQuery->GetData( ... , D3DGETDATA_FLUSH );	
+            while( pQuery->GetData( ... , 0 ) == S_FALSE ) ; // Does not enable an infinite loop because eventually the command	
+            // buffer will fill up and that will cause a flush to occur.	
+            while( pQuery->GetData( ..., 0 ) == S_FALSE ) { pDevice->SetTexture(...); pDevice->Draw(...);	
+            }	
+            
+
+ + bb205873 + HRESULT IDirect3DQuery9::GetData([In] void* pData,[In] unsigned int dwSize,[In] unsigned int dwGetDataFlags) + IDirect3DQuery9::GetData +
+ + + Initializes a new instance of the class. + + The device. + The type. + + + + +

Gets the device that is being queried.

+
+ + bb205875 + GetDevice + GetDevice + HRESULT IDirect3DQuery9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Gets the number of bytes in the query data.

+
+ + bb205874 + GetDataSize + GetDataSize + unsigned int IDirect3DQuery9::GetDataSize() +
+ + + Gets the type. + + D3DQUERYTYPE IDirect3DQuery9::GetType() + + + +

The interface is used to generalize the process of rendering to environment maps.

+
+ +

An environment map is used to texture-map scene geometry to provide a more sophisticated scene without using complex geometry. This interface supports creating surfaces for the following kinds of geometry: cube, half sphere or hemispheric, parabolic, or sphere.

The interface is obtained by calling the function.

The LPD3DXRenderToEnvMap type is defined as a reference to the interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXRenderToEnvMap;	
+            
+
+ + bb174181 + ID3DXRenderToEnvMap + ID3DXRenderToEnvMap +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the Direct3D device associated with the environment map.

+
+

Address of a reference to an interface that represents the Direct3D device object associated with the environment map.

+

If the method succeeds, the return value is . If the method fails, the return value can be . Calling this method increases the internal reference count on the interface. Be sure to call when you are done using this interface or you will have a memory leak.

+ + bb174189 + HRESULT ID3DXRenderToEnvMap::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXRenderToEnvMap::GetDevice +
+ + +

Retrieves the description of the render surface.

+
+

Pointer to a structure that describes the rendering surface.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174188 + HRESULT ID3DXRenderToEnvMap::GetDesc([Out] D3DXRTE_DESC* pDesc) + ID3DXRenderToEnvMap::GetDesc +
+ + +

Initiate the rendering of a cubic environment map.

+
+

Pointer to an interface that represents the cube texture to which to render.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

See to draw each of the 6 faces.

+
+ + bb174182 + HRESULT ID3DXRenderToEnvMap::BeginCube([In] IDirect3DCubeTexture9* pCubeTex) + ID3DXRenderToEnvMap::BeginCube +
+ + +

Initiate the rendering of a spherical environment map.

+
+

Pointer to an interface that represents the texture to which to render.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: .E_FAIL

+ +

See to draw the face.

+
+ + bb174185 + HRESULT ID3DXRenderToEnvMap::BeginSphere([In] IDirect3DTexture9* pTex) + ID3DXRenderToEnvMap::BeginSphere +
+ + +

Initiate the rendering of a hemispheric environment map.

+
+

Pointer to an interface that represents the positive texture render surface.

+

Pointer to an interface that represents the negative texture render surface.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: .E_FAIL

+ +

See to draw the face.

+
+ + bb174183 + HRESULT ID3DXRenderToEnvMap::BeginHemisphere([In] IDirect3DTexture9* pTexZPos,[In] IDirect3DTexture9* pTexZNeg) + ID3DXRenderToEnvMap::BeginHemisphere +
+ + +

Initiate the rendering of a parabolic environment map.

+
+

Pointer to an interface that represents the positive render texture.

+

Pointer to an interface that represents the negative render texture.

+

If the function succeeds, the return value is . If the function fails, the return value can be one of the following: .E_FAIL

+ +

See to draw the faces.

+
+ + bb174184 + HRESULT ID3DXRenderToEnvMap::BeginParabolic([In] IDirect3DTexture9* pTexZPos,[In] IDirect3DTexture9* pTexZNeg) + ID3DXRenderToEnvMap::BeginParabolic +
+ + +

Initiate the drawing of each face of an environment map.

+
+

The first face of the environmental cube map. See .

+

A valid combination of one or more flags.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method must be called once for each type of environment map. The only exception is a cubic environment map which requires this method to be called six times, once for each face in . For more information, see Environment Mapping (Direct3D 9).

+
+ + bb174187 + HRESULT ID3DXRenderToEnvMap::Face([In] D3DCUBEMAP_FACES Face,[In] unsigned int MipFilter) + ID3DXRenderToEnvMap::Face +
+ + +

Restore all render targets and, if needed, compose all the rendered faces into the environment map surface.

+
+

A valid combination of one or more flags.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174186 + HRESULT ID3DXRenderToEnvMap::End([In] unsigned int MipFilter) + ID3DXRenderToEnvMap::End +
+ + +

Use this method to release all references to video memory resources and delete all stateblocks. This method should be called whenever a device is lost, or before resetting a device.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method should be called whenever the device is lost or before the user calls . Even if the device was not actually lost, is responsible for freeing stateblocks and other resources that may need to be released before resetting the device. As a result, the font object cannot be used again before calling and then .

+
+ + bb174190 + HRESULT ID3DXRenderToEnvMap::OnLostDevice() + ID3DXRenderToEnvMap::OnLostDevice +
+ + +

Use this method to re-acquire resources and save initial state.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

should be called each time the device is reset (using ), before any other methods are called. This is a good place to re-acquire video-memory resources and capture state blocks.

+
+ + bb174191 + HRESULT ID3DXRenderToEnvMap::OnResetDevice() + ID3DXRenderToEnvMap::OnResetDevice +
+ + +

Retrieves the Direct3D device associated with the environment map.

+
+ + bb174189 + GetDevice + GetDevice + HRESULT ID3DXRenderToEnvMap::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Retrieves the description of the render surface.

+
+ + bb174188 + GetDesc + GetDesc + HRESULT ID3DXRenderToEnvMap::GetDesc([Out] D3DXRTE_DESC* pDesc) +
+ + +

The interface is used to generalize the process of rendering to surfaces.

+
+ +

Surfaces can be used in a variety of ways including render targets, off-screen rendering, or rendering to textures.

A surface can be configured using a separate viewport using the method, to provide a custom render view. If the surface is not a render target, a compatible render target is used, and the result is copied to the surface at the end of the scene.

The interface is obtained by calling the function.

The LPD3DXRENDERTOSURFACE type is defined as a reference to the interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXRENDERTOSURFACE;	
+            
+
+ + bb174192 + ID3DXRenderToSurface + ID3DXRenderToSurface +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the Direct3D device associated with the render surface.

+
+

Address of a reference to an interface, representing the Direct3D device object associated with the render surface.

+

If the method succeeds, the return value is . If the method fails, the return value can be . Calling this method will increase the internal reference count on the interface. Be sure to call when you are done using this interface or you will have a memory leak.

+ + bb174196 + HRESULT ID3DXRenderToSurface::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXRenderToSurface::GetDevice +
+ + +

Retrieves the parameters of the render surface.

+
+

Pointer to a structure, describing the parameters of the render surface.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174195 + HRESULT ID3DXRenderToSurface::GetDesc([Out] D3DXRTS_DESC* pDesc) + ID3DXRenderToSurface::GetDesc +
+ + +

Begins a scene.

+
+

Pointer to an interface, representing the render surface.

+

Pointer to a structure, describing the viewport for the scene.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: . D3DXERR_INVALIDDATA E_OUTOFMEMORY

+ + bb174193 + HRESULT ID3DXRenderToSurface::BeginScene([In] IDirect3DSurface9* pSurface,[In] const D3DVIEWPORT9* pViewport) + ID3DXRenderToSurface::BeginScene +
+ + +

Ends a scene.

+
+

Filter options, enumerated in .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174194 + HRESULT ID3DXRenderToSurface::EndScene([In] D3DX_FILTER MipFilter) + ID3DXRenderToSurface::EndScene +
+ + +

Use this method to release all references to video memory resources and delete all stateblocks. This method should be called whenever a device is lost or before resetting a device.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method should be called whenever the device is lost or before the user calls . Even if the device was not actually lost, is responsible for freeing stateblocks and other resources that may need to be released before resetting the device. As a result, the font object cannot be used again before calling and then .

+
+ + bb174197 + HRESULT ID3DXRenderToSurface::OnLostDevice() + ID3DXRenderToSurface::OnLostDevice +
+ + +

Use this method to re-acquire resources and save initial state.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

should be called each time the device is reset (using ), before any other methods are called. This is a good place to re-acquire video-memory resources and capture state blocks.

+
+ + bb174198 + HRESULT ID3DXRenderToSurface::OnResetDevice() + ID3DXRenderToSurface::OnResetDevice +
+ + + Creates a render surface. + +

Pointer to an interface, the device to be associated with the render surface.

+

Width of the render surface, in pixels.

+

Height of the render surface, in pixels.

+

Member of the enumerated type, describing the pixel format of the render surface.

+

If TRUE, the render surface supports a depth-stencil surface. Otherwise, this member is set to . This function will create a new depth buffer.

+

If DepthStencil is set to TRUE, this parameter is a member of the enumerated type, describing the depth-stencil format of the render surface.

+ bb172791 + HRESULT D3DXCreateRenderToSurface([In] IDirect3DDevice9* pDevice,[In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] BOOL DepthStencil,[In] D3DFORMAT DepthStencilFormat,[In] ID3DXRenderToSurface** ppRenderToSurface) + D3DXCreateRenderToSurface +
+ + +

Retrieves the Direct3D device associated with the render surface.

+
+ + bb174196 + GetDevice + GetDevice + HRESULT ID3DXRenderToSurface::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Retrieves the parameters of the render surface.

+
+ + bb174195 + GetDesc + GetDesc + HRESULT ID3DXRenderToSurface::GetDesc([Out] D3DXRTS_DESC* pDesc) +
+ + + No documentation. + + + bb280438 + ID3DXSPMesh + ID3DXSPMesh + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + + No documentation. + + No documentation. + + unsigned int ID3DXSPMesh::GetNumFaces() + ID3DXSPMesh::GetNumFaces + + + + No documentation. + + No documentation. + + unsigned int ID3DXSPMesh::GetNumVertices() + ID3DXSPMesh::GetNumVertices + + + + No documentation. + + No documentation. + + unsigned int ID3DXSPMesh::GetFVF() + ID3DXSPMesh::GetFVF + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::GetDeclaration([In] D3DVERTEXELEMENT9* Declaration) + ID3DXSPMesh::GetDeclaration + + + + No documentation. + + No documentation. + + unsigned int ID3DXSPMesh::GetOptions() + ID3DXSPMesh::GetOptions + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXSPMesh::GetDevice + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::CloneMeshFVF([In] unsigned int Options,[In] unsigned int FVF,[In] IDirect3DDevice9* pD3DDevice,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pVertexRemapOut,[In] ID3DXMesh** ppCloneMesh) + ID3DXSPMesh::CloneMeshFVF + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::CloneMesh([In] unsigned int Options,[In] const D3DVERTEXELEMENT9* pDeclaration,[In] IDirect3DDevice9* pD3DDevice,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pVertexRemapOut,[In] ID3DXMesh** ppCloneMesh) + ID3DXSPMesh::CloneMesh + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::ClonePMeshFVF([In] unsigned int Options,[In] unsigned int FVF,[In] IDirect3DDevice9* pD3DDevice,[In] unsigned int* pVertexRemapOut,[In] float* pErrorsByFace,[In] ID3DXPMesh** ppCloneMesh) + ID3DXSPMesh::ClonePMeshFVF + + + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::ClonePMesh([In] unsigned int Options,[In] const D3DVERTEXELEMENT9* pDeclaration,[In] IDirect3DDevice9* pD3DDevice,[In] unsigned int* pVertexRemapOut,[In] float* pErrorsbyFace,[In] ID3DXPMesh** ppCloneMesh) + ID3DXSPMesh::ClonePMesh + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::ReduceFaces([In] unsigned int Faces) + ID3DXSPMesh::ReduceFaces + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::ReduceVertices([In] unsigned int Vertices) + ID3DXSPMesh::ReduceVertices + + + + No documentation. + + No documentation. + + unsigned int ID3DXSPMesh::GetMaxFaces() + ID3DXSPMesh::GetMaxFaces + + + + No documentation. + + No documentation. + + unsigned int ID3DXSPMesh::GetMaxVertices() + ID3DXSPMesh::GetMaxVertices + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::GetVertexAttributeWeights([In] D3DXATTRIBUTEWEIGHTS* pVertexAttributeWeights) + ID3DXSPMesh::GetVertexAttributeWeights + + + + No documentation. + + No documentation. + No documentation. + + HRESULT ID3DXSPMesh::GetVertexWeights([Out] float* pVertexWeights) + ID3DXSPMesh::GetVertexWeights + + + + No documentation. + + + GetNumFaces + GetNumFaces + unsigned int ID3DXSPMesh::GetNumFaces() + + + + No documentation. + + + GetNumVertices + GetNumVertices + unsigned int ID3DXSPMesh::GetNumVertices() + + + + No documentation. + + + GetFVF + GetFVF + unsigned int ID3DXSPMesh::GetFVF() + + + + No documentation. + + + GetOptions + GetOptions + unsigned int ID3DXSPMesh::GetOptions() + + + + No documentation. + + + GetDevice + GetDevice + HRESULT ID3DXSPMesh::GetDevice([Out] IDirect3DDevice9** ppDevice) + + + + No documentation. + + + GetMaxFaces + GetMaxFaces + unsigned int ID3DXSPMesh::GetMaxFaces() + + + + No documentation. + + + GetMaxVertices + GetMaxVertices + unsigned int ID3DXSPMesh::GetMaxVertices() + + + + No documentation. + + + GetVertexWeights + GetVertexWeights + HRESULT ID3DXSPMesh::GetVertexWeights([Out] float* pVertexWeights) + + + +

Applications use the methods of the interface to manipulate bone matrices, which are used to skin vertex data for animation. This interface is no longer strictly tied to and can be used to skin any set of vertex data.

+
+ +

Create a interface with , , or .

The LPD3DXSKININFO type is defined as a reference to the interface.

 typedef struct  *LPD3DXSKININFO;	
+            
+
+ + bb174206 + ID3DXSkinInfo + ID3DXSkinInfo +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Sets the influence value for a bone.

+
+

Bone number.

+

Number of influences.

+

The array of vertices influenced by a bone.

+

The array of weights influenced by a bone.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174224 + HRESULT ID3DXSkinInfo::SetBoneInfluence([In] unsigned int bone,[In] unsigned int numInfluences,[In] const unsigned int* vertices,[In] const float* weights) + ID3DXSkinInfo::SetBoneInfluence +
+ + +

Sets an influence value of a bone on a single vertex.

+
+

Index of the bone. Must be between 0 and the number of bones.

+

Index of the influence array of the specified bone.

+

Blend factor of the specified bone influence.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174227 + HRESULT ID3DXSkinInfo::SetBoneVertexInfluence([In] unsigned int boneNum,[In] unsigned int influenceNum,[In] float weight) + ID3DXSkinInfo::SetBoneVertexInfluence +
+ + +

Gets the number of influences for a bone.

+
+

Bone number.

+

Returns the number of influences for a bone.

+ + bb174220 + unsigned int ID3DXSkinInfo::GetNumBoneInfluences([In] unsigned int bone) + ID3DXSkinInfo::GetNumBoneInfluences +
+ + +

Gets the vertices and weights that a bone influences.

+
+

Bone number.

+

Get the array of vertices influenced by a bone.

+

Get the array of weights influenced by a bone.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Use to find out how many vertices the bone influences.

+
+ + bb174211 + HRESULT ID3DXSkinInfo::GetBoneInfluence([In] unsigned int bone,[Out] unsigned int* vertices,[Out] float* weights) + ID3DXSkinInfo::GetBoneInfluence +
+ + +

Retrieves the blend factor and vertex affected by a specified bone influence.

+
+

Index of the bone. Must be between 0 and the number of bones.

+

Index of the influence array of the specified bone.

+

Pointer to the blend factor influenced by influenceNum.

+

Pointer to the vertex influenced by influenceNum.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174214 + HRESULT ID3DXSkinInfo::GetBoneVertexInfluence([In] unsigned int boneNum,[In] unsigned int influenceNum,[Out] float* pWeight,[Out] unsigned int* pVertexNum) + ID3DXSkinInfo::GetBoneVertexInfluence +
+ + +

Gets the maximum number of influences for any vertex in the mesh.

+
+

Pointer to the maximum vertex influence.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174218 + HRESULT ID3DXSkinInfo::GetMaxVertexInfluences([Out] unsigned int* maxVertexInfluences) + ID3DXSkinInfo::GetMaxVertexInfluences +
+ + +

Gets the number of bones.

+
+

Returns the number of bones.

+ + bb174221 + unsigned int ID3DXSkinInfo::GetNumBones() + ID3DXSkinInfo::GetNumBones +
+ + +

Retrieves the index of the bone influence affecting a single vertex.

+
+

Index of the bone. Must be between 0 and the number of bones.

+

Index of the vertex for which the bone influence is to be found. Must be between 0 and the number of vertices in the mesh.

+

Pointer to the index of the bone influence that affects vertexNum.

+

If the method succeeds, the return value is . If the specified bone does not influence the given vertex, S_FALSE is returned. If the method fails, the return value can be .

+ + bb174210 + HRESULT ID3DXSkinInfo::FindBoneVertexInfluenceIndex([In] unsigned int boneNum,[In] unsigned int vertexNum,[In] unsigned int* pInfluenceIndex) + ID3DXSkinInfo::FindBoneVertexInfluenceIndex +
+ + +

Gets the maximum face influences in a triangle mesh with the specified index buffer.

+
+

Pointer to the index buffer that contains the mesh index data.

+

Number of faces in the mesh.

+

Pointer to the maximum face influences.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174217 + HRESULT ID3DXSkinInfo::GetMaxFaceInfluences([In] IDirect3DIndexBuffer9* pIB,[In] unsigned int NumFaces,[Out] unsigned int* maxFaceInfluences) + ID3DXSkinInfo::GetMaxFaceInfluences +
+ + +

Sets the minimum bone influence. Influence values smaller than this are ignored.

+
+

Minimum influence value. Influence values smaller than this are ignored.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174230 + HRESULT ID3DXSkinInfo::SetMinBoneInfluence([In] float MinInfl) + ID3DXSkinInfo::SetMinBoneInfluence +
+ + +

Gets the minimum bone influence. Influence values smaller than this are ignored.

+
+

Returns the minimum bone influence value.

+ + bb174219 + float ID3DXSkinInfo::GetMinBoneInfluence() + ID3DXSkinInfo::GetMinBoneInfluence +
+ + +

Sets the bone name.

+
+

Bone number

+

Bone name

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Bone names are returned by .

+
+ + bb174225 + HRESULT ID3DXSkinInfo::SetBoneName([In] unsigned int Bone,[In] const char* pName) + ID3DXSkinInfo::SetBoneName +
+ + +

Gets the bone name, from the bone index.

+
+

Bone number.

+

Returns the bone name. Do not free this string.

+ + bb174212 + const char* ID3DXSkinInfo::GetBoneName([In] unsigned int Bone) + ID3DXSkinInfo::GetBoneName +
+ + +

Sets the bone offset matrix.

+
+

Bone number.

+

Pointer to the bone offset matrix.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Bone names are returned by .

+
+ + bb174226 + HRESULT ID3DXSkinInfo::SetBoneOffsetMatrix([In] unsigned int Bone,[In] const D3DXMATRIX* pBoneTransform) + ID3DXSkinInfo::SetBoneOffsetMatrix +
+ + +

Gets the bone offset matrix.

+
+

Bone number.

+

Returns a reference to the bone offset matrix. Do not free this reference.

+ + bb174213 + D3DXMATRIX* ID3DXSkinInfo::GetBoneOffsetMatrix([In] unsigned int Bone) + ID3DXSkinInfo::GetBoneOffsetMatrix +
+ + +

Clones a skin info object.

+
+

Address of a reference to an object, which will contain the cloned object if the method is successful.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174207 + HRESULT ID3DXSkinInfo::Clone([In] ID3DXSkinInfo** ppSkinInfo) + ID3DXSkinInfo::Clone +
+ + +

Updates bone influence information to match vertices after they are reordered. This method should be called if the target vertex buffer has been reordered externally.

+
+

Number of vertices to remap.

+

Array of DWORDS whose length is specified by NumVertices.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Each element in pVertexRemap specifies the previous vertex index for that position. For example, if a vertex was in position 3 but has been remapped to position 5, then the fifth element of pVertexRemap should contain 3. The vertex remap array returned by can be used.

+
+ + bb174223 + HRESULT ID3DXSkinInfo::Remap([In] unsigned int NumVertices,[In] unsigned int* pVertexRemap) + ID3DXSkinInfo::Remap +
+ + +

Sets the flexible vertex format (FVF) type.

+
+

Flexible vertex format. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174229 + HRESULT ID3DXSkinInfo::SetFVF([In] unsigned int FVF) + ID3DXSkinInfo::SetFVF +
+ + +

Sets the vertex declaration.

+
+

Pointer to an array of elements.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174228 + HRESULT ID3DXSkinInfo::SetDeclaration([In] const D3DVERTEXELEMENT9* pDeclaration) + ID3DXSkinInfo::SetDeclaration +
+ + +

Gets the fixed function vertex value.

+
+

Returns the flexible vertex format (FVF) codes.

+ +

This method can return 0 if the vertex format cannot be mapped directly to an FVF code. This will occur for a mesh created from a vertex declaration that doesn't have the same order and elements supported by the FVF codes.

+
+ + bb174216 + unsigned int ID3DXSkinInfo::GetFVF() + ID3DXSkinInfo::GetFVF +
+ + +

Gets the vertex declaration.

+
+

Array of elements describing the vertex format of the mesh vertices. The upper limit of this declarator array is . The vertex element array ends with the D3DDECL_END macro.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

The array of elements includes the D3DDECL_END macro, which ends the declaration.

+
+ + bb174215 + HRESULT ID3DXSkinInfo::GetDeclaration([In] D3DVERTEXELEMENT9* Declaration) + ID3DXSkinInfo::GetDeclaration +
+ + +

Applies software skinning to the target vertices based on the current matrices.

+
+

Bone transform matrix.

+

Inverse transpose of the bone transform matrix.

+

Pointer to the buffer containing the source vertices.

+

Pointer to the buffer containing the destination vertices.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

When used to skin vertices with two position elements, this method skins the second position element with the inverse of the bone instead of the bone itself.

+
+ + bb174231 + HRESULT ID3DXSkinInfo::UpdateSkinnedMesh([In] const D3DXMATRIX* pBoneTransforms,[In] const D3DXMATRIX* pBoneInvTransposeTransforms,[In] const void* pVerticesSrc,[In] void* pVerticesDst) + ID3DXSkinInfo::UpdateSkinnedMesh +
+ + +

Takes a mesh and returns a new mesh with per-vertex blend weights and a bone combination table. The table describes which bones affect which subsets of the mesh.

+
+

Input mesh. See .

+

Currently unused.

+

Input mesh adjacency information.

+

Output mesh adjacency information.

+

An array of DWORDs, one per face, that identifies the original mesh face that corresponds to each face in the blended mesh. If the value supplied for this argument is null, face remap data is not returned.

+

Address of a reference to an interface, which contains a DWORD for each vertex that specifies how the new vertices map to the old vertices. This remap is useful if you need to alter external data based on the new vertex mapping. This parameter is optional; null may be used.

+

Pointer to a DWORD that will contain the maximum number of bone influences required per vertex for this skinning method.

+

Pointer to the number of bones in the bone combination table.

+

Pointer to the bone combination table. The data is organized in a structure.

+

Pointer to the new mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Each element in the remap array specifies the previous index for that position. For example, if a vertex was in position 3 but has been remapped to position 5, then the fifth element of pVertexRemap will contain 3.

This method does not run on hardware that does not support fixed-function vertex blending.

+
+ + bb174208 + HRESULT ID3DXSkinInfo::ConvertToBlendedMesh([In] ID3DXMesh* pMesh,[In] unsigned int Options,[In] const unsigned int* pAdjacencyIn,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pFaceRemap,[In] ID3DXBuffer** ppVertexRemap,[In] unsigned int* pMaxFaceInfl,[In] unsigned int* pNumBoneCombinations,[In] ID3DXBuffer** ppBoneCombinationTable,[In] ID3DXMesh** ppMesh) + ID3DXSkinInfo::ConvertToBlendedMesh +
+ + +

Takes a mesh and returns a new mesh with per-vertex blend weights, indices, and a bone combination table. The table describes which bone palettes affect which subsets of the mesh.

+
+

The input mesh. See .

+

Currently unused.

+

Number of bone matrices available for matrix palette skinning.

+

Input mesh adjacency information.

+

Output mesh adjacency information.

+

An array of DWORDs, one per face, that identifies the original mesh face that corresponds to each face in the blended mesh. If the value supplied for this argument is null, face remap data is not returned.

+

Address of a reference to an interface, which contains a DWORD for each vertex that specifies how the new vertices map to the old vertices. This remap is useful if you need to alter external data based on the new vertex mapping. This parameter is optional; null may be used.

+

Pointer to a DWORD that will contain the maximum number of bone influences required per vertex for this skinning method.

+

Pointer to the number of bones in the bone combination table.

+

Pointer to the bone combination table. The data is organized in a structure.

+

Pointer to the new mesh.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Each element in the remap arrays specifies the previous index for that position. For example, if a vertex was in position 3 but has been remapped to position 5, then the fifth element of pVertexRemap will contain 3.

This method does not run on hardware that does not support fixed-function vertex blending.

+
+ + bb174209 + HRESULT ID3DXSkinInfo::ConvertToIndexedBlendedMesh([In] ID3DXMesh* pMesh,[In] unsigned int Options,[In] unsigned int paletteSize,[In] const unsigned int* pAdjacencyIn,[In] unsigned int* pAdjacencyOut,[In] unsigned int* pFaceRemap,[In] ID3DXBuffer** ppVertexRemap,[In] unsigned int* pMaxVertexInfl,[In] unsigned int* pNumBoneCombinations,[In] ID3DXBuffer** ppBoneCombinationTable,[In] ID3DXMesh** ppMesh) + ID3DXSkinInfo::ConvertToIndexedBlendedMesh +
+ + +

Gets the maximum number of influences for any vertex in the mesh.

+
+ + bb174218 + GetMaxVertexInfluences + GetMaxVertexInfluences + HRESULT ID3DXSkinInfo::GetMaxVertexInfluences([Out] unsigned int* maxVertexInfluences) +
+ + +

Gets the number of bones.

+
+ + bb174221 + GetNumBones + GetNumBones + unsigned int ID3DXSkinInfo::GetNumBones() +
+ + +

Gets or sets the minimum bone influence. Influence values smaller than this are ignored.

+
+ + bb174219 + GetMinBoneInfluence / SetMinBoneInfluence + GetMinBoneInfluence + float ID3DXSkinInfo::GetMinBoneInfluence() +
+ + +

Gets or sets the fixed function vertex value.

+
+ +

This method can return 0 if the vertex format cannot be mapped directly to an FVF code. This will occur for a mesh created from a vertex declaration that doesn't have the same order and elements supported by the FVF codes.

+
+ + bb174216 + GetFVF / SetFVF + GetFVF + unsigned int ID3DXSkinInfo::GetFVF() +
+ + +

The interface provides a set of methods that simplify the process of drawing sprites using Microsoft Direct3D.

+
+ +

The interface is obtained by calling the function.

The application typically first calls , which allows control over the device render state, alpha blending, and sprite transformation and sorting. Then for each sprite to be displayed, call . can be called repeatedly to store any number of sprites. To display the batched sprites to the device, call or .

The LPD3DXSPRITE type is defined as a reference to the interface.

 typedef interface  ;	
+            typedef interface  *LPD3DXSPRITE;	
+            
+
+ + bb174249 + ID3DXSprite + ID3DXSprite +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the device associated with the sprite object.

+
+

Address of a reference to an interface, representing the Direct3D device object associated with the sprite object.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned.

+ +

Calling this method will increase the internal reference count on the interface.

+
+ + bb174254 + HRESULT ID3DXSprite::GetDevice([Out] IDirect3DDevice9** ppDevice) + ID3DXSprite::GetDevice +
+ + +

Gets the sprite transform.

+
+

Pointer to a that contains a transform of the sprite from the original world space.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned.

+ + bb174255 + HRESULT ID3DXSprite::GetTransform([Out] D3DXMATRIX* pTransform) + ID3DXSprite::GetTransform +
+ + +

Sets the sprite transform.

+
+

Pointer to a that contains a transform of the sprite from the original world space. Use this transform to scale, rotate, or transform the sprite.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned.

+ + bb174258 + HRESULT ID3DXSprite::SetTransform([In] const D3DXMATRIX* pTransform) + ID3DXSprite::SetTransform +
+ + +

Sets the right-handed world-view transform for a sprite. A call to this method is required before billboarding or sorting sprites.

+
+

Pointer to a that contains a world transform. If null, the identity matrix is used for the world transform.

+

Pointer to a that contains a view transform. If null, the identity matrix is used for the view transform.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned.

+ +

A call to this method (or to ) is required if the sprite will be rendered with the D3DXSprite__BILLBOARD, D3DXSprite__SORT_DEPTH_FRONTTOBACK, or D3DXSprite__SORT_DEPTH_BACKTOFRONT flag value in .

+
+ + bb174260 + HRESULT ID3DXSprite::SetWorldViewRH([In] const D3DXMATRIX* pWorld,[In] const D3DXMATRIX* pView) + ID3DXSprite::SetWorldViewRH +
+ + +

Sets the left-handed world-view transform for a sprite. A call to this method is required before billboarding or sorting sprites.

+
+

Pointer to a that contains a world transform. If null, the identity matrix is used for the world transform.

+

Pointer to a that contains a view transform. If null, the identity matrix is used for the view transform.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned.

+ +

A call to this method (or to ) is required if the sprite will be rendered with the D3DXSprite__BILLBOARD, D3DXSprite__SORT_DEPTH_FRONTTOBACK, or D3DXSprite__SORT_DEPTH_BACKTOFRONT flag value in .

+
+ + bb174259 + HRESULT ID3DXSprite::SetWorldViewLH([In] const D3DXMATRIX* pWorld,[In] const D3DXMATRIX* pView) + ID3DXSprite::SetWorldViewLH +
+ + +

Prepares a device for drawing sprites.

+
+

Combination of zero or more flags that describe sprite rendering options. For this method, the valid flags are:

  • D3DXSPRITE__BILLBOARD
  • D3DXSPRITE__SORT_DEPTH_BACKTOFRONT
  • D3DXSPRITE__SORT_DEPTH_FRONTTOBACK
  • D3DXSPRITE__SORT_TEXTURE

For a description of the flags and for information on how to control device state capture and device view transforms, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

+ +

This method must be called from inside a . . . sequence. cannot be used as a substitute for either or .

This method will set the following states on the device.

Render States:

Type ()Value
TRUE
0x00
AlphaCmpCaps
TRUE
| | |
0

?

Texture Stage States:

Stage IdentifierType ()Value
0
0
0
0
0
0
00
0
1
1

?

Sampler States:

Sampler Stage IndexType ()Value
0
0
0 if TextureFilterCaps includes ; otherwise
00
0MaxAnisotropy
0 if TextureFilterCaps includes ; otherwise
0 if TextureFilterCaps includes ; otherwise
00
00

?

Note??This method disables N-patches.

+
+ + bb174250 + HRESULT ID3DXSprite::Begin([In] D3DXSPRITE Flags) + ID3DXSprite::Begin +
+ + +

Adds a sprite to the list of batched sprites.

+
+

Pointer to an interface that represents the sprite texture.

+

Pointer to a structure that indicates the portion of the source texture to use for the sprite. If this parameter is null, then the entire source image is used for the sprite.

+

Pointer to a vector that identifies the center of the sprite. If this argument is null, the point (0,0,0) is used, which is the upper-left corner.

+

Pointer to a vector that identifies the position of the sprite. If this argument is null, the point (0,0,0) is used, which is the upper-left corner.

+

type. The color and alpha channels are modulated by this value. A value of 0xFFFFFFFF maintains the original source color and alpha data. Use the D3DCOLOR_RGBA macro to help generate this color.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

To scale, rotate, or translate a sprite, call with a matrix that contains the scale, rotate, and translate (SRT) values, before calling . For information about setting SRT values in a matrix, see Matrix Transforms.

+
+ + bb174251 + HRESULT ID3DXSprite::Draw([In] IDirect3DTexture9* pTexture,[In] const void* pSrcRect,[In] const void* pCenter,[In] const void* pPosition,[In] D3DCOLOR Color) + ID3DXSprite::Draw +
+ + +

Forces all batched sprites to be submitted to the device. Device states remain as they were after the last call to . The list of batched sprites is then cleared.

+
+

If the method succeeds, the return value is . If the method fails, the following value will be returned.

+ + bb174253 + HRESULT ID3DXSprite::Flush() + ID3DXSprite::Flush +
+ + +

Calls and restores the device state to how it was before was called.

+
+

If the method succeeds, the return value is . If the method fails, the following value will be returned.

+ +

cannot be used as a substitute for either or .

+
+ + bb174252 + HRESULT ID3DXSprite::End() + ID3DXSprite::End +
+ + +

Use this method to release all references to video memory resources and delete all stateblocks. This method should be called whenever a device is lost or before resetting a device.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method should be called whenever the device is lost or before the user calls . Even if the device was not actually lost, is responsible for freeing stateblocks and other resources that may need to be released before resetting the device. As a result, the font object cannot be used again before calling and then .

+
+ + bb174256 + HRESULT ID3DXSprite::OnLostDevice() + ID3DXSprite::OnLostDevice +
+ + +

Use this method to re-acquire resources and save initial state.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

should be called each time the device is reset (using ), before any other methods are called. This is a good place to re-acquire video-memory resources and capture state blocks.

+
+ + bb174257 + HRESULT ID3DXSprite::OnResetDevice() + ID3DXSprite::OnResetDevice +
+ + + Creates a sprite object which is associated with a particular device. Sprite objects are used to draw 2D images to the screen. + + A reference to the device (see ) that will draw the sprite. + + This interface can be used to draw two dimensional images in screen space of the associated device. + + HRESULT D3DXCreateSprite([In] IDirect3DDevice9* pDevice,[Out, Fast] ID3DXSprite** ppSprite) + + + +

Adds a sprite to the list of batched sprites.

+
+

Pointer to an interface that represents the sprite texture.

+

type. The color and alpha channels are modulated by this value. A value of 0xFFFFFFFF maintains the original source color and alpha data. Use the D3DCOLOR_RGBA macro to help generate this color.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

To scale, rotate, or translate a sprite, call with a matrix that contains the scale, rotate, and translate (SRT) values, before calling . For information about setting SRT values in a matrix, see Matrix Transforms.

+
+ bb174251 + HRESULT ID3DXSprite::Draw([In] IDirect3DTexture9* pTexture,[In] const RECT* pSrcRect,[In] const D3DXVECTOR3* pCenter,[In] const D3DXVECTOR3* pPosition,[In] D3DCOLOR Color) + ID3DXSprite::Draw +
+ + +

Adds a sprite to the list of batched sprites.

+
+

Pointer to an interface that represents the sprite texture.

+

Pointer to a structure that indicates the portion of the source texture to use for the sprite. If this parameter is null, then the entire source image is used for the sprite.

+

Pointer to a vector that identifies the center of the sprite. If this argument is null, the point (0,0,0) is used, which is the upper-left corner.

+

Pointer to a vector that identifies the position of the sprite. If this argument is null, the point (0,0,0) is used, which is the upper-left corner.

+

type. The color and alpha channels are modulated by this value. A value of 0xFFFFFFFF maintains the original source color and alpha data. Use the D3DCOLOR_RGBA macro to help generate this color.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

To scale, rotate, or translate a sprite, call with a matrix that contains the scale, rotate, and translate (SRT) values, before calling . For information about setting SRT values in a matrix, see Matrix Transforms.

+
+ bb174251 + HRESULT ID3DXSprite::Draw([In] IDirect3DTexture9* pTexture,[In] const RECT* pSrcRect,[In] const D3DXVECTOR3* pCenter,[In] const D3DXVECTOR3* pPosition,[In] D3DCOLOR Color) + ID3DXSprite::Draw +
+ + +

Retrieves the device associated with the sprite object.

+
+ +

Calling this method will increase the internal reference count on the interface.

+
+ + bb174254 + GetDevice + GetDevice + HRESULT ID3DXSprite::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Gets or sets the sprite transform.

+
+ + bb174255 + GetTransform / SetTransform + GetTransform + HRESULT ID3DXSprite::GetTransform([Out] D3DXMATRIX* pTransform) +
+ + +

Applications use the methods of the interface to encapsulate render states.

+
+ +

This interface can be used to save and restore pipeline state. It can also be used to capture the current state.

The LPDIRECT3DSTATEBLOCK9 and PDIRECT3DSTATEBLOCK9 types are defined as references to the interface.

typedef struct  *LPDIRECT3DSTATEBLOCK9, *PDIRECT3DSTATEBLOCK9;
+
+ + bb205887 + IDirect3DStateBlock9 + IDirect3DStateBlock9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the device.

+
+

Pointer to the interface that is returned.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205891 + HRESULT IDirect3DStateBlock9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DStateBlock9::GetDevice +
+ + +

Capture the current value of states that are included in a stateblock.

+
+

If the method succeeds, the return value is . If the method fails because capture cannot be done while in record mode, the return value is .

+ +

The Capture method captures current values for states within an existing state block. It does not capture the entire state of the device. For example:

 * pStateBlock = null; pd3dDevice->BeginStateBlock();	
+            // Add the ZENABLE state to the stateblock 	
+            pd3dDevice->SetRenderState ( ,  );	
+            pd3dDevice->EndStateBlock ( &pStateBlock ); // Change the current value that is stored in the state block	
+            pd3dDevice->SetRenderState ( ,  );	
+            pStateBlock->Capture();			 pStateBlock->Release();	
+            

Creating an empty stateblock and calling the Capture method does nothing if no states have been set.

The Capture method will not capture information for lights that are explicitly or implicitly created after the stateblock is created.

+
+ + bb205890 + HRESULT IDirect3DStateBlock9::Capture() + IDirect3DStateBlock9::Capture +
+ + +

Apply the state block to the current device state.

+
+

If the method succeeds, the return value is . If the method fails while in record mode, the return value is .

+ + bb205889 + HRESULT IDirect3DStateBlock9::Apply() + IDirect3DStateBlock9::Apply +
+ + + Initializes a new instance of the class. + + The device. + The type. + + + +

Gets the device.

+
+ + bb205891 + GetDevice + GetDevice + HRESULT IDirect3DStateBlock9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Applications use the methods of the interface to query and prepare surfaces.

+
+ +

The LPDIRECT3DSURFACE9 and PDIRECT3DSURFACE9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DSURFACE9, *PDIRECT3DSURFACE9;	
+            
+
+ + bb205892 + IDirect3DSurface9 + IDirect3DSurface9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Provides access to the parent cube texture or texture (mipmap) object, if this surface is a child level of a cube texture or a mipmap. This method can also provide access to the parent swap chain if the surface is a back-buffer child.

+
+

Reference identifier of the container being requested.

+

Address of a reference to fill with the container reference if the query succeeds. See Remarks.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If the surface is created using CreateRenderTarget or CreateOffscreenPlainSurface or CreateDepthStencilSurface, the surface is considered stand alone. In this case, GetContainer will return the Direct3D device used to create the surface.

If the call succeeds, the reference count of the container is increased by one.

Here's an example getting the parent texture of a mip surface.

 // Assumes pSurface is a valid  reference	
+            void *pContainer = null;	
+             *pTexture = null;	
+             hr = pSurface->GetContainer(IID_IDirect3DTexture9, &pContainer);	
+            if (SUCCEEDED(hr) && pContainer)	
+            { pTexture = ( *)pContainer;	
+            }	
+            
+
+ + bb205893 + HRESULT IDirect3DSurface9::GetContainer([In] const GUID& riid,[Out] void** ppContainer) + IDirect3DSurface9::GetContainer +
+ + +

Retrieves a description of the surface.

+
+

Pointer to a structure, describing the surface.

+

If the method succeeds, the return value is .

is returned if the argument is invalid.

+ + bb205895 + HRESULT IDirect3DSurface9::GetDesc([Out] D3DSURFACE_DESC* pDesc) + IDirect3DSurface9::GetDesc +
+ + +

Locks a rectangle on a surface.

+
+

Pointer to a structure that describes the locked region.

+

Pointer to a rectangle to lock. Specified by a reference to a structure. Specifying null for this parameter expands the dirty region to cover the entire surface.

+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

You may not specify a subrect when using . For a description of the flags, see .

+

If the method succeeds, the return value is .

If the method fails, the return value can be or .

+ +

If the flag is specified and the driver cannot lock the surface immediately, will return so that an application can use the CPU cycles while waiting for the driver to lock the surface.

The only lockable format for a depth-stencil surface is . See .

For performance reasons, dirty regions are recorded only for level zero of a texture. Dirty regions are automatically recorded when is called without or . See for more information.

A multisample back buffer cannot be locked.

This method cannot retrieve data from a surface that is is contained by a texture resource created with because such a texture must be assigned to memory and is therefore not lockable. In this case, use instead to copy texture data from device memory to system memory.

+
+ + bb205896 + HRESULT IDirect3DSurface9::LockRect([Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + IDirect3DSurface9::LockRect +
+ + +

Unlocks a rectangle on a surface.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205898 + HRESULT IDirect3DSurface9::UnlockRect() + IDirect3DSurface9::UnlockRect +
+ + +

Retrieves a device context.

+
+

Pointer to the device context for the surface.

+ +

The following restrictions apply.

  • is valid on the following formats only: , , , and . Formats that contain Alpha are not supported because the GDI implementations don't have a well-defined behavior on the alpha channel. For more information about formats, see .
  • Only one device context per surface can be returned at a time.
  • will fail if the surface is already locked. If the surface is a member of a mipmap or cubemap, fails if any other mipmap or cubemap member is locked.
  • fails on render targets unless they were created lockable (or, in the case of back buffers, with the flag).
  • For surfaces not created with , will fail on default pool () surfaces unless they are dynamic () or are lockable render targets.
  • will fail on surfaces.

When a device context is outstanding on a surface, the application may not call these methods:

*

?

* (on a swap chain that contains the surface)

causes an implicit lock; do not retain the device context for later use. Call to release it.

It is valid to call / on levels of a mipmap or cubemap, however, these calls will be slow to all miplevels except the topmost level, and GDI operations to these miplevels will not be accelerated.

The hdc provides access to Win32 and GDI functionality.

+
+ + bb205894 + HRESULT IDirect3DSurface9::GetDC([Out] HDC* phdc) + IDirect3DSurface9::GetDC +
+ + +

Release a device context handle.

+
+

Handle to a device context.

+

If the method succeeds, the return value is . is returned if the argument is invalid.

+ +

An hdc is a Windows resource. It must be released after use so Windows can return it to the pool of available resources.

This method will release only the device context returned by . Otherwise, this method will fail.

+
+ + bb205897 + HRESULT IDirect3DSurface9::ReleaseDC([In] HDC hdc) + IDirect3DSurface9::ReleaseDC +
+ + + Creates a depth-stencil surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [discard]. + A reference to a , representing the created depth-stencil surface resource. + HRESULT IDirect3DDevice9::CreateDepthStencilSurface([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Discard,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + + + + Creates a depth-stencil surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [discard]. + The shared handle. + A reference to a , representing the created depth-stencil surface resource. + HRESULT IDirect3DDevice9::CreateDepthStencilSurface([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Discard,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + + + + Creates a depth-stencil surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [discard]. + The usage. + A reference to a , representing the created depth-stencil surface resource. + HRESULT IDirect3DDevice9Ex::CreateDepthStencilSurfaceEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Discard,[Out, Fast] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + + + + Creates a depth-stencil surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [discard]. + The usage. + The shared handle. + A reference to a , representing the created depth-stencil surface resource. + HRESULT IDirect3DDevice9Ex::CreateDepthStencilSurfaceEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Discard,[Out, Fast] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + + + + Create an off-screen surface. + + The device. + The width. + The height. + The format. + The pool. + A created. + HRESULT IDirect3DDevice9::CreateOffscreenPlainSurface([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + + + + Create an off-screen surface. + + The device. + The width. + The height. + The format. + The pool. + The shared handle. + A created. + HRESULT IDirect3DDevice9::CreateOffscreenPlainSurface([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + + + + Create an off-screen surface. + + The device. + The width. + The height. + The format. + The pool. + The usage. + + A created. + + HRESULT IDirect3DDevice9Ex::CreateOffscreenPlainSurfaceEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + + + + Create an off-screen surface. + + The device. + The width. + The height. + The format. + The pool. + The usage. + The shared handle. + + A created. + + HRESULT IDirect3DDevice9Ex::CreateOffscreenPlainSurfaceEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + + + + Creates a render-target surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [lockable]. + + A render-target . + + HRESULT IDirect3DDevice9::CreateRenderTarget([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Lockable,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + + + + Creates a render-target surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [lockable]. + The shared handle. + + A render-target . + + HRESULT IDirect3DDevice9::CreateRenderTarget([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Lockable,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle) + + + + Creates a render-target surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [lockable]. + The usage. + A render-target . + HRESULT IDirect3DDevice9Ex::CreateRenderTargetEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Lockable,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + + + + Creates a render-target surface. + + The device. + The width. + The height. + The format. + Type of the multisample. + The multisample quality. + if set to true [lockable]. + The usage. + The shared handle. + A render-target . + HRESULT IDirect3DDevice9Ex::CreateRenderTargetEx([In] unsigned int Width,[In] unsigned int Height,[In] D3DFORMAT Format,[In] D3DMULTISAMPLE_TYPE MultiSample,[In] unsigned int MultisampleQuality,[In] BOOL Lockable,[Out] IDirect3DSurface9** ppSurface,[In] void** pSharedHandle,[In] unsigned int Usage) + + + + Loads a surface from a file. + + The surface. + Name of the file. + The filter. + The color key. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileW([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const wchar_t* pSrcFile,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file. + + The surface. + Name of the file. + The filter. + The color key. + The source rectangle. + The destination rectangle. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileW([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const wchar_t* pSrcFile,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file. + + The surface. + Name of the file. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The image information. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileW([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const wchar_t* pSrcFile,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file. + + The surface. + Name of the file. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The palette. + The image information. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileW([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const wchar_t* pSrcFile,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The memory. + The filter. + The color key. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The memory. + The filter. + The color key. + The source rectangle. + The destination rectangle. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The memory. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The image information. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The memory. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The palette. + The image information. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The stream. + The filter. + The color key. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The stream. + The filter. + The color key. + The source rectangle. + The destination rectangle. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The stream. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The image information. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The stream. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The palette. + The image information. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from a file in memory. + + The surface. + The stream. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The palette. + The image information. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromFileInMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a surface from memory. + + The surface. + The data. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from memory. + + The surface. + The data. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + The destination rectangle. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from memory. + + The surface. + The data. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + The source palette. + The destination palette. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from memory. + + The surface. + The data. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + The destination rectangle. + The source palette. + The destination palette. + A object describing the result of the operation. + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from memory. + + The surface. + The stream. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from memory. + + The surface. + The stream. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + The destination rectangle. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from memory. + + The surface. + The stream. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + The source palette. + The destination palette. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from memory. + + The surface. + The stream. + The filter. + The color key. + The source format. + The source pitch. + The source rectangle. + The destination rectangle. + The source palette. + The destination palette. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromMemory([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcPitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from a source surface. + + The destination surface. + The source surface. + The filter. + The color key. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromSurface([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from a source surface. + + The destination surface. + The source surface. + The filter. + The color key. + The source rectangle. + The destination rectangle. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromSurface([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a surface from a source surface. + + The destination surface. + The source surface. + The filter. + The color key. + The source rectangle. + The destination rectangle. + The destination palette. + The source palette. + + A object describing the result of the operation. + + HRESULT D3DXLoadSurfaceFromSurface([In] IDirect3DSurface9* pDestSurface,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestRect,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Gets the parent cube texture or texture (mipmap) object, if this surface is a child level of a cube texture or a mipmap. + This method can also provide access to the parent swap chain if the surface is a back-buffer child. + + + The GUID. + The parent container texture. + + + + Locks a rectangle on a surface. + + The type of lock to perform. + A pointer to the locked region + HRESULT IDirect3DSurface9::LockRect([Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a surface. + + The rectangle to lock. + The type of lock to perform. + A pointer to the locked region + HRESULT IDirect3DSurface9::LockRect([Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a surface. + + The type of lock to perform. + The stream pointing to the locked region. + A pointer to the locked region + HRESULT IDirect3DSurface9::LockRect([Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a surface. + + The rectangle to lock. + The type of lock to perform. + The stream pointing to the locked region. + A pointer to the locked region + HRESULT IDirect3DSurface9::LockRect([Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Saves a surface to a file. + + The surface. + Name of the file. + The format. + + A object describing the result of the operation. + + HRESULT D3DXSaveSurfaceToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + + + + Saves a surface to a file. + + The surface. + Name of the file. + The format. + The rectangle. + + A object describing the result of the operation. + + HRESULT D3DXSaveSurfaceToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + + + + Saves a surface to a file. + + The surface. + Name of the file. + The format. + The rectangle. + The palette. + + A object describing the result of the operation. + + HRESULT D3DXSaveSurfaceToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + + + + Saves a surface to a stream. + + The surface. + The format. + + A object describing the result of the operation. + + HRESULT D3DXSaveSurfaceToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + + + + Saves a surface to a stream. + + The surface. + The format. + The rectangle. + + A object describing the result of the operation. + + HRESULT D3DXSaveSurfaceToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + + + + Saves a surface to a stream. + + The surface. + The format. + The rectangle. + The palette. + + A object describing the result of the operation. + + HRESULT D3DXSaveSurfaceToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DSurface9* pSrcSurface,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcRect) + + + +

Retrieves a description of the surface.

+
+ + bb205895 + GetDesc + GetDesc + HRESULT IDirect3DSurface9::GetDesc([Out] D3DSURFACE_DESC* pDesc) +
+ + +

Applications use the methods of the interface to manipulate a swap chain.

+
+ +

There is always at least one swap chain for each device, known as the implicit swap chain. However, an additional swap chain for rendering multiple views from the same device can be created by calling the method.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DSWAPCHAIN9 and PDIRECT3DSWAPCHAIN9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DSWAPCHAIN9, *PDIRECT3DSWAPCHAIN9;	
+            

Note the application should ensure that its associated device window is visible when its swapchain(s) is in fullscreen mode. Invisible windows cannot receive user mode events and invisible fullscreen windows will interfere with other windowed mode applications' presentation.

+
+ + bb205899 + IDirect3DSwapChain9 + IDirect3DSwapChain9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Presents the contents of the next buffer in the sequence of back buffers owned by the swap chain.

+
+

Pointer to the source rectangle (see ). Use null to present the entire surface. This value must be null unless the swap chain was created with . If the rectangle exceeds the source surface, the rectangle is clipped to the source surface.

+

Pointer to the destination rectangle in client coordinates (see ). This value must be null unless the swap chain was created with . Use null to fill the entire client area. If the rectangle exceeds the destination client area, the rectangle is clipped to the destination client area.

+

Destination window whose client area is taken as the target for this presentation. If this value is null, the hWndDeviceWindow member of is taken.

+

This value must be null unless the swap chain was created with . See Flipping Surfaces (Direct3D 9). If this value is non-null, the contained region is expressed in back buffer coordinates. The rectangles within the region are the minimal set of pixels that need to be updated. This method takes these rectangles into account when optimizing the presentation by copying only the pixels within the region, or some suitably expanded set of rectangles. This is an aid to optimization only, and the application should not rely on the region being copied exactly. The implementation may choose to copy the whole source rectangle.

+

Allows the application to request that the method return immediately when the driver reports that it cannot schedule a presentation. Valid values are 0, or any combination of or .

  • If dwFlags = 0, this method behaves as it did prior to Direct3D 9. Present will spin until the hardware is free, without returning an error.
  • If dwFlags = , and the hardware is busy processing or waiting for a vertical sync interval, the method will return .
  • If dwFlags = , gamma correction is performed from linear space to sRGB for windowed swap chains. This flag will take effect only when the driver exposes (see Gamma (Direct3D 9)). Appliations should specify this flag if the backbuffer format is 16-bit floating point in order to match windowed mode present to fullscreen gamma behavior.
+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , , , E_OUTOFMEMORY.

+ +

The Present method is a shortcut to Present. Present has been updated to take a flag allowing the application to request that the method return immediately when the driver reports that it cannot schedule a presentation.

If necessary, a stretch operation is applied to transfer the pixels within the source rectangle to the destination rectangle in the client area of the target window.

Present will fail if called between BeginScene and EndScene pairs unless the render target is not the current render target (such as the back buffer you get from creating an additional swap chain). This is a new behavior for Direct3D 9.

+
+ + bb205908 + HRESULT IDirect3DSwapChain9::Present([In, Optional] const void* pSourceRect,[InOut, Optional] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + IDirect3DSwapChain9::Present +
+ + +

Generates a copy of the swapchain's front buffer and places that copy in a system memory buffer provided by the application.

+
+

Pointer to an interface that will receive a copy of the swapchain's front buffer. The data is returned in successive rows with no intervening space, starting from the vertically highest row to the lowest. For windowed mode, the size of the destination surface should be the size of the desktop. For full screen mode, the size of the destination surface should be the screen size.

+

If the method succeeds, the return value is . If BackBuffer exceeds or equals the total number of back buffers, the function fails and returns .

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205905 + HRESULT IDirect3DSwapChain9::GetFrontBufferData([In] IDirect3DSurface9* pDestSurface) + IDirect3DSwapChain9::GetFrontBufferData +
+ + +

Retrieves a back buffer from the swap chain of the device.

+
+

Index of the back buffer object to return. Back buffers are numbered from 0 to the total number of back buffers - 1. A value of 0 returns the first back buffer, not the front buffer. The front buffer is not accessible through this method. Use to retrieve a copy of the front buffer.

+

Stereo view is not supported in Direct3D 9, so the only valid value for this parameter is .

+

Address of a reference to an interface, representing the returned back buffer surface.

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak. You must release any surfaces obtained through this method before releasing the swap chain it belongs to.

+
+ + bb205902 + HRESULT IDirect3DSwapChain9::GetBackBuffer([In] unsigned int iBackBuffer,[In] D3DBACKBUFFER_TYPE Type,[Out] IDirect3DSurface9** ppBackBuffer) + IDirect3DSwapChain9::GetBackBuffer +
+ + +

Returns information describing the raster of the monitor on which the swap chain is presented.

+
+

Pointer to a structure filled with information about the position or other status of the raster on the monitor driven by this adapter.

+

If the method succeeds, the return value is . is returned if pRasterStatus is invalid or if the device does not support reading the current scan line. To determine if the device supports reading the scan line, check for the flag in the Caps member of .

+ + bb205907 + HRESULT IDirect3DSwapChain9::GetRasterStatus([Out] D3DRASTER_STATUS* pRasterStatus) + IDirect3DSwapChain9::GetRasterStatus +
+ + +

Retrieves the display mode's spatial resolution, color resolution, and refresh frequency.

+
+

Pointer to a structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205904 + HRESULT IDirect3DSwapChain9::GetDisplayMode([Out] D3DDISPLAYMODE* pMode) + IDirect3DSwapChain9::GetDisplayMode +
+ + +

Retrieves the device associated with the swap chain.

+
+

Address of a reference to an interface to fill with the device reference, if the query succeeds.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method allows navigation to the owning device object.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205903 + HRESULT IDirect3DSwapChain9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DSwapChain9::GetDevice +
+ + +

Retrieves the presentation parameters associated with a swap chain.

+
+

Pointer to the presentation parameters. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method can be used to see the presentation parameters of the parent swap chain of a surface (a back buffer, for instance). The parent swap chain can be retrieved with .

+
+ + bb205906 + HRESULT IDirect3DSwapChain9::GetPresentParameters([Out] D3DPRESENT_PARAMETERS* pPresentationParameters) + IDirect3DSwapChain9::GetPresentParameters +
+ + + Initializes a new instance of the class. + + The device. + The present parameters. + HRESULT IDirect3DDevice9::CreateAdditionalSwapChain([In] D3DPRESENT_PARAMETERS* pPresentationParameters,[In] IDirect3DSwapChain9** pSwapChain) + + + + Retrieves a back buffer from the swap chain of the device. + + The i back buffer. + The back buffer from the swap chain of the device. + HRESULT IDirect3DSwapChain9::GetBackBuffer([In] unsigned int iBackBuffer,[In] D3DBACKBUFFER_TYPE Type,[Out] IDirect3DSurface9** ppBackBuffer) + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + The present flags. + HRESULT IDirect3DSwapChain9::Present([In, Optional] const void* pSourceRect,[InOut, Optional] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + The present flags. + The area of the back buffer that should be presented. + The area of the front buffer that should receive the result of the presentation. + HRESULT IDirect3DSwapChain9::Present([In, Optional] const void* pSourceRect,[InOut, Optional] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + The present flags. + The area of the back buffer that should be presented. + The area of the front buffer that should receive the result of the presentation. + The destination window whose client area is taken as the target for this presentation. + HRESULT IDirect3DSwapChain9::Present([In, Optional] const void* pSourceRect,[InOut, Optional] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + + Presents the contents of the next buffer in the sequence of back buffers to the screen. + + The flags. + The area of the back buffer that should be presented. + The area of the front buffer that should receive the result of the presentation. + The destination window whose client area is taken as the target for this presentation. + Specifies a region on the back buffer that contains the minimal amount of pixels that need to be updated. + HRESULT IDirect3DSwapChain9::Present([In, Optional] const void* pSourceRect,[InOut, Optional] const void* pDestRect,[In] HWND hDestWindowOverride,[In] const RGNDATA* pDirtyRegion,[In] unsigned int dwFlags) + + + +

Returns information describing the raster of the monitor on which the swap chain is presented.

+
+ + bb205907 + GetRasterStatus + GetRasterStatus + HRESULT IDirect3DSwapChain9::GetRasterStatus([Out] D3DRASTER_STATUS* pRasterStatus) +
+ + +

Retrieves the display mode's spatial resolution, color resolution, and refresh frequency.

+
+ + bb205904 + GetDisplayMode + GetDisplayMode + HRESULT IDirect3DSwapChain9::GetDisplayMode([Out] D3DDISPLAYMODE* pMode) +
+ + +

Retrieves the device associated with the swap chain.

+
+ +

This method allows navigation to the owning device object.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205903 + GetDevice + GetDevice + HRESULT IDirect3DSwapChain9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Retrieves the presentation parameters associated with a swap chain.

+
+ +

This method can be used to see the presentation parameters of the parent swap chain of a surface (a back buffer, for instance). The parent swap chain can be retrieved with .

+
+ + bb205906 + GetPresentParameters + GetPresentParameters + HRESULT IDirect3DSwapChain9::GetPresentParameters([Out] D3DPRESENT_PARAMETERS* pPresentationParameters) +
+ + +

Applications use the methods of the interface to manipulate a swap chain.

+
+ +

There is always at least one swap chain for each device, known as the implicit swap chain. However, an additional swap chain for rendering multiple views from the same device can be created by calling the CreateAdditionalSwapChain method.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DSWAPCHAIN9 and PDIRECT3DSWAPCHAIN9 types are defined as references to the interface.

objects are returned as a reference to an object when GetSwapChain is called on an instance of . + The interface is obtained by calling QueryInterface on the instance of that was returned by GetSwapChain.

+
+ + bb172503 + IDirect3DSwapChain9Ex + IDirect3DSwapChain9Ex +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Returns the number of times the swapchain has been processed.

+
+

Pointer to a UINT to be filled with the number of times the method has been called. The count will also be incremented by calling some other APIs such as .

+

the method was successful.

+ + bb205900 + HRESULT IDirect3DSwapChain9Ex::GetLastPresentCount([Out] unsigned int* pLastPresentCount) + IDirect3DSwapChain9Ex::GetLastPresentCount +
+ + + No documentation. + + No documentation. + No documentation. + + HRESULT IDirect3DSwapChain9Ex::GetPresentStats([Out] D3DPRESENTSTATS* pPresentationStatistics) + IDirect3DSwapChain9Ex::GetPresentStats + + + +

Retrieves the display mode's spatial resolution, color resolution, refresh frequency, and rotation settings.

+
+

Pointer to a structure containing data about the display mode of the adapter. As opposed to the display mode of the device, which may not be active if the device does not own full-screen mode.

+

Pointer to a indicating the type of screen rotation the application will do. The value returned through this reference is important when the flag is used; otherwise, it can be set to null.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb509715 + HRESULT IDirect3DSwapChain9Ex::GetDisplayModeEx([Out] D3DDISPLAYMODEEX* pMode,[Out] D3DDISPLAYROTATION* pRotation) + IDirect3DSwapChain9Ex::GetDisplayModeEx +
+ + +

Returns the number of times the swapchain has been processed.

+
+ + bb205900 + GetLastPresentCount + GetLastPresentCount + HRESULT IDirect3DSwapChain9Ex::GetLastPresentCount([Out] unsigned int* pLastPresentCount) +
+ + + No documentation. + + + GetPresentStats + GetPresentStats + HRESULT IDirect3DSwapChain9Ex::GetPresentStats([Out] D3DPRESENTSTATS* pPresentationStatistics) + + + +

Applications use the methods of the interface to manipulate a texture resource.

+
+ +

The interface can be obtained by calling the method or one of the xxx functions.

This interface inherits additional functionality from the interface.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DTEXTURE9 and PDIRECT3DTEXTURE9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DTEXTURE9, *PDIRECT3DTEXTURE9;	
+            
+
+ + bb205909 + IDirect3DTexture9 + IDirect3DTexture9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves a level description of a texture resource.

+
+

Identifies a level of the texture resource. This method returns a surface description for the level specified by this parameter.

+

Pointer to a structure, describing the returned level.

+ + bb205911 + HRESULT IDirect3DTexture9::GetLevelDesc([In] unsigned int Level,[Out] D3DSURFACE_DESC* pDesc) + IDirect3DTexture9::GetLevelDesc +
+ + +

Retrieves the specified texture surface level.

+
+

Identifies a level of the texture resource. This method returns a surface for the level specified by this parameter. The top-level surface is denoted by 0.

+

Address of a reference to an interface, representing the returned surface.

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205912 + HRESULT IDirect3DTexture9::GetSurfaceLevel([In] unsigned int Level,[Out] IDirect3DSurface9** ppSurfaceLevel) + IDirect3DTexture9::GetSurfaceLevel +
+ + +

Locks a rectangle on a texture resource.

+
+

Specifies the level of the texture resource to lock.

+

Pointer to a structure, describing the locked region.

+

Pointer to a rectangle to lock. Specified by a reference to a structure. Specifying null for this parameter expands the dirty region to cover the entire texture.

+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

You may not specify a subrect when using . For a description of the flags, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

Textures created with are not lockable. Textures created in video memory are lockable when created with USAGE_DYNAMIC.

For performance reasons, dirty regions are recorded only for level zero of a texture. Dirty regions are automatically recorded when is called without or . See for more information.

The only lockable format for a depth-stencil texture is D3DLOCK_D16_LOCKABLE.

Video memory textures cannot be locked, but must be modified by calling or . There are exceptions for some proprietary driver pixel formats that Direct3D 9 does not recognize. These can be locked.

This method cannot retrieve data from a texture resource created with because such a texture must be assigned to memory and is therefore not lockable. In this case, use instead to copy texture data from device memory to system memory.

+
+ + bb205913 + HRESULT IDirect3DTexture9::LockRect([In] unsigned int Level,[Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + IDirect3DTexture9::LockRect +
+ + +

Unlocks a rectangle on a texture resource.

+
+

Specifies the level of the texture resource to unlock.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205914 + HRESULT IDirect3DTexture9::UnlockRect([In] unsigned int Level) + IDirect3DTexture9::UnlockRect +
+ + +

Adds a dirty region to a texture resource.

+
+

Pointer to a structure, specifying the dirty region to add. Specifying null expands the dirty region to cover the entire texture.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For performance reasons, dirty regions are only recorded for level zero of a texture. For sublevels, it is assumed that the corresponding (scaled) rectangle or box is also dirty. Dirty regions are automatically recorded when is called without or . The destination surface of is also marked dirty automatically.

Using and explicitly specifying dirty regions can be used to increase the efficiency of . Using this method, applications can optimize what subset of a resource is copied by specifying dirty regions on the resource. However, the dirty regions may be expanded to optimize alignment.

+
+ + bb205910 + HRESULT IDirect3DTexture9::AddDirtyRect([In] const void* pDirtyRect) + IDirect3DTexture9::AddDirtyRect +
+ + + Initializes a new instance of the class. + + The device. + The width. + The height. + The level count. + The usage. + The format. + The pool. + HRESULT IDirect3DDevice9::CreateTexture([In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Levels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DTexture9** ppTexture,[In] void** pSharedHandle) + + + + Initializes a new instance of the class. + + The device. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The shared handle. + HRESULT IDirect3DDevice9::CreateTexture([In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Levels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DTexture9** ppTexture,[In] void** pSharedHandle) + + + + Checks texture-creation parameters. + + Device associated with the texture. + The width. + The height. + Requested number of mipmap levels for the texture. + The requested usage for the texture. + Requested format for the texture. + Memory class where the resource will be placed. + + A value type containing the proposed values to pass to the texture creation functions. + + HRESULT D3DXCheckTextureRequirements([In] IDirect3DDevice9* pDevice,[InOut] unsigned int* pWidth,[InOut] unsigned int* pHeight,[InOut] unsigned int* pNumMipLevels,[In] unsigned int Usage,[InOut] D3DFORMAT* pFormat,[In] D3DPOOL Pool) + + + + Computes the normal map. + + The texture. + The source texture. + The flags. + The channel. + The amplitude. + A object describing the result of the operation. + HRESULT D3DXComputeNormalMap([In] IDirect3DTexture9* pTexture,[In] IDirect3DTexture9* pSrcTexture,[Out, Buffer] const PALETTEENTRY* pSrcPalette,[In] unsigned int Flags,[In] unsigned int Channel,[In] float Amplitude) + + + + Computes the normal map. + + The texture. + The source texture. + The palette. + The flags. + The channel. + The amplitude. + A object describing the result of the operation. + HRESULT D3DXComputeNormalMap([In] IDirect3DTexture9* pTexture,[In] IDirect3DTexture9* pSrcTexture,[Out, Buffer] const PALETTEENTRY* pSrcPalette,[In] unsigned int Flags,[In] unsigned int Channel,[In] float Amplitude) + + + + Uses a user-provided function to fill each texel of each mip level of a given texture. + + A function that is used to fill the texture. + A object describing the result of the operation. + HRESULT D3DXFillTexture([In] IDirect3DTexture9* pTexture,[In] __function__stdcall* pFunction,[In] void* pData) + + + + Uses a compiled high-level shader language (HLSL) function to fill each texel of each mipmap level of a texture. + + A texture shader object that is used to fill the texture. + A object describing the result of the operation. + HRESULT D3DXFillTextureTX([In] IDirect3DTexture9* pTexture,[In] ID3DXTextureShader* pTextureShader) + + + + Locks a rectangle on a texture resource. + + The level. + The flags. + + A describing the region locked. + + HRESULT IDirect3DTexture9::LockRect([In] unsigned int Level,[Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a texture resource. + + The level. + The flags. + The stream pointing to the locked region. + + A describing the region locked. + + HRESULT IDirect3DTexture9::LockRect([In] unsigned int Level,[Out] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a texture resource. + + The level. + The rectangle. + The flags. + + A describing the region locked. + + HRESULT IDirect3DTexture9::LockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[In] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Locks a rectangle on a texture resource. + + The level. + The rectangle. + The flags. + The stream pointing to the locked region. + + A describing the region locked. + + HRESULT IDirect3DTexture9::LockRect([In] D3DCUBEMAP_FACES FaceType,[In] unsigned int Level,[In] D3DLOCKED_RECT* pLockedRect,[In] const void* pRect,[In] D3DLOCK Flags) + + + + Adds a dirty region to a texture resource. + + + A object describing the result of the operation. + + HRESULT IDirect3DTexture9::AddDirtyRect([In] const void* pDirtyRect) + + + + Adds a dirty region to a texture resource. + + The dirty rect ref. + + A object describing the result of the operation. + + HRESULT IDirect3DTexture9::AddDirtyRect([In] const void* pDirtyRect) + + + + Creates a from a file + + The device. + The filename. + + A + + HRESULT D3DXCreateTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a file + + The device. + The filename. + The usage. + The pool. + + A + + HRESULT D3DXCreateTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a file + + The device. + The filename. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a file + + The device. + The filename. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a file + + The device. + The filename. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + + A + + HRESULT D3DXCreateTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The usage. + The pool. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The stream. + A + HRESULT D3DXCreateTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The stream. + The usage. + The pool. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + A + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + The pointer. + The size in bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + + Creates a from a stream. + + The device. + Name of the file. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DTexture9** ppTexture) + + + +

The interface.

+
+ +

The interface is obtained by calling the function.

The interface, like all COM interfaces, inherits the interface.

The LPD3DXTEXTURESHADER type is defined as a reference to the interface.

 typedef interface  *LPD3DXTEXTURESHADER;	
+            
+
+ + bb174276 + ID3DXTextureShader + ID3DXTextureShader +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets a reference to the function DWORD stream.

+
+

A reference to the function DWORD stream. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174283 + HRESULT ID3DXTextureShader::GetFunction([Out] ID3DXBuffer** ppFunction) + ID3DXTextureShader::GetFunction +
+ + +

Get a reference to the constant table.

+
+

Pointer to an interface, which contains the constants.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174278 + HRESULT ID3DXTextureShader::GetConstantBuffer([Out] ID3DXBuffer** ppConstantBuffer) + ID3DXTextureShader::GetConstantBuffer +
+ + +

Gets a description of the constant table.

+
+

The attributes of the constant table. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ + bb174282 + HRESULT ID3DXTextureShader::GetDesc([Out] D3DXCONSTANTTABLE_DESC* pDesc) + ID3DXTextureShader::GetDesc +
+ + +

Gets a reference to the array of constants in the constant table.

+
+

Unique identifier to a constant. See .

+

Returns a reference to an array of descriptions. See .

+

The input supplied must be the maximum size of the array. The output is the number of elements that are filled in the array when the function returns.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , D3DXERR_INVALIDDATA.

+ +

Samplers can appear more than once in a constant table, therefore, this method can return an array of descriptions each with a different register index.

+
+ + bb174280 + HRESULT ID3DXTextureShader::GetConstantDesc([In] D3DXHANDLE hConstant,[Out, Buffer] D3DXCONSTANT_DESC* pConstantDesc,[InOut] unsigned int* pCount) + ID3DXTextureShader::GetConstantDesc +
+ + +

Gets a constant by looking up its index.

+
+

A handle to the parent data structure. If the constant is a top-level parameter (there is no parent data structure), use null.

+

Zero-based index of the constant.

+

Returns a unique identifier to the constant.

+ +

To get a constant from an array of constants, use .

+
+ + bb174277 + D3DXHANDLE ID3DXTextureShader::GetConstant([In] D3DXHANDLE hConstant,[In] unsigned int Index) + ID3DXTextureShader::GetConstant +
+ + +

Gets a constant by looking up its name.

+
+

A handle to the parent data structure. If the constant is a top-level parameter (there is no parent data structure), use null.

+

A string containing the name of the constant.

+

Returns a unique identifier to the constant.

+ + bb174279 + D3DXHANDLE ID3DXTextureShader::GetConstantByName([In] D3DXHANDLE hConstant,[In] const char* pName) + ID3DXTextureShader::GetConstantByName +
+ + +

Get a constant from the constant table.

+
+

A handle to the array of constants. This value may not be null.

+

Zero-based index of the element in the constant table.

+

Returns a unique identifier to the constant.

+ +

To get a constant that is not part of an array, use or .

+
+ + bb174281 + D3DXHANDLE ID3DXTextureShader::GetConstantElement([In] D3DXHANDLE hConstant,[In] unsigned int Index) + ID3DXTextureShader::GetConstantElement +
+ + +

Sets the constants to the default values declared in the shader.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174286 + HRESULT ID3DXTextureShader::SetDefaults() + ID3DXTextureShader::SetDefaults +
+ + +

Sets the constant table with the data in the buffer.

+
+

Unique identifier to a constant. See .

+

A reference to a buffer containing the constant data.

+

Size of the buffer, in bytes.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174297 + HRESULT ID3DXTextureShader::SetValue([In] D3DXHANDLE hConstant,[In] const void* pData,[In] unsigned int Bytes) + ID3DXTextureShader::SetValue +
+ + +

Sets a value.

+
+

Unique identifier to the constant. See .

+

value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174284 + HRESULT ID3DXTextureShader::SetBool([In] D3DXHANDLE hConstant,[In] BOOL b) + ID3DXTextureShader::SetBool +
+ + +

Sets an array of values.

+
+

Unique identifier to the array of constants. See .

+

Array of values.

+

Number of values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174285 + HRESULT ID3DXTextureShader::SetBoolArray([In] D3DXHANDLE hConstant,[In] const BOOL* pb,[In] unsigned int Count) + ID3DXTextureShader::SetBoolArray +
+ + +

Sets an integer value.

+
+

Unique identifier to the constant. See .

+

Integer value.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174289 + HRESULT ID3DXTextureShader::SetInt([In] D3DXHANDLE hConstant,[In] int n) + ID3DXTextureShader::SetInt +
+ + +

Sets an array of integers.

+
+

Unique identifier to the array of constants. See .

+

Array of integers.

+

Number of integers in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174290 + HRESULT ID3DXTextureShader::SetIntArray([In] D3DXHANDLE hConstant,[In] const int* pn,[In] unsigned int Count) + ID3DXTextureShader::SetIntArray +
+ + +

Sets a floating-point number.

+
+

Unique identifier to the constant. See .

+

Floating-point number.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174287 + HRESULT ID3DXTextureShader::SetFloat([In] D3DXHANDLE hConstant,[In] float f) + ID3DXTextureShader::SetFloat +
+ + +

Sets an array of floating-point numbers.

+
+

Unique identifier to the array of constants. See .

+

Array of floating-point numbers.

+

Number of floating-point values in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174288 + HRESULT ID3DXTextureShader::SetFloatArray([In] D3DXHANDLE hConstant,[In] const float* pf,[In] unsigned int Count) + ID3DXTextureShader::SetFloatArray +
+ + +

Sets a 4D vector.

+
+

Unique identifier to the vector constant. See .

+

Pointer to a 4D vector. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174298 + HRESULT ID3DXTextureShader::SetVector([In] D3DXHANDLE hConstant,[In] const D3DXVECTOR4* pVector) + ID3DXTextureShader::SetVector +
+ + +

Sets an array of 4D vectors.

+
+

Unique identifier to the array of vector constants. See .

+

Array of 4D vectors. See .

+

Number of vectors in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb174299 + HRESULT ID3DXTextureShader::SetVectorArray([In] D3DXHANDLE hConstant,[In] const D3DXVECTOR4* pVector,[In] unsigned int Count) + ID3DXTextureShader::SetVectorArray +
+ + +

Sets a non-transposed matrix.

+
+

Unique identifier to the matrix of constants. See .

+

Pointer to a non-transposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A non-transposed matrix contains row-major data; that is, each vector is contained in a row.

+
+ + bb174291 + HRESULT ID3DXTextureShader::SetMatrix([In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix) + ID3DXTextureShader::SetMatrix +
+ + +

Sets an array of non-transposed matrices.

+
+

Unique identifier to the array of constant matrices. See .

+

Array of non-transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A non-transposed matrix contains row-major data; that is, each vector is contained in a row.

+
+ + bb174292 + HRESULT ID3DXTextureShader::SetMatrixArray([In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXTextureShader::SetMatrixArray +
+ + +

Sets an array of references to non-transposed matrices.

+
+

Unique identifier to an array of constant matrices. See .

+

Array of references to non-transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A non-transposed matrix contains row-major data; that is, each vector is contained in a row.

+
+ + bb174293 + HRESULT ID3DXTextureShader::SetMatrixPointerArray([In] D3DXHANDLE hConstant,[In] const D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXTextureShader::SetMatrixPointerArray +
+ + +

Sets a transposed matrix.

+
+

Unique identifier to the matrix of constants. See .

+

Pointer to a transposed matrix. See .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

+
+ + bb174294 + HRESULT ID3DXTextureShader::SetMatrixTranspose([In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix) + ID3DXTextureShader::SetMatrixTranspose +
+ + +

Sets an array of transposed matrices.

+
+

Unique identifier to the array of matrix constants. See .

+

Array of transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

+
+ + bb174295 + HRESULT ID3DXTextureShader::SetMatrixTransposeArray([In] D3DXHANDLE hConstant,[In] const D3DXMATRIX* pMatrix,[In] unsigned int Count) + ID3DXTextureShader::SetMatrixTransposeArray +
+ + +

Sets an array of references to transposed matrices.

+
+

Unique identifier to the array of matrix constants. See .

+

Array of references to transposed matrices. See .

+

Number of matrices in the array.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

A transposed matrix contains column-major data; that is, each vector is contained in a column.

+
+ + bb174296 + HRESULT ID3DXTextureShader::SetMatrixTransposePointerArray([In] D3DXHANDLE hConstant,[In] const D3DXMATRIX** ppMatrix,[In] unsigned int Count) + ID3DXTextureShader::SetMatrixTransposePointerArray +
+ + +

Gets a reference to the function DWORD stream.

+
+ + bb174283 + GetFunction + GetFunction + HRESULT ID3DXTextureShader::GetFunction([Out] ID3DXBuffer** ppFunction) +
+ + +

Get a reference to the constant table.

+
+ + bb174278 + GetConstantBuffer + GetConstantBuffer + HRESULT ID3DXTextureShader::GetConstantBuffer([Out] ID3DXBuffer** ppConstantBuffer) +
+ + +

Gets a description of the constant table.

+
+ + bb174282 + GetDesc + GetDesc + HRESULT ID3DXTextureShader::GetDesc([Out] D3DXCONSTANTTABLE_DESC* pDesc) +
+ + +

Applications use the methods of the interface to manipulate vertex buffer resources.

+
+ +

The interface is obtained by calling the method.

This interface inherits additional functionality from the interface.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DVERTEXBUFFER9 and PDIRECT3DVERTEXBUFFER9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DVERTEXBUFFER9, *PDIRECT3DVERTEXBUFFER9;	
+            
+
+ + bb205915 + IDirect3DVertexBuffer9 + IDirect3DVertexBuffer9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Locks a range of vertex data and obtains a reference to the vertex buffer memory.

+
+

Offset into the vertex data to lock, in bytes. To lock the entire vertex buffer, specify 0 for both parameters, SizeToLock and OffsetToLock.

+

Size of the vertex data to lock, in bytes. To lock the entire vertex buffer, specify 0 for both parameters, SizeToLock and OffsetToLock.

+

VOID* reference to a memory buffer containing the returned vertex data.

+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

As a general rule, do not hold a lock across more than one frame. When working with vertex buffers, you are allowed to make multiple lock calls; however, you must ensure that the number of lock calls match the number of unlock calls. DrawPrimitive calls will not succeed with any outstanding lock count on any currently set vertex buffer.

The and flags are valid only on buffers created with .

For information about using or with , see Using Dynamic Vertex and Index Buffers.

+
+ + bb205917 + HRESULT IDirect3DVertexBuffer9::Lock([In] unsigned int OffsetToLock,[In] unsigned int SizeToLock,[Out] void** ppbData,[In] D3DLOCK Flags) + IDirect3DVertexBuffer9::Lock +
+ + +

Unlocks vertex data.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205918 + HRESULT IDirect3DVertexBuffer9::Unlock() + IDirect3DVertexBuffer9::Unlock +
+ + +

Retrieves a description of the vertex buffer resource.

+
+

Pointer to a structure, describing the returned vertex buffer.

+

If the method succeeds, the return value is . is returned if the argument is invalid.

+ + bb205916 + HRESULT IDirect3DVertexBuffer9::GetDesc([Out] D3DVERTEXBUFFER_DESC* pDesc) + IDirect3DVertexBuffer9::GetDesc +
+ + + Initializes a new instance of the class. + + The device that will be used to create the buffer. + Size of the buffer, in bytes. + The requested usage of the buffer. + The vertex format of the vertices in the buffer. If set to .None, the buffer will be a non-FVF buffer. + The memory class into which the resource will be placed. + + + + Initializes a new instance of the class. + + The device that will be used to create the buffer. + Size of the buffer, in bytes. + The requested usage of the buffer. + The vertex format of the vertices in the buffer. If set to .None, the buffer will be a non-FVF buffer. + The memory class into which the resource will be placed. + The variable that will receive the shared handle for this resource. + This method is only available in Direct3D9 Ex. + + + + Locks a range of vertex data and obtains a pointer to the vertex buffer memory. + + + As a general rule, do not hold a lock across more than one frame. When working with vertex buffers, you are allowed to make multiple lock calls; however, you must ensure that the number of lock calls match the number of unlock calls. DrawPrimitive calls will not succeed with any outstanding lock count on any currently set vertex buffer. The D3DLOCK_DISCARD and D3DLOCK_NOOVERWRITE flags are valid only on buffers created with D3DUSAGE_DYNAMIC. For information about using D3DLOCK_DISCARD or D3DLOCK_NOOVERWRITE with IDirect3DVertexBuffer9::Lock, see {{Using Dynamic Vertex and Index Buffers}}. + + Offset into the vertex data to lock, in bytes. To lock the entire vertex buffer, specify 0 for both parameters, SizeToLock and OffsetToLock. + Size of the vertex data to lock, in bytes. To lock the entire vertex buffer, specify 0 for both parameters, SizeToLock and OffsetToLock. + Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are: D3DLOCK_DISCARD D3DLOCK_NO_DIRTY_UPDATE D3DLOCK_NOSYSLOCK D3DLOCK_READONLY D3DLOCK_NOOVERWRITE For a description of the flags, see . + A if the method succeeds. + HRESULT IDirect3DVertexBuffer9::Lock([None] UINT OffsetToLock,[None] UINT SizeToLock,[Out] void** ppbData,[None] int Flags) + + + +

Retrieves a description of the vertex buffer resource.

+
+ + bb205916 + GetDesc + GetDesc + HRESULT IDirect3DVertexBuffer9::GetDesc([Out] D3DVERTEXBUFFER_DESC* pDesc) +
+ + +

Applications use the methods of the interface to encapsulate the vertex shader declaration.

+
+ +

A vertex shader declaration is made up of an array of vertex elements.

The LPDIRECT3DVERTEXDECLARATION9 and PDIRECT3DVERTEXDECLARATION9 types are defined as references to the interface.

typedef struct  *LPDIRECT3DVERTEXDECLARATION9, *PDIRECT3DVERTEXDECLARATION9;
+
+ + bb205919 + IDirect3DVertexDeclaration9 + IDirect3DVertexDeclaration9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the current device.

+
+

Pointer to the interface that is returned.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ + bb205921 + HRESULT IDirect3DVertexDeclaration9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DVertexDeclaration9::GetDevice +
+ + +

Gets the vertex shader declaration.

+
+

Array of vertex elements (see ) that make up a vertex shader declaration. The application needs to allocate enough room for this. The vertex element array ends with the D3DDECL_END macro.

+

Number of elements in the array. The application needs to allocate enough room for this.

+

If the method succeeds, the return value is . If the method fails, the return value can be: .

+ +

The number of elements, pNumElements, includes the D3DDECL_END macro, which ends the declaration. So the element count is actually one higher than the number of valid vertex elements.

Here's an example that will return the vertex declaration array of up to 256 elements:

  decl[MAXD3DDECLLENGTH];	
+            UINT numElements;	
+             hr = m_pVertexDeclaration->GetDeclaration( decl, &numElements);	
+            

Specify null for pDeclto get the number of elements in the declaration.

+
+ + bb205920 + HRESULT IDirect3DVertexDeclaration9::GetDeclaration([Out, Buffer] D3DVERTEXELEMENT9* pElement,[InOut] unsigned int* pNumElements) + IDirect3DVertexDeclaration9::GetDeclaration +
+ + + Create a vertex shader declaration from the device and the vertex elements. + + + See the {{Vertex Declaration (Direct3D 9)}} page for a detailed description of how to map vertex declarations between different versions of DirectX. + + An array of vertex elements. + If the method succeeds + HRESULT IDirect3DDevice9::CreateVertexDeclaration([In, Buffer] const D3DVERTEXELEMENT9* pVertexElements,[None] IDirect3DVertexDeclaration9** ppDecl) + + + +

Gets the current device.

+
+ + bb205921 + GetDevice + GetDevice + HRESULT IDirect3DVertexDeclaration9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + + Gets the elements. + + HRESULT IDirect3DVertexDeclaration9::GetDeclaration([Out, Buffer] D3DVERTEXELEMENT9* pElement,[InOut] unsigned int* pNumElements) + + + +

Applications use the methods of the interface to encapsulate the functionality of a vertex shader.

+
+ +

The LPDIRECT3DVERTEXSHADER9 and PDIRECT3DVERTEXSHADER9 types are defined as references to the interface.

typedef struct  *LPDIRECT3DVERTEXSHADER9, *PDIRECT3DVERTEXSHADER9;
+
+ + bb205922 + IDirect3DVertexShader9 + IDirect3DVertexShader9 +
+ + Constant MaxDynamicFlowControlDepth. + D3DVS20_MAX_DYNAMICFLOWCONTROLDEPTH + + + Constant MinDynamicFlowControlDepth. + D3DVS20_MIN_DYNAMICFLOWCONTROLDEPTH + + + Constant MaxTemps. + D3DVS20_MAX_NUMTEMPS + + + Constant MinTemps. + D3DVS20_MIN_NUMTEMPS + + + Constant MaxStaticFlowControlDepth. + D3DVS20_MAX_STATICFLOWCONTROLDEPTH + + + Constant MinStaticFlowControlDepth. + D3DVS20_MIN_STATICFLOWCONTROLDEPTH + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the device.

+
+

Pointer to the interface that is returned.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205923 + HRESULT IDirect3DVertexShader9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DVertexShader9::GetDevice +
+ + +

Gets a reference to the shader data.

+
+

Pointer to a buffer that contains the shader data. The application needs to allocate enough room for this.

+

Size of the data, in bytes. To get the buffer size that is needed to retrieve the data, set pData = null when calling GetFunction. Then call GetFunction with the returned size, to get the buffer data.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205924 + HRESULT IDirect3DVertexShader9::GetFunction([In] void* arg0,[InOut] unsigned int* pSizeOfData) + IDirect3DVertexShader9::GetFunction +
+ + + Initializes a new instance of the class. + + The device. + The function. + HRESULT IDirect3DDevice9::CreateVertexShader([In] const void* pFunction,[Out, Fast] IDirect3DVertexShader9** ppShader) + + + +

Gets the device.

+
+ + bb205923 + GetDevice + GetDevice + HRESULT IDirect3DVertexShader9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + + Gets the bytecode associated to this shader.. + + + + +

Applications use the methods of the interface to manipulate volume resources.

+
+ +

The interface is obtained by calling the method.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DVOLUME9 and PDIRECT3DVOLUME9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DVOLUME9, *PDIRECT3DVOLUME9;	
+            
+
+ + bb205932 + IDirect3DVolume9 + IDirect3DVolume9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the device associated with a volume.

+
+

Address of a reference to an interface to fill with the device reference, if the query succeeds.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

This method allows navigation to the owning device object.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205936 + HRESULT IDirect3DVolume9::GetDevice([Out] IDirect3DDevice9** ppDevice) + IDirect3DVolume9::GetDevice +
+ + +

Associates data with the volume that is intended for use by the application, not by Direct3D.

+
+

Reference to the globally unique identifier that identifies the private data to set.

+

Pointer to a buffer that contains the data to associate with the volume.

+

Size of the buffer at pData in bytes.

+

Value that describes the type of data being passed, or indicates to the application that the data should be invalidated when the resource changes.

ItemDescription

(none)

If no flags are specified, Direct3D allocates memory to hold the data within the buffer and copies the data into the new buffer. The buffer allocated by Direct3D is automatically freed, as appropriate.

D3DSPD_IUNKNOWN

The data at pData is a reference to an interface. SizeOfData must be set to the size of a reference to an interface, sizeof(*). Direct3D automatically calls through pData and when the private data is destroyed. Private data will be destroyed by a subsequent call to with the same , a subsequent call to , or when the object is released. For more information, see Remarks.

?

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , E_OUTOFMEMORY.

+ +

Direct3D does not manage the memory at pData. If this buffer was dynamically allocated, it is the calling application's responsibility to free the memory.

Data is passed by value, and multiple sets of data can be associated with a single volume.

+
+ + bb205939 + HRESULT IDirect3DVolume9::SetPrivateData([In] const GUID& refguid,[In] const void* pData,[In] unsigned int SizeOfData,[In] unsigned int Flags) + IDirect3DVolume9::SetPrivateData +
+ + +

Copies the private data associated with the volume to a provided buffer.

+
+

Reference to (C++) or address of (C) the globally unique identifier that identifies the private data to retrieve.

+

Pointer to a previously allocated buffer to fill with the requested private data if the call succeeds. The application calling this method is responsible for allocating and releasing this buffer. If this parameter is null, this method will return the buffer size in pSizeOfData.

+

Pointer to the size of the buffer at pData, in bytes. If this value is less than the actual size of the private data, such as 0, the method sets this parameter to the required buffer size, and the method returns .

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , , .

+ + bb205937 + HRESULT IDirect3DVolume9::GetPrivateData([In] const GUID& refguid,[In] void* pData,[Out] unsigned int* pSizeOfData) + IDirect3DVolume9::GetPrivateData +
+ + +

Frees the specified private data associated with this volume.

+
+

Reference to the globally unique identifier that identifies the private data to free.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: , .

+ +

Direct3D calls this method automatically when a volume is released.

+
+ + bb205933 + HRESULT IDirect3DVolume9::FreePrivateData([In] const GUID& refguid) + IDirect3DVolume9::FreePrivateData +
+ + +

Provides access to the parent volume texture object, if this surface is a child level of a volume texture.

+
+

Reference identifier of the volume being requested.

+

Address of a reference to fill with the container reference, if the query succeeds.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

If the call succeeds, the reference count of the container is increased by one.

Here's an example getting the parent volume texture of a volume texture.

 // Assumes pSurface is a valid  reference	
+            void *pContainer = null;	
+             *pVolumeTexture = null;	
+             hr = pVolume->GetContainer(IID_IDirect3DVolumeTexture9, &pContainer);	
+            if (SUCCEEDED(hr) && pContainer)	
+            { pVolumeTexture = ( *)pContainer;	
+            
+
+ + bb205934 + HRESULT IDirect3DVolume9::GetContainer([In] const GUID& riid,[In] void** ppContainer) + IDirect3DVolume9::GetContainer +
+ + +

Retrieves a description of the volume.

+
+

Pointer to a structure, describing the volume.

+

If the method succeeds, the return value is . is returned if the argument is invalid.

+ + bb205935 + HRESULT IDirect3DVolume9::GetDesc([Out] D3DVOLUME_DESC* pDesc) + IDirect3DVolume9::GetDesc +
+ + +

Locks a box on a volume resource.

+
+

Pointer to a structure, describing the locked region.

+

Pointer to a box to lock. Specified by a reference to a structure. Specifying null for this parameter locks the entire volume.

+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For performance reasons, dirty regions are only recorded for level zero of a texture. Dirty regions are automatically recorded when is called without or . See for more information.

+
+ + bb205938 + HRESULT IDirect3DVolume9::LockBox([Out] D3DLOCKED_BOX* pLockedVolume,[In] const void* pBox,[In] D3DLOCK Flags) + IDirect3DVolume9::LockBox +
+ + +

Unlocks a box on a volume resource.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205940 + HRESULT IDirect3DVolume9::UnlockBox() + IDirect3DVolume9::UnlockBox +
+ + + Loads a volume from memory. + + Pointer to a structure, the destination palette of 256 colors or null. + Pointer to a structure. Specifies the destination box. Set this parameter to null to specify the entire volume. + Pointer to the top-left corner of the source volume in memory. + Member of the enumerated type, the pixel format of the source volume. + Pitch of source image, in bytes. For DXT formats (compressed texture formats), this number should represent the size of one row of cells, in bytes. + Pitch of source image, in bytes. For DXT formats (compressed texture formats), this number should represent the size of one slice of cells, in bytes. + Pointer to a structure, the source palette of 256 colors or null. + Pointer to a structure. Specifies the source box. null is not a valid value for this parameter. + A combination of one or more controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying | . + value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000. + If the function succeeds, the return value is . If the function fails, the return value can be one of the following values: , D3DXERR_INVALIDDATA. + + Writing to a non-level-zero surface of the volume texture will not cause the dirty rectangle to be updated. If is called and the texture was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call on the volume texture. + + HRESULT D3DXLoadVolumeFromMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcMemory,[In] D3DFORMAT SrcFormat,[In] unsigned int SrcRowPitch,[In] unsigned int SrcSlicePitch,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey) + + + + Loads a volume from a file on the disk. + + The volume. + Name of the file. + The filter. + The color key. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileW([In] IDirect3DVolume9* pDestVolume,[In] const PALETTEENTRY* pDestPalette,[In] const D3DBOX* pDestBox,[In] const wchar_t* pSrcFile,[In] const D3DBOX* pSrcBox,[In] unsigned int Filter,[In] D3DCOLOR ColorKey,[In] D3DXIMAGE_INFO* pSrcInfo) + + + + Loads a volume from a file on the disk. + + The volume. + Name of the file. + The filter. + The color key. + The source box. + The destination box. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileW([In] IDirect3DVolume9* pDestVolume,[In] const PALETTEENTRY* pDestPalette,[In] const D3DBOX* pDestBox,[In] const wchar_t* pSrcFile,[In] const D3DBOX* pSrcBox,[In] unsigned int Filter,[In] D3DCOLOR ColorKey,[In] D3DXIMAGE_INFO* pSrcInfo) + + + + Loads a volume from a file on the disk. + + The volume. + Name of the file. + The filter. + The color key. + The source box. + The destination box. + The image information. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileW([In] IDirect3DVolume9* pDestVolume,[In] const PALETTEENTRY* pDestPalette,[In] const D3DBOX* pDestBox,[In] const wchar_t* pSrcFile,[In] const D3DBOX* pSrcBox,[In] unsigned int Filter,[In] D3DCOLOR ColorKey,[In] D3DXIMAGE_INFO* pSrcInfo) + + + + Loads a volume from a file on the disk. + + The volume. + Name of the file. + The filter. + The color key. + The source box. + The destination box. + The palette. + The image information. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileW([In] IDirect3DVolume9* pDestVolume,[In] const PALETTEENTRY* pDestPalette,[In] const D3DBOX* pDestBox,[In] const wchar_t* pSrcFile,[In] const D3DBOX* pSrcBox,[In] unsigned int Filter,[In] D3DCOLOR ColorKey,[In] D3DXIMAGE_INFO* pSrcInfo) + + + + Loads a volume from a file in memory. + + The volume. + The memory. + The filter. + The color key. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a file in memory. + + The volume. + The memory. + The filter. + The color key. + The source box. + The destination box. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a file in memory. + + The volume. + The memory. + The filter. + The color key. + The source box. + The destination box. + The image information. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a file in memory. + + The volume. + The memory. + The filter. + The color key. + The source box. + The destination box. + The palette. + The image information. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a file in a strean. + + The volume. + The stream. + The filter. + The color key. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a file in a strean. + + The volume. + The stream. + The filter. + The color key. + The source box. + The destination box. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a file in a strean. + + The volume. + The stream. + The filter. + The color key. + The source box. + The destination box. + The image information. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a file in a strean. + + The volume. + The stream. + The filter. + The color key. + The source box. + The destination box. + The palette. + The image information. + A object describing the result of the operation. + HRESULT D3DXLoadVolumeFromFileInMemory([In] IDirect3DVolume9* pDestVolume,[Out, Buffer] const PALETTEENTRY* pDestPalette,[In] const void* pDestBox,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] const void* pSrcBox,[In] D3DX_FILTER Filter,[In] int ColorKey,[In] void* pSrcInfo) + + + + Loads a volume from a source volume. + + The destination volume. + The source volume. + The filter. + The color key. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromVolume([In] IDirect3DVolume9* pDestVolume,[In] const PALETTEENTRY* pDestPalette,[In] const D3DBOX* pDestBox,[In] IDirect3DVolume9* pSrcVolume,[In] const PALETTEENTRY* pSrcPalette,[In] const D3DBOX* pSrcBox,[In] unsigned int Filter,[In] D3DCOLOR ColorKey) + + + + Loads a volume from a source volume. + + The destination volume. + The source volume. + The filter. + The color key. + The source box. + The destination box. + + A object describing the result of the operation. + + HRESULT D3DXLoadVolumeFromVolume([In] IDirect3DVolume9* pDestVolume,[In] const PALETTEENTRY* pDestPalette,[In] const D3DBOX* pDestBox,[In] IDirect3DVolume9* pSrcVolume,[In] const PALETTEENTRY* pSrcPalette,[In] const D3DBOX* pSrcBox,[In] unsigned int Filter,[In] D3DCOLOR ColorKey) + + + + Loads a volume from a source volume. + + The destination volume. + The source volume. + The filter. + The color key. + The source box. + The destination box. + The destination palette. + The source palette. + A object describing the result of the operation. + HRESULT D3DXLoadVolumeFromVolume([In] IDirect3DVolume9* pDestVolume,[In] const PALETTEENTRY* pDestPalette,[In] const D3DBOX* pDestBox,[In] IDirect3DVolume9* pSrcVolume,[In] const PALETTEENTRY* pSrcPalette,[In] const D3DBOX* pSrcBox,[In] unsigned int Filter,[In] D3DCOLOR ColorKey) + + + + Locks a box on a volume resource. + + The flags. + + The locked region of this resource + + HRESULT IDirect3DVolume9::LockBox([Out] D3DLOCKED_BOX* pLockedVolume,[In] const void* pBox,[In] D3DLOCK Flags) + + + + Locks a box on a volume resource. + + The box. + The flags. + The locked region of this resource + HRESULT IDirect3DVolume9::LockBox([Out] D3DLOCKED_BOX* pLockedVolume,[In] const void* pBox,[In] D3DLOCK Flags) + + + + Saves a volume to a file on disk. + + The volume. + Name of the file. + The format. + + A object describing the result of the operation. + + HRESULT D3DXSaveVolumeToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In] const PALETTEENTRY* pSrcPalette,[In] const D3DBOX* pSrcBox) + + + + Saves a volume to a file on disk. + + The volume. + Name of the file. + The format. + The box. + + A object describing the result of the operation. + + HRESULT D3DXSaveVolumeToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In] const PALETTEENTRY* pSrcPalette,[In] const D3DBOX* pSrcBox) + + + + Saves a volume to a file on disk. + + The volume. + Name of the file. + The format. + The box. + The palette. + A object describing the result of the operation. + HRESULT D3DXSaveVolumeToFileW([In] const wchar_t* pDestFile,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In] const PALETTEENTRY* pSrcPalette,[In] const D3DBOX* pSrcBox) + + + + Saves a volume to a . + + The volume. + The format. + + A object describing the result of the operation. + + HRESULT D3DXSaveVolumeToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox) + + + + Saves a volume to a . + + The volume. + The format. + The box. + + A object describing the result of the operation. + + HRESULT D3DXSaveVolumeToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox) + + + + Saves a volume to a . + + The volume. + The format. + The box. + The palette. + A object describing the result of the operation. + HRESULT D3DXSaveVolumeToFileInMemory([In] ID3DXBuffer** ppDestBuf,[In] D3DXIMAGE_FILEFORMAT DestFormat,[In] IDirect3DVolume9* pSrcVolume,[In, Buffer] const PALETTEENTRY* pSrcPalette,[In] const void* pSrcBox) + + + +

Retrieves the device associated with a volume.

+
+ +

This method allows navigation to the owning device object.

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205936 + GetDevice + GetDevice + HRESULT IDirect3DVolume9::GetDevice([Out] IDirect3DDevice9** ppDevice) +
+ + +

Retrieves a description of the volume.

+
+ + bb205935 + GetDesc + GetDesc + HRESULT IDirect3DVolume9::GetDesc([Out] D3DVOLUME_DESC* pDesc) +
+ + +

Applications use the methods of the interface to manipulate a volume texture resource.

+
+ +

The interface can be obtained by calling the CreateVolumeTexture method or one of the xxx functions.

This interface inherits additional functionality from the interface.

This interface, like all COM interfaces, inherits from the interface.

The LPDIRECT3DVOLUMETEXTURE9 and PDIRECT3DVOLUMETEXTURE9 types are defined as references to the interface.

 typedef struct  *LPDIRECT3DVOLUMETEXTURE9, *PDIRECT3DVOLUMETEXTURE9;	
+            
+
+ + bb205941 + IDirect3DVolumeTexture9 + IDirect3DVolumeTexture9 +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves a level description of a volume texture resource.

+
+

Identifies a level of the volume texture resource. This method returns a volume description for the level specified by this parameter.

+

Pointer to a structure, describing the returned volume texture level.

+ + bb205943 + HRESULT IDirect3DVolumeTexture9::GetLevelDesc([In] unsigned int Level,[Out] D3DVOLUME_DESC* pDesc) + IDirect3DVolumeTexture9::GetLevelDesc +
+ + +

Retrieves the specified volume texture level.

+
+

Identifies a level of the volume texture resource. This method returns a volume for the level specified by this parameter.

+

Address of a reference to an interface, representing the returned volume level.

+ +

Calling this method will increase the internal reference count on the interface. Failure to call IUnknown::Release when finished using this interface results in a memory leak.

+
+ + bb205944 + HRESULT IDirect3DVolumeTexture9::GetVolumeLevel([In] unsigned int Level,[Out] IDirect3DVolume9** ppVolumeLevel) + IDirect3DVolumeTexture9::GetVolumeLevel +
+ + +

Locks a box on a volume texture resource.

+
+

Specifies the level of the volume texture resource to lock.

+

Pointer to a structure, describing the locked region.

+

Pointer to the volume to lock. This parameter is specified by a reference to a structure. Specifying null for this parameter locks the entire volume level.

+

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

For a description of the flags, see .

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For performance reasons, dirty regions are only recorded for level zero of a texture. Dirty regions are automatically recorded when LockBox is called without or . For more information, see UpdateTexture.

+
+ + bb205945 + HRESULT IDirect3DVolumeTexture9::LockBox([In] unsigned int Level,[Out] D3DLOCKED_BOX* pLockedVolume,[In] const void* pBox,[In] D3DLOCK Flags) + IDirect3DVolumeTexture9::LockBox +
+ + +

Unlocks a box on a volume texture resource.

+
+

Specifies the level of the volume texture resource to unlock.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ + bb205946 + HRESULT IDirect3DVolumeTexture9::UnlockBox([In] unsigned int Level) + IDirect3DVolumeTexture9::UnlockBox +
+ + +

Adds a dirty region to a volume texture resource.

+
+

Pointer to a structure, specifying the dirty region to add. Specifying null expands the dirty region to cover the entire volume texture.

+

If the method succeeds, the return value is . If the method fails, the return value can be .

+ +

For performance reasons, dirty regions are only recorded for level zero of a texture. For sublevels, it is assumed that the corresponding (scaled) box is also dirty. Dirty regions are automatically recorded when LockBox is called without or .

Using and explicitly specifying dirty regions can be used to increase the efficiency of UpdateTexture. Using this method, applications can optimize what subset of a resource is copied by specifying dirty boxes on the resource. However, the dirty regions may be expanded to optimize alignment.

+
+ + bb205942 + HRESULT IDirect3DVolumeTexture9::AddDirtyBox([In] const void* pDirtyBox) + IDirect3DVolumeTexture9::AddDirtyBox +
+ + + Initializes a new instance of the class. + + The device. + The width. + The height. + The depth. + The level count. + The usage. + The format. + The pool. + HRESULT IDirect3DDevice9::CreateVolumeTexture([In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Levels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DVolumeTexture9** ppVolumeTexture,[In] void** pSharedHandle) + + + + Initializes a new instance of the class. + + The device. + The width. + The height. + The depth. + The level count. + The usage. + The format. + The pool. + The shared handle. + HRESULT IDirect3DDevice9::CreateVolumeTexture([In] unsigned int Width,[In] unsigned int Height,[In] unsigned int Levels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[Out, Fast] IDirect3DVolumeTexture9** ppVolumeTexture,[In] void** pSharedHandle) + + + + Checks texture-creation parameters. + + Device associated with the texture. + The width. + The height. + The depth. + Requested number of mipmap levels for the texture. + The requested usage for the texture. + Requested format for the texture. + Memory class where the resource will be placed. + + A value type containing the proposed values to pass to the texture creation functions. + + HRESULT D3DXCheckVolumeTextureRequirements([In] IDirect3DDevice9* pDevice,[InOut] unsigned int* pWidth,[InOut] unsigned int* pHeight,[InOut] unsigned int* pDepth,[InOut] unsigned int* pNumMipLevels,[In] unsigned int Usage,[InOut] D3DFORMAT* pFormat,[In] D3DPOOL Pool) + + + + Uses a user-provided function to fill each texel of each mip level of a given texture. + + A function that is used to fill the texture. + A object describing the result of the operation. + HRESULT D3DXFillVolumeTexture([In] IDirect3DVolumeTexture9* pVolumeTexture,[In] __function__stdcall* pFunction,[In] void* pData) + + + + Uses a compiled high-level shader language (HLSL) function to fill each texel of each mipmap level of a texture. + + A texture shader object that is used to fill the texture. + A object describing the result of the operation. + HRESULT D3DXFillVolumeTextureTX([In] IDirect3DVolumeTexture9* pVolumeTexture,[In] ID3DXVolumeTextureShader* pVolumeTextureShader) + + + + Locks a box on a volume texture resource. + + The level. + The flags. + + A describing the region locked. + + HRESULT IDirect3DVolumeTexture9::LockBox([In] unsigned int Level,[Out] D3DLOCKED_BOX* pLockedVolume,[In] const void* pBox,[In] D3DLOCK Flags) + + + + Locks a box on a volume texture resource. + + The level. + The box. + The flags. + + A describing the region locked. + + HRESULT IDirect3DVolumeTexture9::LockBox([In] unsigned int Level,[Out] D3DLOCKED_BOX* pLockedVolume,[In] const void* pBox,[In] D3DLOCK Flags) + + + + Adds a dirty region to a texture resource. + + + A object describing the result of the operation. + + HRESULT IDirect3DVolumeTexture9::AddDirtyBox([In] const void* pDirtyBox) + + + + Adds a dirty region to a texture resource. + + The direct box ref. + + A object describing the result of the operation. + + HRESULT IDirect3DVolumeTexture9::AddDirtyBox([In] const void* pDirtyBox) + + + + Creates a from a file + + The device. + The filename. + + A + + HRESULT D3DXCreateVolumeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a file + + The device. + The filename. + The usage. + The pool. + + A + + HRESULT D3DXCreateVolumeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a file + + The device. + The filename. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateVolumeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a file + + The device. + The filename. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateVolumeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a file + + The device. + The filename. + The width. + The height. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateVolumeTextureFromFileExW([In] IDirect3DDevice9* pDevice,[In] const wchar_t* pSrcFile,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[In] void* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The usage. + The pool. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The width. + The height. + The depth. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The width. + The height. + The depth. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a memory buffer. + + The device. + The buffer. + The width. + The height. + The depth. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The stream. + A + HRESULT D3DXCreateVolumeTextureFromFileInMemory([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The usage. + The pool. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The width. + The height. + The depth. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The buffer. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The stream. + The size bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + A + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + The pointer. + The size in bytes. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + + Creates a from a stream. + + The device. + Name of the file. + The size. + The level count. + The usage. + The format. + The pool. + The filter. + The mip filter. + The color key. + The image information. + The palette. + + A + + HRESULT D3DXCreateVolumeTextureFromFileInMemoryEx([In] IDirect3DDevice9* pDevice,[In] const void* pSrcData,[In] unsigned int SrcDataSize,[In] unsigned int Size,[In] unsigned int MipLevels,[In] unsigned int Usage,[In] D3DFORMAT Format,[In] D3DPOOL Pool,[In] unsigned int Filter,[In] unsigned int MipFilter,[In] D3DCOLOR ColorKey,[Out] D3DXIMAGE_INFO* pSrcInfo,[Out, Buffer] PALETTEENTRY* pPalette,[In] IDirect3DVolumeTexture9** ppVolumeTexture) + + + +

Applications use the methods of the interface to create instances of the and interfaces, and to register templates.

+
+ +

An object also contains a local template store. This local storage may be added to only with the and methods.

and objects created with and also utilize the template store of the parent object.

The interface is obtained by calling the function.

The globally unique identifier () for the interface is IID_ID3DXFile.

The LPD3DXFILE type is defined as a reference to the interface.

 typedef interface  *LPD3DXFILE;	
+            
+
+ + bb205836 + ID3DXFile + ID3DXFile +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Creates an enumerator object that will read a .x file.

+
+

The data source. Either:

  • A file name
  • A D3DXF_FILELOADMEMORY structure
  • A D3DXF_FILELOADRESOURCE structure

Depending on the value of loadflags.

+

Value that specifies the source of the data. This value can be one of the D3DXF_FILELOADOPTIONS flags.

+

Address of a reference to an interface, representing the created enumerator object.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADVALUE, D3DXFERR_PARSEERROR.

+ +

After using this method, use one of the methods to retrieve a data object.

+
+ + bb173957 + HRESULT ID3DXFile::CreateEnumObject([In] const void* arg0,[In] unsigned int arg1,[In] ID3DXFileEnumObject** arg2) + ID3DXFile::CreateEnumObject +
+ + +

Creates a save object that will be used to save data to a .x file.

+
+

Pointer to the name of the file to use for saving data.

+

Value that specifies the name of the file to which data is to be saved. This value can be one of the File Save Options flags.

+

Indicates the format to use when saving the .x file. This value can be one of the File Formats flags. For more information, see Remarks.

+

Address of a reference to an interface, representing the created save object.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADVALUE, D3DXFERR_PARSEERROR.

+ +

After using this method, use methods of the interface to create data objects and to save templates or data.

For the saved file format dwFileFormat, one of the binary, legacy binary, or text flags in File Formats must be specified. The file can be compressed by using the optional flag.

The file format values can be combined in a logical OR to create compressed text or compressed binary files. If you indicate that the file format should be text and compressed, the file will be written out first as text and then compressed. However, compressed text files are not as efficient as binary text files; in most cases, therefore, you will want to indicate binary and compressed.

+
+ + bb173958 + HRESULT ID3DXFile::CreateSaveObject([In] const void* arg0,[In] unsigned int arg1,[In] unsigned int arg2,[In] ID3DXFileSaveObject** arg3) + ID3DXFile::CreateSaveObject +
+ + +

Registers custom templates.

+
+

Pointer to a buffer consisting of a .x file in text or binary format that contains templates.

+

Size of the buffer pointed to by pvData, in bytes.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADVALUE, D3DXFERR_PARSEERROR.

+ +

The following code fragment provides an example call to RegisterTemplates And example contents for the buffer to which pvData points.

 #define XSKINEXP_TEMPLATES \ "xof 0303txt 0032\ template XSkinMeshHeader \ { \ <3CF169CE-FF7C-44ab-93C0-F78F62D172E2> \ WORD nMaxSkinWeightsPerVertex; \ WORD nMaxSkinWeightsPerFace; \ WORD nBones; \ } \ template VertexDuplicationIndices \ { \ <B8D65549-D7C9-4995-89CF-53A9A8B031E3> \ DWORD nIndices; \ DWORD nOriginalVertices; \ array DWORD indices[nIndices]; \ } \ template SkinWeights \ { \ <6F0D123B-BAD2-4167-A0D0-80224F25FABB> \ STRING transformNodeName;\ DWORD nWeights; \ array DWORD vertexIndices[nWeights]; \ array float weights[nWeights]; \ Matrix4x4 matrixOffset; \ }"	
+            .	
+            .	
+            . LPD3DXFILE pD3DXFile = null; if ( FAILED  (hr = pD3DXFile->RegisterTemplates(  (LPVOID)XSKINEXP_TEMPLATES, sizeof( XSKINEXP_TEMPLATES ) - 1 ) ) )	
+            goto End;	
+            

All templates must specify a name and a UUID.

This method calls the RegisterEnumTemplates method, obtaining an interface reference by calling CreateEnumObject with pvData as the first parameter.

+
+ + bb173960 + HRESULT ID3DXFile::RegisterTemplates([In] const void* arg0,[In] SIZE_T arg1) + ID3DXFile::RegisterTemplates +
+ + +

Registers custom templates, given an enumeration object.

+
+ No documentation. +

If the method succeeds, the return value is .

If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ +

When this method is called, it copies templates stored with the , representing the file, to the local template store of the object.

If an reference is not available, call the RegisterTemplates method instead.

+
+ + bb173959 + HRESULT ID3DXFile::RegisterEnumTemplates([In] ID3DXFileEnumObject* arg0) + ID3DXFile::RegisterEnumTemplates +
+ + +

Applications use the methods of the interface to build or to access the immediate hierarchy of the data object. Template restrictions determine the hierarchy.

+
+ +

Data types allowed by the template are called optional members. The optional members are not required, but an object might miss important information without them. These optional members are saved as children of the data object. A child can be another data object or a reference to an earlier data object.

The for the interface is IID_ID3DXFileData.

The LPD3DXFILEDATA type is defined as a reference to this interface.

 typedef interface  *LPD3DXFILEDATA;	
+            
+
+ + bb205837 + ID3DXFileData + ID3DXFileData +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the enumeration object in this file data object.

+
+

Address of a reference to receive the enumeration object in this file data object.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb205840 + HRESULT ID3DXFileData::GetEnum([Out] ID3DXFileEnumObject** arg0) + ID3DXFileData::GetEnum +
+ + +

Retrieves the name of this file data object.

+
+

Address of a reference to receive the name of this file data object. If this parameter is null, then puiSize will return the size of the string. If szName points to valid memory, the name of this file data object will be copied into szName up to the number of characters given by puiSize.

+

Pointer to the size of the string that represents the name of this file data object. This parameter can be null if szName provides a reference to the name. This parameter will return the size of the string if szName is null.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ +

For this method to succeed, either szName or puiSize must be non-null.

+
+ + bb205842 + HRESULT ID3DXFileData::GetName([In] char* arg0,[Out] SIZE_T* arg1) + ID3DXFileData::GetName +
+ + +

Retrieves the of this file data object.

+
+

Pointer to a to receive the ID of this file data object. If the file data object has no ID, the returned parameter value will be GUID_NULL.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb205841 + HRESULT ID3DXFileData::GetId([In] GUID* arg0) + ID3DXFileData::GetId +
+ + +

Accesses the .x file data.

+
+

Pointer to the size of the .x file data.

+

Address of a reference to receive the file data object's interface reference. See Remarks.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ +

The ppData reference is only valid during a ... sequence. You can make multiple lock calls. However, you must ensure that the number of lock calls matches the number of unlock calls.

Because file data is not guaranteed to be aligned properly with byte boundaries, you should access ppData with UNALIGNED references.

Returned parameter values are not guaranteed to be valid due to possible file corruption; therefore, your code should verify the returned parameter values.

+
+ + bb205845 + HRESULT ID3DXFileData::Lock([In] SIZE_T* arg0,[In] const void** arg1) + ID3DXFileData::Lock +
+ + +

Ends the lifespan of the ppData reference returned by .

+
+

The return value is .

+ +

You must ensure that the number of calls matches the number of calls. After calling Unlock, the ppData reference returned by should no longer be used.

+
+ + bb205846 + HRESULT ID3DXFileData::Unlock() + ID3DXFileData::Unlock +
+ + +

Retrieves the template ID in this file data object.

+
+

Pointer to the representing the template in this file data object.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb205843 + HRESULT ID3DXFileData::GetType([Out] GUID* arg0) + ID3DXFileData::GetType +
+ + +

Indicates whether this file data object is a reference object that points to another child data object.

+
+

Returns TRUE if the file data object is a reference object; returns otherwise.

+ + bb205844 + BOOL ID3DXFileData::IsReference() + ID3DXFileData::IsReference +
+ + +

Retrieves the number of children in this file data object.

+
+

Address of a reference to receive the number of children in this file data object.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb205839 + HRESULT ID3DXFileData::GetChildren([Out] SIZE_T* arg0) + ID3DXFileData::GetChildren +
+ + +

Retrieves a child object in this file data object.

+
+

ID of the child object to retrieve.

+

Address of a reference to receive the child object's interface reference.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following values: D3DXFERR_BADVALUE, D3DXFERR_NOMOREOBJECTS.

+ + bb205838 + HRESULT ID3DXFileData::GetChild([In] SIZE_T arg0,[Out] ID3DXFileData** arg1) + ID3DXFileData::GetChild +
+ + +

Retrieves the enumeration object in this file data object.

+
+ + bb205840 + GetEnum + GetEnum + HRESULT ID3DXFileData::GetEnum([Out] ID3DXFileEnumObject** arg0) +
+ + +

Retrieves the template ID in this file data object.

+
+ + bb205843 + GetType + GetType + HRESULT ID3DXFileData::GetType([Out] GUID* arg0) +
+ + +

Indicates whether this file data object is a reference object that points to another child data object.

+
+ + bb205844 + IsReference + IsReference + BOOL ID3DXFileData::IsReference() +
+ + +

Retrieves the number of children in this file data object.

+
+ + bb205839 + GetChildren + GetChildren + HRESULT ID3DXFileData::GetChildren([Out] SIZE_T* arg0) +
+ + +

Applications use the methods of the interface to cycle through the child file data objects in the file and to retrieve a child object by its globally unique identifier () or by its name.

+
+ +

The for the interface is IID_ID3DXFileEnumObject.

The LPD3DXFILEENUMOBJECT type is defined as a reference to this interface.

 typedef interface  *LPD3DXFILEENUMOBJECT;	
+            
+
+ + bb205847 + ID3DXFileEnumObject + ID3DXFileEnumObject +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves the object.

+
+ No documentation. +

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb205852 + HRESULT ID3DXFileEnumObject::GetFile([Out] ID3DXFile** arg0) + ID3DXFileEnumObject::GetFile +
+ + +

Retrieves the number of child objects in this file data object.

+
+

Address of a reference to receive the number of child objects in this file data object.

+

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb205849 + HRESULT ID3DXFileEnumObject::GetChildren([Out] SIZE_T* arg0) + ID3DXFileEnumObject::GetChildren +
+ + +

Retrieves a child object in this file data object.

+
+

ID of the child object to retrieve.

+

Address of a reference to receive the child object's interface reference.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADVALUE, D3DXFERR_NOMOREOBJECTS.

+ + Bb205848 + HRESULT ID3DXFileEnumObject::GetChild([In] SIZE_T arg0,[Out] ID3DXFileData** arg1) + ID3DXFileEnumObject::GetChild +
+ + +

Retrieves the data object that has the specified .

+
+

Reference to the requested .

+

Address of a reference to an interface, representing the returned file data object.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following:DXFILEERR_BADVALUE, DXFILEERR_NOTFOUND.

+ +

Obtain the rguid of the current file data object with the method.

+
+ + bb205850 + HRESULT ID3DXFileEnumObject::GetDataObjectById([In] const GUID& arg0,[In] ID3DXFileData** arg1) + ID3DXFileEnumObject::GetDataObjectById +
+ + +

Retrieves the data object that has the specified name.

+
+

Pointer to the requested name.

+

Address of a reference to an interface, representing the returned file data object.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following:DXFILEERR_BADVALUE, DXFILEERR_NOTFOUND.

+ +

Obtain the name szName of the current file data object with the method.

+
+ + bb205851 + HRESULT ID3DXFileEnumObject::GetDataObjectByName([In] const char* arg0,[In] ID3DXFileData** arg1) + ID3DXFileEnumObject::GetDataObjectByName +
+ + +

Retrieves the object.

+
+ + bb205852 + GetFile + GetFile + HRESULT ID3DXFileEnumObject::GetFile([Out] ID3DXFile** arg0) +
+ + +

Retrieves the number of child objects in this file data object.

+
+ + bb205849 + GetChildren + GetChildren + HRESULT ID3DXFileEnumObject::GetChildren([Out] SIZE_T* arg0) +
+ + +

Applications use the methods of the interface to add data objects as children of a .x file data node.

+
+ +

The for the interface is IID_ID3DXFileSaveObject.

The LPD3DXFileSaveData type is defined as a reference to this interface.

 typedef interface  *LPD3DXFILESAVEDATA;	
+            
+
+ + bb205853 + ID3DXFileSaveData + ID3DXFileSaveData +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Retrieves a reference to this file data node.

+
+ No documentation. +

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb173951 + HRESULT ID3DXFileSaveData::GetSave([Out] ID3DXFileSaveObject** arg0) + ID3DXFileSaveData::GetSave +
+ + +

Retrieves the name of this file data node.

+
+ No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ +

For this method to succeed, either szName or puiSize must be non-null.

+
+ + bb173950 + HRESULT ID3DXFileSaveData::GetName([In] char* arg0,[Out] SIZE_T* arg1) + ID3DXFileSaveData::GetName +
+ + +

Retrieves the of this file data node.

+
+ No documentation. +

If the method succeeds, the return value is . If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

+ + bb205856 + HRESULT ID3DXFileSaveData::GetId([In] GUID* arg0) + ID3DXFileSaveData::GetId +
+ + +

Retrieves the template ID of this file data node.

+
+

Pointer to the representing the template in this file data node.

+

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADOBJECT, D3DXFERR_BADVALUE.

+ + bb173952 + HRESULT ID3DXFileSaveData::GetType([Out] GUID* arg0) + ID3DXFileSaveData::GetType +
+ + +

Adds a data object as a child of the file data node.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADOBJECT, D3DXFERR_BADVALUE, E_OUTOFMEMORY.

+ + bb205854 + HRESULT ID3DXFileSaveData::AddDataObject([In] const GUID& arg0,[In] const char* arg1,[In] const GUID* arg2,[In] SIZE_T arg3,[In] const void* arg4,[In] ID3DXFileSaveData** arg5) + ID3DXFileSaveData::AddDataObject +
+ + +

Adds a data reference as a child of this file data node. The data reference points to a file data object.

+
+ No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADOBJECT, D3DXFERR_BADVALUE, E_OUTOFMEMORY.

+ +

The file data object being referenced must have either a name or a . The file data object must also derive from a different parent object.

+
+ + bb205855 + HRESULT ID3DXFileSaveData::AddDataReference([In] const char* arg0,[In] const GUID* arg1) + ID3DXFileSaveData::AddDataReference +
+ + +

Retrieves a reference to this file data node.

+
+ + bb173951 + GetSave + GetSave + HRESULT ID3DXFileSaveData::GetSave([Out] ID3DXFileSaveObject** arg0) +
+ + +

Retrieves the template ID of this file data node.

+
+ + bb173952 + GetType + GetType + HRESULT ID3DXFileSaveData::GetType([Out] GUID* arg0) +
+ + +

Applications use the methods of the interface to write a .x file to disk, and to add and save data objects and templates.

+
+ +

Templates are not required in every file. For example, you could put all templates into a single .x file rather than duplicating them in every .x file.

The interface is obtained by calling the method.

The globally unique identifier () for the interface is IID_ID3DXFileSaveObject.

The LPD3DXFILESAVEOBJECT type is defined as a reference to this interface.

 typedef interface  *LPD3DXFILESAVEOBJECT;	
+            
+
+ + bb173953 + ID3DXFileSaveObject + ID3DXFileSaveObject +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Gets the interface of the object that created this object.

+
+ No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADVALUE, E_NOINTERFACE, E_POINTER.

+ + bb173955 + HRESULT ID3DXFileSaveObject::GetFile([Out] ID3DXFile** arg0) + ID3DXFileSaveObject::GetFile +
+ + +

Adds a data object as a child of the object.

+
+ No documentation. + No documentation. + No documentation. + No documentation. + No documentation. + No documentation. +

If the method succeeds, the return value is . If the method fails, the return value can be one of the following: D3DXFERR_BADOBJECT, DXFILEERR_BADVALUE, E_OUTOFMEMORY.

+ +

If a data reference object will reference the data object, either the szName or pId parameter must be non-null.

Save the created data to disk by using the method.

+
+ + bb173954 + HRESULT ID3DXFileSaveObject::AddDataObject([In] const GUID& arg0,[In] const char* arg1,[In] const GUID* arg2,[In] SIZE_T arg3,[In] const void* arg4,[In] ID3DXFileSaveData** arg5) + ID3DXFileSaveObject::AddDataObject +
+ + +

Saves a data object and its children to a .x file on disk.

+
+

If the method succeeds, the return value is . If the method fails, the return value can be the following: D3DXFERR_BADOBJECT.

+ +

After this method succeeds, , and can no longer be called until a new object is created.

+
+ + bb173956 + HRESULT ID3DXFileSaveObject::Save() + ID3DXFileSaveObject::Save +
+ + +

Gets the interface of the object that created this object.

+
+ + bb173955 + GetFile + GetFile + HRESULT ID3DXFileSaveObject::GetFile([Out] ID3DXFile** arg0) +
+ + +

Stores an attribute table entry.

+
+ +

An attribute table is used to identify areas of the mesh that need to be drawn with different textures, render states, materials, and so on. In addition, the application can use the attribute table to hide portions of a mesh by not drawing a given attribute identifier (AttribId) when drawing the frame.

The LPD3DXATTRIBUTERANGE type is defined as a reference to the structure.

 typedef * LPD3DXATTRIBUTERANGE;	
+            
+
+ + bb172710 + D3DXATTRIBUTERANGE + D3DXATTRIBUTERANGE +
+ + +

Attribute table identifier.

+
+ + bb172710 + unsigned int AttribId + unsigned int AttribId +
+ + +

Starting face.

+
+ + bb172710 + unsigned int FaceStart + unsigned int FaceStart +
+ + +

Face count.

+
+ + bb172710 + unsigned int FaceCount + unsigned int FaceCount +
+ + +

Starting vertex.

+
+ + bb172710 + unsigned int VertexStart + unsigned int VertexStart +
+ + +

Vertex count.

+
+ + bb172710 + unsigned int VertexCount + unsigned int VertexCount +
+ + +

Specifies mesh weight attributes.

+
+ +

This structure describes how a simplification operation will consider vertex data when calculating relative costs between collapsing edges. For example, if the Normal field is 0.0, the simplification operation will ignore the vertex normal component when calculating the error for the collapse. However, if the Normal field is 1.0, the simplification operation will use the vertex normal component. If the Normal field is 2.0, double the amount of errors; if the Normal field is 4.0, then quadruple the number of errors, and so on.

The LPD3DXATTRIBUTEWEIGHTS type is defined as a reference to the structure.

 typedef * LPD3DXATTRIBUTEWEIGHTS;	
+            
+
+ + bb172711 + D3DXATTRIBUTEWEIGHTS + D3DXATTRIBUTEWEIGHTS +
+ + +

Position.

+
+ + bb172711 + float Position + float Position +
+ + +

Blend weight.

+
+ + bb172711 + float Boundary + float Boundary +
+ + +

Normal.

+
+ + bb172711 + float Normal + float Normal +
+ + +

Diffuse lighting value.

+
+ + bb172711 + float Diffuse + float Diffuse +
+ + +

Specular lighting value.

+
+ + bb172711 + float Specular + float Specular +
+ + +

Tangent.

+
+ + bb172711 + float Tangent + float Tangent +
+ + +

Binormal.

+
+ + bb172711 + float Binormal + float Binormal +
+ + +

Eight texture coordinates.

+
+ + bb172711 + float Texcoord[8] + float Texcoord +
+ + +

Throughput metrics for help in understanding the performance of an application.

+
+ + bb172539 + D3DDEVINFO_D3D9BANDWIDTHTIMINGS + D3DDEVINFO_D3D9BANDWIDTHTIMINGS +
+ + +

The bandwidth or maximum data transfer rate from the host CPU to the GPU. This is typically the bandwidth of the PCI or AGP bus which connects the CPU and the GPU.

+
+ + bb172539 + float MaxBandwidthUtilized + float MaxBandwidthUtilized +
+ + +

Memory utilized percentage when uploading data from the host CPU to the GPU.

+
+ + bb172539 + float FrontEndUploadMemoryUtilizedPercent + float FrontEndUploadMemoryUtilizedPercent +
+ + +

Vertex throughput percentage. This is the number of vertices processed compared to the theoretical maximum vertex processing rate.

+
+ + bb172539 + float VertexRateUtilizedPercent + float VertexRateUtilizedPercent +
+ + +

Triangle set-up throughput percentage. This is the number of triangles that are set up for rasterization compared to the theoretical maximum triangle set-up rate.

+
+ + bb172539 + float TriangleSetupRateUtilizedPercent + float TriangleSetupRateUtilizedPercent +
+ + +

Pixel fill throughput percentage. This is the number of pixels that are filled compared to the theoretical pixel fill.

+
+ + bb172539 + float FillRateUtilizedPercent + float FillRateUtilizedPercent +
+ + +

Defines a volume.

+
+ +

includes the left, top, and front edges; however, the right, bottom, and back edges are not included. For example, a box that is 100 units wide and begins at 0 (thus, including the points up to and including 99) would be expressed with a value of 0 for the Left member and a value of 100 for the Right member. Note that a value of 99 is not used for the Right member.

The restrictions on side ordering observed for are left to right, top to bottom, and front to back.

+
+ + bb172510 + D3DBOX + D3DBOX +
+ + +

Position of the left side of the box on the x-axis.

+
+ + bb172510 + unsigned int Left + unsigned int Left +
+ + +

Position of the top of the box on the y-axis.

+
+ + bb172510 + unsigned int Top + unsigned int Top +
+ + +

Position of the right side of the box on the x-axis.

+
+ + bb172510 + unsigned int Right + unsigned int Right +
+ + +

Position of the bottom of the box on the y-axis.

+
+ + bb172510 + unsigned int Bottom + unsigned int Bottom +
+ + +

Position of the front of the box on the z-axis.

+
+ + bb172510 + unsigned int Front + unsigned int Front +
+ + +

Position of the back of the box on the z-axis.

+
+ + bb172510 + unsigned int Back + unsigned int Back +
+ + +

Measure the cache hit rate performance for textures and indexed vertices.

+
+ +

An efficient cache is typically closer to a 90 percent hit rate, and an inefficient cache is typically closer to a 10 percent hit rate (although a low percentage is not necessarily a problem).

+
+ + bb172540 + D3DDEVINFO_D3D9CACHEUTILIZATION + D3DDEVINFO_D3D9CACHEUTILIZATION +
+ + +

The hit rate for finding a texture in the texture cache. This assumes there is a texture cache. Increasing the level-of-detail bias to use the most detailed texture, using many large textures, or producing a near random texture access pattern on large textures with custom shader code can dramatically affect the texture cache hit rate.

+
+ + bb172540 + float TextureCacheHitRate + float TextureCacheHitRate +
+ + +

The hit rate for finding transformed vertices in the vertex cache. The GPU is designed to transform indexed vertices and may store them in a vertex cache. If you are using meshes, or may result in better vertex cache utilization.

+
+ + bb172540 + float PostTransformVertexCacheHitRate + float PostTransformVertexCacheHitRate +
+ + +

Describes a callback key for use in key frame animation.

+
+ + bb172886 + D3DXKEY_CALLBACK + D3DXKEY_CALLBACK +
+ + +

Key frame time stamp.

+
+ + bb172886 + float Time + float Time +
+ + +

Pointer to user callback data.

+
+ + bb172886 + void* pCallbackData + void pCallbackData +
+ + +

Describes the current clip status.

+
+ +

When clipping is enabled during vertex processing (by ProcessVertices, DrawPrimitive, or other drawing functions), Direct3D computes a clip code for every vertex. The clip code is a combination of D3DCS_* bits. When a vertex is outside a particular clipping plane, the corresponding bit is set in the clipping code. Direct3D maintains the clip status using , which has ClipUnion and ClipIntersection members. ClipUnion is a bitwise OR of all vertex clip codes and ClipIntersection is a bitwise AND of all vertex clip codes. Initial values are zero for ClipUnion and 0xFFFFFFFF for ClipIntersection. When is set to , ClipUnion and ClipIntersection are set to zero. Direct3D updates the clip status during drawing calls. To compute clip status for a particular object, set ClipUnion and ClipIntersection to their initial value and continue drawing.

Clip status is not updated by DrawRectPatch and DrawTriPatch because there is no software emulation for them.

+
+ + bb172516 + D3DCLIPSTATUS9 + D3DCLIPSTATUS9 +
+ + +

Clip union flags that describe the current clip status. This member can be one or more of the following flags:

ValueMeaning

Combination of all clip flags.

All vertices are clipped by the left plane of the viewing frustum.

All vertices are clipped by the right plane of the viewing frustum.

All vertices are clipped by the top plane of the viewing frustum.

All vertices are clipped by the bottom plane of the viewing frustum.

All vertices are clipped by the front plane of the viewing frustum.

All vertices are clipped by the back plane of the viewing frustum.

Application-defined clipping planes.

Application-defined clipping planes.

Application-defined clipping planes.

Application-defined clipping planes.

Application-defined clipping planes.

Application-defined clipping planes.

?

+
+ + bb172516 + unsigned int ClipUnion + unsigned int ClipUnion +
+ + +

Clip intersection flags that describe the current clip status. This member can take the same flags as ClipUnion.

+
+ + bb172516 + unsigned int ClipIntersection + unsigned int ClipIntersection +
+ + +

A description of a constant in a constant table.

+
+ + bb172748 + D3DXCONSTANT_DESC + D3DXCONSTANT_DESC +
+ + +

Name of the constant.

+
+ + bb172748 + const char* Name + char Name +
+ + +

Constant data type. See .

+
+ + bb172748 + D3DXREGISTER_SET RegisterSet + D3DXREGISTER_SET RegisterSet +
+ + +

Zero-based index of the constant in the table.

+
+ + bb172748 + unsigned int RegisterIndex + unsigned int RegisterIndex +
+ + +

Number of registers that contain data.

+
+ + bb172748 + unsigned int RegisterCount + unsigned int RegisterCount +
+ + +

Parameter class. See .

+
+ + bb172748 + D3DXPARAMETER_CLASS Class + D3DXPARAMETER_CLASS Class +
+ + +

Parameter type. See .

+
+ + bb172748 + D3DXPARAMETER_TYPE Type + D3DXPARAMETER_TYPE Type +
+ + +

Number of rows.

+
+ + bb172748 + unsigned int Rows + unsigned int Rows +
+ + +

Number of columns.

+
+ + bb172748 + unsigned int Columns + unsigned int Columns +
+ + +

Number of elements in the array.

+
+ + bb172748 + unsigned int Elements + unsigned int Elements +
+ + +

Number of structure member sub-parameters.

+
+ + bb172748 + unsigned int StructMembers + unsigned int StructMembers +
+ + +

Data size in number of bytes.

+
+ + bb172748 + unsigned int Bytes + unsigned int Bytes +
+ + +

Pointer to the default value.

+
+ + bb172748 + const void* DefaultValue + void DefaultValue +
+ + +

A description of the constant table.

+
+ + bb172747 + D3DXCONSTANTTABLE_DESC + D3DXCONSTANTTABLE_DESC +
+ + +

Name of the constant table creator.

+
+ + bb172747 + const char* Creator + char Creator +
+ + +

Shader version.

+
+ + bb172747 + unsigned int Version + unsigned int Version +
+ + +

Number of constants in the constant table.

+
+ + bb172747 + unsigned int Constants + unsigned int Constants +
+ + +

Describes the creation parameters for a device.

+
+ + bb172538 + D3DDEVICE_CREATION_PARAMETERS + D3DDEVICE_CREATION_PARAMETERS +
+ + +

Ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter. Use this ordinal as the Adapter parameter for any of the methods. Note that different instances of Direct3D 9.0 objects can use different ordinals. Adapters can enter or leave a system when users, for example, add or remove monitors from a multiple-monitor system or when they hot-swap a laptop. Consequently, use this ordinal only in a Direct3D 9.0 instance known to be valid, that is, either the Direct3D 9.0 that created this interface or the Direct3D 9.0 returned from GetDirect3D, as called through this interface.

+
+ + bb172538 + unsigned int AdapterOrdinal + unsigned int AdapterOrdinal +
+ + +

Member of the enumerated type. Denotes the amount of emulated functionality for this device. The value of this parameter mirrors the value passed to the CreateDevice call that created this device.

+
+ + bb172538 + D3DDEVTYPE DeviceType + D3DDEVTYPE DeviceType +
+ + +

Window handle to which focus belongs for this Direct3D device. The value of this parameter mirrors the value passed to the CreateDevice call that created this device.

+
+ + bb172538 + HWND hFocusWindow + HWND hFocusWindow +
+ + +

A combination of one or more constants that control global behavior of the device. These constants mirror the constants passed to CreateDevice when the device was created.

+
+ + bb172538 + unsigned int BehaviorFlags + unsigned int BehaviorFlags +
+ + +

Specifies types of display modes to filter out.

+
+ + bb172550 + D3DDISPLAYMODEFILTER + D3DDISPLAYMODEFILTER +
+ + +

The size of this structure. This should always be set to sizeof().

+
+ + bb172550 + unsigned int Size + unsigned int Size +
+ + +

The display mode format to filter out. See .

+
+ + bb172550 + D3DFORMAT Format + D3DFORMAT Format +
+ + +

Whether the scanline ordering is interlaced or progressive. See .

+
+ + bb172550 + D3DSCANLINEORDERING ScanLineOrdering + D3DSCANLINEORDERING ScanLineOrdering +
+ + + No documentation. + + + bb280317 + D3DXEFFECT_DESC + D3DXEFFECT_DESC + + + + No documentation. + + + const char* Creator + char Creator + + + + No documentation. + + + unsigned int Parameters + unsigned int Parameters + + + + No documentation. + + + unsigned int Techniques + unsigned int Techniques + + + + No documentation. + + + unsigned int Functions + unsigned int Functions + + + +

Describes an animation event.

+
+ + bb172826 + D3DXEVENT_DESC + D3DXEVENT_DESC +
+ + +

Event type, as defined in .

+
+ + bb172826 + D3DXEVENT_TYPE Type + D3DXEVENT_TYPE Type +
+ + +

Event track identifier.

+
+ + bb172826 + unsigned int Track + unsigned int Track +
+ + +

Start time of the event in global time.

+
+ + bb172826 + double StartTime + double StartTime +
+ + +

Duration of the event in global time.

+
+ + bb172826 + double Duration + double Duration +
+ + +

Transition style of the event, as defined in .

+
+ + bb172826 + D3DXTRANSITION_TYPE Transition + D3DXTRANSITION_TYPE Transition +
+ + +

Track weight for the event.

+
+ + bb172826 + float Weight + float Weight +
+ + +

Track speed for the event.

+
+ + bb172826 + float Speed + float Speed +
+ + +

Track position for the event.

+
+ + bb172826 + double Position + double Position +
+ + +

Enable flag.

+
+ + bb172826 + BOOL Enable + BOOL Enable +
+ + +

Returns material information saved in Direct3D (.x) files.

+
+ +

The and functions return an array of structures that specify the material color and name of the texture for each material in the mesh. The application is then required to load the texture.

The LPD3DXMATERIAL type is defined as a reference to the structure.

 typedef struct * LPD3DXMATERIAL;	
+            
+
+ + bb172911 + D3DXMATERIAL + D3DXMATERIAL +
+ + +

structure that describes the material properties.

+
+ + bb172911 + D3DMATERIAL9 MatD3D + D3DMATERIAL9 MatD3D +
+ + +

Pointer to a string that specifies the file name of the texture.

+
+ + bb172911 + char* pTextureFilename + char pTextureFilename +
+ + +

Defines the attributes of a font.

+
+ +

The compiler setting also determines the structure type. If Unicode is defined, the structure type resolves to a ; otherwise the structure type resolves to a D3DXFONT_DESCA.

Possible values of the above members are given in the GDI structure.

+
+ + bb172843 + D3DXFONT_DESCW + D3DXFONT_DESCW +
+ + +

Height, in logical units, of the font's character cell or character.

+
+ + bb172843 + int Height + int Height +
+ + +

Width, in logical units, of characters in the font.

+
+ + bb172843 + unsigned int Width + unsigned int Width +
+ + +

Weight of the font in the range from 0 through 1000.

+
+ + bb172843 + D3DX9_FONT_WEIGHT Weight + D3DX9_FONT_WEIGHT Weight +
+ + +

Number of mip levels requested. If this value is zero or D3DX_DEFAULT, a complete mipmap chain is created. If the value is 1, the texture space is mapped identically to the screen space.

+
+ + bb172843 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

Set to TRUE for an Italic font.

+
+ + bb172843 + BOOL Italic + BOOL Italic +
+ + +

Character set.

+
+ + bb172843 + D3DX9_FONT_CHARSET CharSet + D3DX9_FONT_CHARSET CharSet +
+ + +

Output precision. The output precision defines how closely the output must match the requested font height, width, character orientation, escapement, pitch, and font type.

+
+ + bb172843 + D3DX9_FONT_PRECISION OutputPrecision + D3DX9_FONT_PRECISION OutputPrecision +
+ + +

Output quality.

+
+ + bb172843 + D3DX9_FONT_QUALITY Quality + D3DX9_FONT_QUALITY Quality +
+ + +

Pitch and family of the font.

+
+ + bb172843 + D3DX9_FONT_PITCHFAMILY PitchAndFamily + D3DX9_FONT_PITCHFAMILY PitchAndFamily +
+ + +

A null-terminated string or characters that specifies the typeface name of the font. The length of the string must not exceed 32 characters, including the terminating null character. If FaceName is an empty string, the first font that matches the other specified attributes will be used. If the compiler settings require Unicode, the data type TCHAR resolves to WCHAR; otherwise, the data type resolves to CHAR. See Remarks.

+
+ + bb172843 + wchar_t FaceName[32] + wchar_t FaceName +
+ + +

Encapsulates a transform frame in a transformation frame hierarchy.

+
+ +

An application can derive from this structure to add other data.

+
+ + bb172845 + D3DXFRAME + D3DXFRAME +
+ + +

Name of the frame.

+
+ + bb172845 + char* Name + char Name +
+ + +

Transformation matrix.

+
+ + bb172845 + D3DXMATRIX TransformationMatrix + D3DXMATRIX TransformationMatrix +
+ + +

Pointer to the mesh container.

+
+ + bb172845 + D3DXMESHCONTAINER* pMeshContainer + D3DXMESHCONTAINER pMeshContainer +
+ + +

Pointer to a sibling frame.

+
+ + bb172845 + D3DXFRAME* pFrameSibling + D3DXFRAME pFrameSibling +
+ + +

Pointer to a child frame.

+
+ + bb172845 + D3DXFRAME* pFrameFirstChild + D3DXFRAME pFrameFirstChild +
+ + +

Describes a function used by an effect.

+
+ + bb172853 + D3DXFUNCTION_DESC + D3DXFUNCTION_DESC +
+ + +

Function name.

+
+ + bb172853 + const char* Name + char Name +
+ + +

Unused. This member will always be set to zero by GetFunctionDesc.

+
+ + bb172853 + unsigned int Annotations + unsigned int Annotations +
+ + + No documentation. + + + D3DGAMMARAMP + D3DGAMMARAMP + + + + No documentation. + + + unsigned short red[256] + unsigned short red + + + + No documentation. + + + unsigned short green[256] + unsigned short green + + + + No documentation. + + + unsigned short blue[256] + unsigned short blue + + + +

Returns a description of the original contents of an image file.

+
+ + bb172879 + D3DXIMAGE_INFO + D3DXIMAGE_INFO +
+ + +

Width of original image in pixels.

+
+ + bb172879 + unsigned int Width + unsigned int Width +
+ + +

Height of original image in pixels.

+
+ + bb172879 + unsigned int Height + unsigned int Height +
+ + +

Depth of original image in pixels.

+
+ + bb172879 + unsigned int Depth + unsigned int Depth +
+ + +

Number of mip levels in original image.

+
+ + bb172879 + unsigned int MipLevels + unsigned int MipLevels +
+ + +

A value from the enumerated type that most closely describes the data in the original image.

+
+ + bb172879 + D3DFORMAT Format + D3DFORMAT Format +
+ + +

Represents the type of the texture stored in the file. It is either , , or D3DRTYPE_CubeTexture.

+
+ + bb172879 + D3DRESOURCETYPE ResourceType + D3DRESOURCETYPE ResourceType +
+ + +

Represents the format of the image file.

+
+ + bb172879 + D3DXIMAGE_FILEFORMAT ImageFileFormat + D3DXIMAGE_FILEFORMAT ImageFileFormat +
+ + + Retrieves information about a given image file on the disk. + + The filename. + A structure + HRESULT D3DXGetImageInfoFromFileInMemory([In] const void* pSrcData,[In] unsigned int SrcDataSize,[Out] D3DXIMAGE_INFO* pSrcInfo) + + + + Retrieves information about a given image file in memory. + + The memory. + A structure + HRESULT D3DXGetImageInfoFromFileInMemory([In] const void* pSrcData,[In] unsigned int SrcDataSize,[Out] D3DXIMAGE_INFO* pSrcInfo) + + + + Retrieves information about a given image file from a stream. + + The stream. + A structure + This method keeps the position of the stream + HRESULT D3DXGetImageInfoFromFileInMemory([In] const void* pSrcData,[In] unsigned int SrcDataSize,[Out] D3DXIMAGE_INFO* pSrcInfo) + + + + Retrieves information about a given image file from a stream. + + The stream. + if set to true preserve the stream position; false will move the stream pointer. + A structure + HRESULT D3DXGetImageInfoFromFileInMemory([In] const void* pSrcData,[In] unsigned int SrcDataSize,[Out] D3DXIMAGE_INFO* pSrcInfo) + + + + No documentation. + + + D3DINDEXBUFFER_DESC + D3DINDEXBUFFER_DESC + + + + No documentation. + + + D3DFORMAT Format + D3DFORMAT Format + + + + No documentation. + + + D3DRESOURCETYPE Type + D3DRESOURCETYPE Type + + + + No documentation. + + + D3DUSAGE Usage + D3DUSAGE Usage + + + + No documentation. + + + D3DPOOL Pool + D3DPOOL Pool + + + + No documentation. + + + unsigned int Size + unsigned int Size + + + +

Percent of time processing data in the driver. These statistics may help identify cases when the driver is waiting for other resources.

+
+ +

These metrics help identify when a driver is waiting and what it is waiting for. High percentages are not necessarily a problem.

These system-global metrics may or may not be implemented. Depending on the specific hardware, these metrics may not support multiple queries simultaneously.

+
+ + bb172541 + D3DDEVINFO_D3D9INTERFACETIMINGS + D3DDEVINFO_D3D9INTERFACETIMINGS +
+ + +

Percentage of time the driver spent waiting for the GPU to finish using a locked resource (and wasn't specified).

+
+ + bb172541 + float WaitingForGPUToUseApplicationResourceTimePercent + float WaitingForGPUToUseApplicationResourceTimePercent +
+ + +

Percentage of time the driver spent waiting for the GPU to finish processing some commands before the driver could send more. This indicates the driver has run out of room to send commands to the GPU.

+
+ + bb172541 + float WaitingForGPUToAcceptMoreCommandsTimePercent + float WaitingForGPUToAcceptMoreCommandsTimePercent +
+ + +

Percentage of time the driver spent waiting for the GPU latency to reduce to less than three rendering frames.

If an application is GPU-limited, the driver must stall the CPU until the GPU gets within three frames. This prevents an application from queuing up many seconds' worth of rendering calls which may dramatically increase the latency between when the user inputs new data and when the user sees the results of that input. In general, the driver can track the number of times Present is called to prevent queuing up more than three frames of rendering work.

+
+ + bb172541 + float WaitingForGPUToStayWithinLatencyTimePercent + float WaitingForGPUToStayWithinLatencyTimePercent +
+ + +

Percentage of time the driver spent waiting for a resource that cannot be pipelined (that is operated in parallel). An application may want to avoid using a non-pipelined resource for performance reasons.

+
+ + bb172541 + float WaitingForGPUExclusiveResourceTimePercent + float WaitingForGPUExclusiveResourceTimePercent +
+ + +

Percentage of time the driver spent waiting for other GPU processing.

+
+ + bb172541 + float WaitingForGPUOtherTimePercent + float WaitingForGPUOtherTimePercent +
+ + +

Defines a set of lighting properties.

+
+ + bb172566 + D3DLIGHT9 + D3DLIGHT9 +
+ + +

Type of the light source. This value is one of the members of the enumerated type.

+
+ + bb172566 + D3DLIGHTTYPE Type + D3DLIGHTTYPE Type +
+ + +

Diffuse color emitted by the light. This member is a structure.

+
+ + bb172566 + D3DCOLORVALUE Diffuse + D3DCOLORVALUE Diffuse +
+ + +

Specular color emitted by the light. This member is a structure.

+
+ + bb172566 + D3DCOLORVALUE Specular + D3DCOLORVALUE Specular +
+ + +

Ambient color emitted by the light. This member is a structure.

+
+ + bb172566 + D3DCOLORVALUE Ambient + D3DCOLORVALUE Ambient +
+ + +

Position of the light in world space, specified by a structure. This member has no meaning for directional lights and is ignored in that case.

+
+ + bb172566 + D3DVECTOR Position + D3DVECTOR Position +
+ + +

Direction that the light is pointing in world space, specified by a structure. This member has meaning only for directional and spotlights. This vector need not be normalized, but it should have a nonzero length.

+
+ + bb172566 + D3DVECTOR Direction + D3DVECTOR Direction +
+ + +

Distance beyond which the light has no effect. The maximum allowable value for this member is the square root of FLT_MAX. This member does not affect directional lights.

+
+ + bb172566 + float Range + float Range +
+ + +

Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).

The effect of falloff on the lighting is subtle. Furthermore, a small performance penalty is incurred by shaping the falloff curve. For these reasons, most developers set this value to 1.0.

+
+ + bb172566 + float Falloff + float Falloff +
+ + +

Value specifying how the light intensity changes over distance. Attenuation values are ignored for directional lights. This member represents an attenuation constant. For information about attenuation, see Light Properties (Direct3D 9). Valid values for this member range from 0.0 to infinity. For non-directional lights, all three attenuation values should not be set to 0.0 at the same time.

+
+ + bb172566 + float Attenuation0 + float Attenuation0 +
+ + +

Value specifying how the light intensity changes over distance. Attenuation values are ignored for directional lights. This member represents an attenuation constant. For information about attenuation, see Light Properties (Direct3D 9). Valid values for this member range from 0.0 to infinity. For non-directional lights, all three attenuation values should not be set to 0.0 at the same time.

+
+ + bb172566 + float Attenuation1 + float Attenuation1 +
+ + +

Value specifying how the light intensity changes over distance. Attenuation values are ignored for directional lights. This member represents an attenuation constant. For information about attenuation, see Light Properties (Direct3D 9). Valid values for this member range from 0.0 to infinity. For non-directional lights, all three attenuation values should not be set to 0.0 at the same time.

+
+ + bb172566 + float Attenuation2 + float Attenuation2 +
+ + +

Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.

+
+ + bb172566 + float Theta + float Theta +
+ + +

Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.

+
+ + bb172566 + float Phi + float Phi +
+ + + No documentation. + + + bb280342 + D3DLOCKED_BOX + D3DLOCKED_BOX + + + + No documentation. + + + int RowPitch + int RowPitch + + + + No documentation. + + + int SlicePitch + int SlicePitch + + + + No documentation. + + + void* pBits + void pBits + + + +

Describes a locked rectangular region.

+
+ +

The pitch for DXTn formats is different from what was returned in DirectX 7. It now refers to the number of bytes in a row of blocks. For example, if you have a width of 16, then you will have a pitch of 4 blocks (4*8 for DXT1, 4*16 for DXT2-5.)

+
+ + bb172570 + D3DLOCKED_RECT + D3DLOCKED_RECT +
+ + +

Number of bytes in one row of the surface.

+
+ + bb172570 + int Pitch + int Pitch +
+ + +

Pointer to the locked bits. If a was provided to the LockRect call, pBits will be appropriately offset from the start of the surface.

+
+ + bb172570 + void* pBits + void pBits +
+ + +

Describes preprocessor definitions used by an effect object.

+
+ +

To use s in more than one line, prefix each new line character with a backslash (like a #define in the C language). For example:

 sample=	
+            macro.Name = "DO_CODE_BLOCK";	
+            macro.Definition = "/* here is a block of code */\\\n" "{ do something ... }\\\n";	
+            

Notice the 3 backslash characters at the end of the line. The first two are required to output a single '\', followed by the newline character "\n". Optionally, you may also want to terminate your lines using "\\\r\n".

+
+ + bb172910 + D3DXMACRO + D3DXMACRO +
+ + +

Preprocessor name.

+
+ + bb172910 + const char* Name + char Name +
+ + +

Definition name.

+
+ + bb172910 + const char* Definition + char Definition +
+ + + Initializes a new instance of the struct. + + The name. + The definition. + + + +

Specifies material properties.

+
+ +

To turn off specular highlights, set to , using . This is the fastest option because no specular highlights will be calculated.

For more information about using the lighting engine to calculate specular lighting, see Specular Lighting (Direct3D 9).

+
+ + bb172571 + D3DMATERIAL9 + D3DMATERIAL9 +
+ + +

Value specifying the diffuse color of the material. See .

+
+ + bb172571 + D3DCOLORVALUE Diffuse + D3DCOLORVALUE Diffuse +
+ + +

Value specifying the ambient color of the material. See .

+
+ + bb172571 + D3DCOLORVALUE Ambient + D3DCOLORVALUE Ambient +
+ + +

Value specifying the specular color of the material. See .

+
+ + bb172571 + D3DCOLORVALUE Specular + D3DCOLORVALUE Specular +
+ + +

Value specifying the emissive color of the material. See .

+
+ + bb172571 + D3DCOLORVALUE Emissive + D3DCOLORVALUE Emissive +
+ + +

Floating-point value specifying the sharpness of specular highlights. The higher the value, the sharper the highlight.

+
+ + bb172571 + float Power + float Power +
+ + + No documentation. + + + bb280302 + D3DXMESHCONTAINER + D3DXMESHCONTAINER + + + + No documentation. + + + char* Name + char Name + + + + No documentation. + + + D3DXMESHDATA MeshData + D3DXMESHDATA MeshData + + + + No documentation. + + + D3DXMATERIAL* pMaterials + D3DXMATERIAL pMaterials + + + + No documentation. + + + D3DXEFFECTINSTANCE* pEffects + D3DXEFFECTINSTANCE pEffects + + + + No documentation. + + + unsigned int NumMaterials + unsigned int NumMaterials + + + + No documentation. + + + unsigned int* pAdjacency + unsigned int pAdjacency + + + + No documentation. + + + ID3DXSkinInfo* pSkinInfo + ID3DXSkinInfo pSkinInfo + + + + No documentation. + + + D3DXMESHCONTAINER* pNextMeshContainer + D3DXMESHCONTAINER pNextMeshContainer + + + + Gets or sets the materials. + + + The materials. + + + + +

Mesh data structure.

+
+ + bb205372 + D3DXMESHDATA + D3DXMESHDATA +
+ + +

Defines the mesh data type. See .

+
+ + bb205372 + D3DXMESHDATATYPE Type + D3DXMESHDATATYPE Type +
+ + +

Pointer to a mesh. See .

+
+ + bb205372 + ID3DXMesh* pMesh + ID3DXMesh pMesh +
+ + +

Pointer to a patch mesh. See .

+
+ + bb205372 + ID3DXPMesh* pPMesh + ID3DXPMesh pPMesh +
+ + + No documentation. + + + ID3DXPatchMesh* pPatchMesh + ID3DXPatchMesh pPatchMesh + + + +

Describes a parameter used for an effect object.

+
+ + bb205379 + D3DXPARAMETER_DESC + D3DXPARAMETER_DESC +
+ + +

Name of the parameter.

+
+ + bb205379 + const char* Name + char Name +
+ + +

Semantic meaning, also called the usage.

+
+ + bb205379 + const char* Semantic + char Semantic +
+ + +

Parameter class. Set this to one of the values in .

+
+ + bb205379 + D3DXPARAMETER_CLASS Class + D3DXPARAMETER_CLASS Class +
+ + +

Parameter type. Set this to one of the values in .

+
+ + bb205379 + D3DXPARAMETER_TYPE Type + D3DXPARAMETER_TYPE Type +
+ + +

Number of rows in the array.

+
+ + bb205379 + unsigned int Rows + unsigned int Rows +
+ + +

Number of columns in the array.

+
+ + bb205379 + unsigned int Columns + unsigned int Columns +
+ + +

Number of elements in the array.

+
+ + bb205379 + unsigned int Elements + unsigned int Elements +
+ + +

Number of annotations.

+
+ + bb205379 + unsigned int Annotations + unsigned int Annotations +
+ + +

Number of structure members.

+
+ + bb205379 + unsigned int StructMembers + unsigned int StructMembers +
+ + +

Parameter attributes. See Effect Constants.

+
+ + bb205379 + unsigned int Flags + unsigned int Flags +
+ + +

The size of the parameter, in bytes.

+
+ + bb205379 + unsigned int Bytes + unsigned int Bytes +
+ + +

Describes a pass for an effect object.

+
+ + bb205381 + D3DXPASS_DESC + D3DXPASS_DESC +
+ + +

String value used for the pass.

+
+ + bb205381 + const char* Name + char Name +
+ + +

Annotations are user-specific data that can be attached to any technique, pass, or parameter. See Add Information to Effect Parameters with_Annotations.

+
+ + bb205381 + unsigned int Annotations + unsigned int Annotations +
+ + +

Pointer to the vertex shader function. If an effect is created with , this structure will return a null reference when called by GetPassDesc.

+
+ + bb205381 + const unsigned int* pVertexShaderFunction + unsigned int pVertexShaderFunction +
+ + +

Pointer to the pixel shader function. If an effect is created with , this structure will return a null reference when called by GetPassDesc.

+
+ + bb205381 + const unsigned int* pPixelShaderFunction + unsigned int pPixelShaderFunction +
+ + +

Structure that contains the attributes of a patch mesh.

+
+ +

A mesh is a set of faces, each of which is described by a simple polygon. Objects can be created by connecting several meshes together. A patch mesh is constructed from patches. A patch is a four-sided piece of geometry constructed from curves. The type of curve used and the order of the curve can be varied so that the patch surface will fit almost any surface shape.

The following types of patch combinations are supported:

Patch TypeBasisDegree
RectangleBezier2,3,5
RectangleB-Spline2,3,5
RectangleCatmull-Rom3
TriangleBezier2,3,5
N-patchN/A3

?

+
+ + bb205382 + D3DXPATCHINFO + D3DXPATCHINFO +
+ + +

The patch type. For information about patch types, see .

+
+ + bb205382 + D3DXPATCHMESHTYPE PatchType + D3DXPATCHMESHTYPE PatchType +
+ + +

Degree of the curves used to construct the patch. For information about the degrees supported, see .

+
+ + bb205382 + D3DDEGREETYPE Degree + D3DDEGREETYPE Degree +
+ + +

Type of curve used to construct the patch. For information about the basis types supported, see .

+
+ + bb205382 + D3DBASISTYPE Basis + D3DBASISTYPE Basis +
+ + +

Percent of time processing data in the pipeline.

+
+ +

For best performance, a balanced load is recommended.

+
+ + bb172542 + D3DDEVINFO_D3D9PIPELINETIMINGS + D3DDEVINFO_D3D9PIPELINETIMINGS +
+ + +

Percent of time spent running vertex shaders.

+
+ + bb172542 + float VertexProcessingTimePercent + float VertexProcessingTimePercent +
+ + +

Percent of time spent running pixel shaders.

+
+ + bb172542 + float PixelProcessingTimePercent + float PixelProcessingTimePercent +
+ + +

Percent of time spent doing other processing.

+
+ + bb172542 + float OtherGPUProcessingTimePercent + float OtherGPUProcessingTimePercent +
+ + +

Percent of time not processing anything.

+
+ + bb172542 + float GPUIdleTimePercent + float GPUIdleTimePercent +
+ + + No documentation. + + + bb280337 + D3DPSHADERCAPS2_0 + D3DPSHADERCAPS2_0 + + + + No documentation. + + + D3DPS20CAPS Caps + D3DPS20CAPS Caps + + + + No documentation. + + + int DynamicFlowControlDepth + int DynamicFlowControlDepth + + + + No documentation. + + + int NumTemps + int NumTemps + + + + No documentation. + + + int StaticFlowControlDepth + int StaticFlowControlDepth + + + + No documentation. + + + int NumInstructionSlots + int NumInstructionSlots + + + +

Describes swapchain statistics relating to PresentEx calls.

+
+ +

When a 9Ex application adopts Flip Mode present (), applications can detect frame dropping by calling GetPresentStatistics at any point in time. In effect, they can do the following.

  1. Render to the back buffer
  2. Call Present
  3. Call GetPresentStats and store the resulting structure
  4. Render the next frame to the back buffer
  5. Call Present
  6. Repeat steps 4 and 5 one or more times
  7. Call GetPresentStats and store the resulting structure
  8. Compare the values of PresentRefreshCount from the two stored structures. The application can calculate the corresponding PresentRefreshCount of a particular PresentCount parameter based on the assumptions of PresentRefreshCount increment and PresentCount assignment of frame presents. If the PresentRefreshCount last sampled does not match the PresentCount (i.e. if the PresentRefreshCount has incremented but PresentCount has not, then there was frame dropping.)

Applications can determine whether a frame has been dropped by sampling any two instances of PresentCount and GetPresentStats (by calling GetPresentStats API at any two points in time). For example, a media application that is presenting at the same rate as the monitor refresh rate (for example, monitor refresh rate is 60Hz, the application presents a frame every 1/60 seconds) wants to present frames A, B, C, D, E, each corresponding to Present IDs (PresentCount) 1, 2, 3, 7, 8.

The application code looks like the following sequence.

  1. Render frame A to the back buffer
  2. Call Present, PresentCount = 1
  3. Call GetPresentStats and store the resulting structure
  4. Render the next 4 frames, B, C, D, E, respectively
  5. Call Present 4 times, PresentCounts = 2, 3, 7, 8, respectively
  6. Call GetPresentStats and store the resulting structure
  7. Compare the values of PresentRefreshCount from the two stored structures. If the difference is 2, i.e. 2 vblank intervals has elapsed between the two GetPresentStats API calls, then the last presented frame should be frame C. Because the application presents once very vblank interval (the refresh rate of the monitor), the time elapsed between when frame A is presented and when frame C is presented should be 2 vblanks.
  8. Compare the values of PresentCount from the two stored structures. If the first PresentCount is 1 (corresponding to frame A) and the second PresentCount is 3 (corresponding to frame C), then no frames have been dropped. If the second PresentCount is 3, which corresponds to frame D, then the application knows that one frame has been dropped.

Note that GetPresentStatistics will be processed after it is called, regardless of the state of FLIPEX mode PresentEx calls.

Windows?Vista:??The Present calls will be queued and then processed before GetPresentStats call will be processed.

When an application detects that the presentation of certain frames are behind, it can skip those frames and correct the presentation to re-synchronize with the vblank. To do this, an application can simply not render the late frames and start rendering with the next correct frame in the queue. However, if an application has already started the rendering of late frames, it can use a new Present parameter in D3D9Ex called . The flag will be passed in the parameters of Present API call and indicates to the runtime that the frame will be processed immediately within the next vblank interval, effectively not visible on screen at all. Here is the application usage example after the last step in the previous example.

  1. Render the next frame to the back buffer
  2. Discover from PresentRefreshCount that the next frame is already late
  3. Set Present interval to
  4. Call Present on the next frame

Applications can synchronize video and audio streams in the same manner because the behavior of GetPresentStatistics does not change in that scenario.

D3D9Ex Flip Mode provides frame statistics information to windowed applications and full screen 9Ex applications.

Windows?Vista:??Use the DWM APIs for retrieving present statistics.

When Desktop Window Manager is turned off, windowed mode 9Ex applications using flip mode will receive present statistics information of limited accuracy.

Windows?Vista:??

If an application is not fast enough to keep up with the monitor's refresh rate, possibly due to slow hardware or lack of system resources, then it can experience a graphics glitch. A glitch is a so-called visual hiccup. If a monitor is set to refresh at 60 Hz, and the application can only manage 30 fps, then half of the frames will have glitches.

Applications can detect a glitch by keeping track of SynchRefreshCount. For example, an application might perform the following sequence of actions.

  1. Render to the back buffer.
  2. Call Present.
  3. Call GetPresentStats and store the resulting structure.
  4. Render the next frame to the back buffer.
  5. Call Present.
  6. Call GetPresentStats and store the resulting structure.
  7. Compare the values of SyncRefreshCount from the two stored structures. If the difference is greater than one, then a frame was skipped.
+
+ + bb172587 + D3DPRESENTSTATS + D3DPRESENTSTATS +
+ + + No documentation. + + + unsigned int PresentCount + unsigned int PresentCount + + + + No documentation. + + + unsigned int PresentRefreshCount + unsigned int PresentRefreshCount + + + + No documentation. + + + unsigned int SyncRefreshCount + unsigned int SyncRefreshCount + + + + No documentation. + + + LARGE_INTEGER SyncQPCTime + LARGE_INTEGER SyncQPCTime + + + + No documentation. + + + LARGE_INTEGER SyncGPUTime + LARGE_INTEGER SyncGPUTime + + + +

Describes the presentation parameters.

+
+ + bb172588 + D3DPRESENT_PARAMETERS + D3DPRESENT_PARAMETERS +
+ + +

Width of the new swap chain's back buffers, in pixels. If Windowed is (the presentation is full-screen), this value must equal the width of one of the enumerated display modes found through EnumAdapterModes. If Windowed is TRUE and either BackBufferWidth or BackBufferHeight is zero, the corresponding dimension of the client area of the hDeviceWindow (or the focus window, if hDeviceWindow is null) is taken.

+
+ + bb172588 + unsigned int BackBufferWidth + unsigned int BackBufferWidth +
+ + +

Height of the new swap chain's back buffers, in pixels. If Windowed is (the presentation is full-screen), this value must equal the height of one of the enumerated display modes found through EnumAdapterModes. If Windowed is TRUE and either BackBufferWidth or BackBufferHeight is zero, the corresponding dimension of the client area of the hDeviceWindow (or the focus window, if hDeviceWindow is null) is taken.

+
+ + bb172588 + unsigned int BackBufferHeight + unsigned int BackBufferHeight +
+ + +

The back buffer format. For more information about formats, see . This value must be one of the render-target formats as validated by CheckDeviceType. You can use GetDisplayMode to obtain the current format.

In fact, can be specified for the BackBufferFormat while in windowed mode. This tells the runtime to use the current display-mode format and eliminates the need to call GetDisplayMode.

For windowed applications, the back buffer format no longer needs to match the display-mode format because color conversion can now be done by the hardware (if the hardware supports color conversion). The set of possible back buffer formats is constrained, but the runtime will allow any valid back buffer format to be presented to any desktop format. (There is the additional requirement that the device be operable in the desktop mode; devices typically do not operate in 8 bits per pixel modes.)

Full-screen applications cannot do color conversion.

+
+ + bb172588 + D3DFORMAT BackBufferFormat + D3DFORMAT BackBufferFormat +
+ + +

This value can be between 0 and (or when using Direct3D 9Ex). Values of 0 are treated as 1. If the number of back buffers cannot be created, the runtime will fail the method call and fill this value with the number of back buffers that could be created. As a result, an application can call the method twice with the same structure and expect it to work the second time.

The method fails if one back buffer cannot be created. The value of BackBufferCount influences what set of swap effects are allowed. Specifically, any swap effect requires that there be exactly one back buffer.

+
+ + bb172588 + unsigned int BackBufferCount + unsigned int BackBufferCount +
+ + +

Member of the enumerated type. The value must be unless SwapEffect has been set to . Multisampling is supported only if the swap effect is .

+
+ + bb172588 + D3DMULTISAMPLE_TYPE MultiSampleType + D3DMULTISAMPLE_TYPE MultiSampleType +
+ + +

Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by CheckDeviceMultiSampleType. Passing a larger value returns the error . Paired values of render targets or of depth stencil surfaces and must match.

+
+ + bb172588 + unsigned int MultiSampleQuality + unsigned int MultiSampleQuality +
+ + +

Member of the enumerated type. The runtime will guarantee the implied semantics concerning buffer swap behavior; therefore, if Windowed is TRUE and SwapEffect is set to , the runtime will create one extra back buffer and copy whichever becomes the front buffer at presentation time.

requires that BackBufferCount be set to 1.

will be enforced in the debug runtime by filling any buffer with noise after it is presented.

Differences between Direct3D9 and Direct3D9Ex

In Direct3D9Ex, is added to designate when an application is adopting flip mode. That is, whan an application's frame is passed in window's mode (instead of copied) to the Desktop Window Manager(DWM) for composition. Flip mode provides more efficient memory bandwidth and enables an application to take advantage of full-screen-present statistics. It does not change full screen behavior. Flip mode behavior is available beginning with Windows 7.

?

+
+ + bb172588 + D3DSWAPEFFECT SwapEffect + D3DSWAPEFFECT SwapEffect +
+ + +

The device window determines the location and size of the back buffer on screen. This is used by Direct3D when the back buffer contents are copied to the front buffer during Present.

  • For a full-screen application, this is a handle to the top window (which is the focus window).

    For applications that use multiple full-screen devices (such as a multimonitor system), exactly one device can use the focus window as the device window. All other devices must have unique device windows.

  • For a windowed-mode application, this handle will be the default target window for Present. If this handle is null, the focus window will be taken.

Note that no attempt is made by the runtime to reflect user changes in window size. The back buffer is not implicitly reset when this window is reset. However, the Present method does automatically track window position changes.

+
+ + bb172588 + HWND hDeviceWindow + HWND hDeviceWindow +
+ + +

TRUE if the application runs windowed; if the application runs full-screen.

+
+ + bb172588 + BOOL Windowed + BOOL Windowed +
+ + +

If this value is TRUE, Direct3D will manage depth buffers for the application. The device will create a depth-stencil buffer when it is created. The depth-stencil buffer will be automatically set as the render target of the device. When the device is reset, the depth-stencil buffer will be automatically destroyed and recreated in the new size.

If EnableAutoDepthStencil is TRUE, then AutoDepthStencilFormat must be a valid depth-stencil format.

+
+ + bb172588 + BOOL EnableAutoDepthStencil + BOOL EnableAutoDepthStencil +
+ + +

Member of the enumerated type. The format of the automatic depth-stencil surface that the device will create. This member is ignored unless EnableAutoDepthStencil is TRUE.

+
+ + bb172588 + D3DFORMAT AutoDepthStencilFormat + D3DFORMAT AutoDepthStencilFormat +
+ + +

One of the constants.

+
+ + bb172588 + D3DPRESENTFLAG Flags + D3DPRESENTFLAG Flags +
+ + +

The rate at which the display adapter refreshes the screen. The value depends on the mode in which the application is running:

  • For windowed mode, the refresh rate must be 0.
  • For full-screen mode, the refresh rate is one of the refresh rates returned by EnumAdapterModes.
+
+ + bb172588 + unsigned int FullScreen_RefreshRateInHz + unsigned int FullScreen_RefreshRateInHz +
+ + +

The maximum rate at which the swap chain's back buffers can be presented to the front buffer. For a detailed explanation of the modes and the intervals that are supported, see .

+
+ + bb172588 + D3DPRESENT_INTERVAL PresentationInterval + D3DPRESENT_INTERVAL PresentationInterval +
+ + + Initializes a new instance of the struct. + + Width of the back buffer. + Height of the back buffer. + The back buffer format. + The back buffer count. + Type of the multi sample. + The multi sample quality. + The swap effect. + The device window handle. + if set to true [windowed]. + if set to true [enable auto depth stencil]. + The auto depth stencil format. + The present flags. + The full screen refresh rate in hz. + The presentation interval. + + + + Init this structure to defaults + + + + +

Describes the raster status.

+
+ + bb172596 + D3DRASTER_STATUS + D3DRASTER_STATUS +
+ + +

TRUE if the raster is in the vertical blank period. if the raster is not in the vertical blank period.

+
+ + bb172596 + BOOL InVBlank + BOOL InVBlank +
+ + +

If InVBlank is , then this value is an integer roughly corresponding to the current scan line painted by the raster. Scan lines are numbered in the same way as Direct3D surface coordinates: 0 is the top of the primary surface, extending to the value (height of the surface - 1) at the bottom of the display.

If InVBlank is TRUE, then this value is set to zero and can be ignored.

+
+ + bb172596 + unsigned int ScanLine + unsigned int ScanLine +
+ + +

Describes a rectangular high-order patch.

+
+ +

The following diagram identifies the parameters that specify a rectangle patch.

Each of the vertices in the vertex buffer is shown as a black dot. In this case, the vertex buffer has 20 vertices in it, 16 of which are in the rectangle patch. The stride is the number of vertices in the width of the vertex buffer, in this case five. The x offset to the first vertex is called the StartIndexVertexWidth and is in this case 1. The y offset to the first patch vertex is called the StartIndexVertexHeight and is in this case 0.

To render a stream of individual rectangular patches (non-mosaic), you should interpret your geometry as a long narrow (1 x N) rectangular patch. The structure for such a strip (cubic B?zier) would be set up in the following manner.

  RectInfo; RectInfo.Width = 4;	
+            RectInfo.Height = 4;	
+            RectInfo.Stride = 4;	
+            RectInfo.Basis = ;	
+            RectInfo.Order = D3DORDER_CUBIC;	
+            RectInfo.StartVertexOffsetWidth = 0;	
+            RectInfo.StartVertexOffsetHeight = 4*i;  // The variable i is the index of the 	
+            //   patch you want to render.	
+            
+
+ + bb172598 + D3DRECTPATCH_INFO + D3DRECTPATCH_INFO +
+ + +

Starting vertex offset width, in number of vertices.

+
+ + bb172598 + unsigned int StartVertexOffsetWidth + unsigned int StartVertexOffsetWidth +
+ + +

Starting vertex offset height, in number of vertices.

+
+ + bb172598 + unsigned int StartVertexOffsetHeight + unsigned int StartVertexOffsetHeight +
+ + +

Width of each vertex, in number of vertices.

+
+ + bb172598 + unsigned int Width + unsigned int Width +
+ + +

Height of each vertex, in number of vertices.

+
+ + bb172598 + unsigned int Height + unsigned int Height +
+ + +

Width of the imaginary two-dimensional vertex array, which occupies the same space as the vertex buffer. For an example, see the diagram below.

+
+ + bb172598 + unsigned int Stride + unsigned int Stride +
+ + +

Member of the enumerated type, defining the basis type for the rectangular high-order patch.

ValueOrder supportedWidth and height
Linear, cubic, and quinticWidth = height = (DWORD)order + 1
Linear, cubic, and quinticWidth = height > (DWORD)order
D3DBASIS_INTERPOLATECubicWidth = height > (DWORD)order

?

+
+ + bb172598 + D3DBASISTYPE Basis + D3DBASISTYPE Basis +
+ + +

Member of the enumerated type, defining the degree for the rectangular patch.

+
+ + bb172598 + D3DDEGREETYPE Degree + D3DDEGREETYPE Degree +
+ + +

Describes an off-screen render target used by an instance of .

+
+ +

This method is used to return the creation parameters used when creating an object.

+
+ + bb205425 + D3DXRTE_DESC + D3DXRTE_DESC +
+ + + No documentation. + + + unsigned int Size + unsigned int Size + + + + No documentation. + + + unsigned int MipLevels + unsigned int MipLevels + + + + No documentation. + + + D3DFORMAT Format + D3DFORMAT Format + + + + No documentation. + + + BOOL DepthStencil + BOOL DepthStencil + + + + No documentation. + + + D3DFORMAT DepthStencilFormat + D3DFORMAT DepthStencilFormat + + + +

Describes a render surface.

+
+ + bb205426 + D3DXRTS_DESC + D3DXRTS_DESC +
+ + +

Width of the render surface, in pixels.

+
+ + bb205426 + unsigned int Width + unsigned int Width +
+ + +

Height of the render surface, in pixels.

+
+ + bb205426 + unsigned int Height + unsigned int Height +
+ + +

Member of the enumerated type, describing the pixel format of the render surface.

+
+ + bb205426 + D3DFORMAT Format + D3DFORMAT Format +
+ + +

If TRUE, the render surface supports a depth-stencil surface; otherwise this member is set to .

+
+ + bb205426 + BOOL DepthStencil + BOOL DepthStencil +
+ + +

If DepthStencil is set to TRUE, this parameter is a member of the enumerated type, describing the depth-stencil format of the render surface.

+
+ + bb205426 + D3DFORMAT DepthStencilFormat + D3DFORMAT DepthStencilFormat +
+ + + No documentation. + + + bb280347 + D3DDEVINFO_RESOURCEMANAGER + D3DDEVINFO_RESOURCEMANAGER + + + + No documentation. + + + D3DRESOURCESTATS stats[8] + D3DRESOURCESTATS stats + + + +

Resource statistics gathered by the D3DDEVINFO_ResourceManager when using the asynchronous query mechanism.

+
+ + Bb172600 + D3DRESOURCESTATS + D3DRESOURCESTATS +
+ + + No documentation. + + + BOOL bThrashing + BOOL bThrashing + + + + No documentation. + + + unsigned int ApproxBytesDownloaded + unsigned int ApproxBytesDownloaded + + + + No documentation. + + + unsigned int NumEvicts + unsigned int NumEvicts + + + + No documentation. + + + unsigned int NumVidCreates + unsigned int NumVidCreates + + + + No documentation. + + + unsigned int LastPri + unsigned int LastPri + + + + No documentation. + + + unsigned int NumUsed + unsigned int NumUsed + + + + No documentation. + + + unsigned int NumUsedInVidMem + unsigned int NumUsedInVidMem + + + + No documentation. + + + unsigned int WorkingSet + unsigned int WorkingSet + + + + No documentation. + + + unsigned int WorkingSetBytes + unsigned int WorkingSetBytes + + + + No documentation. + + + unsigned int TotalManaged + unsigned int TotalManaged + + + + No documentation. + + + unsigned int TotalBytes + unsigned int TotalBytes + + + +

Describes a quaternion key for use in key frame animation. A quaternion key is a quaternion value at a given time.

+
+ + bb172887 + D3DXKEY_QUATERNION + D3DXKEY_QUATERNION +
+ + +

Time value.

+
+ + bb172887 + float Time + float Time +
+ + +

quaternion that supplies rotation values.

+
+ + bb172887 + D3DXQUATERNION Value + D3DXQUATERNION Value +
+ + +

Describes a vector key for use in key frame animation. It specifies a vector at a given time. This is used for scale and translation keys.

+
+ + bb172889 + D3DXKEY_VECTOR3 + D3DXKEY_VECTOR3 +
+ + +

Key frame time stamp.

+
+ + bb172889 + float Time + float Time +
+ + +

3D vector that supplies scale and/or translation values.

+
+ + bb172889 + D3DXVECTOR3 Value + D3DXVECTOR3 Value +
+ + + No documentation. + + + bb205439 + D3DXSHADER_CONSTANTINFO + D3DXSHADER_CONSTANTINFO + + + +

Offset from the beginning of this structure, in bytes, to the string that contains the constant information.

+
+ + bb205439 + unsigned int Name + unsigned int Name +
+ + +

Register set. See .

+
+ + bb205439 + unsigned short RegisterSet + unsigned short RegisterSet +
+ + +

The register index.

+
+ + bb205439 + unsigned short RegisterIndex + unsigned short RegisterIndex +
+ + +

Number of registers.

+
+ + bb205439 + unsigned short RegisterCount + unsigned short RegisterCount +
+ + +

Reserved.

+
+ + bb205439 + unsigned short Reserved + unsigned short Reserved +
+ + +

Offset from the beginning of this structure, in bytes, to the string that contains the D3DXSHADER_TYPEINFO information.

+
+ + bb205439 + unsigned int TypeInfo + unsigned int TypeInfo +
+ + +

Offset from the beginning of this structure, in bytes, to the string that contains the default value.

+
+ + bb205439 + unsigned int DefaultValue + unsigned int DefaultValue +
+ + +

Helper structure for managing a shader constant table. This can also be done using .

+
+ +

Shader constant information is included in a tab-delimited table of comments. All offsets are measured in bytes from the beginning of the structure. Entries in the constant table are sorted by Creator in ascending order.

A shader constant table can be managed with the interfaces. Alternatively, you can manage the constant table with .

This size member is often initialized using the following:

  constantTable;	
+            constantTable.Size = sizeof()	
+            
+
+ + Bb205440 + D3DXSHADER_CONSTANTTABLE + D3DXSHADER_CONSTANTTABLE +
+ + + No documentation. + + + unsigned int Size + unsigned int Size + + + + No documentation. + + + unsigned int Creator + unsigned int Creator + + + + No documentation. + + + unsigned int Version + unsigned int Version + + + + No documentation. + + + unsigned int Constants + unsigned int Constants + + + + No documentation. + + + unsigned int ConstantInfo + unsigned int ConstantInfo + + + + No documentation. + + + unsigned int Flags + unsigned int Flags + + + + No documentation. + + + unsigned int Target + unsigned int Target + + + +

Semantics map a parameter to vertex or pixel shader registers. They can also be optional descriptive strings attached to non-register parameters.

+
+ +

Semantics are required for vertex and pixel shader, input and output registers.

+
+ + bb205437 + D3DXSEMANTIC + D3DXSEMANTIC +
+ + +

Options that identify how resources are used. See .

+
+ + bb205437 + D3DDECLUSAGE Usage + D3DDECLUSAGE Usage +
+ + +

Options that modify how the usage is interpreted. The usage and usage index make up a vertex declaration. See Vertex Declaration (Direct3D 9).

+
+ + bb205437 + unsigned int UsageIndex + unsigned int UsageIndex +
+ + +

Percent of time processing shader data.

+
+ +

For best performance, a balanced load is recommended.

+
+ + bb172543 + D3DDEVINFO_D3D9STAGETIMINGS + D3DDEVINFO_D3D9STAGETIMINGS +
+ + +

Percent of time in shader spent on memory accesses.

+
+ + bb172543 + float MemoryProcessingPercent + float MemoryProcessingPercent +
+ + +

Percent of time processing (moving data around in registers or doing mathematical operations).

+
+ + bb172543 + float ComputationProcessingPercent + float ComputationProcessingPercent +
+ + +

Describes a surface.

+
+ + bb172611 + D3DSURFACE_DESC + D3DSURFACE_DESC +
+ + +

Member of the enumerated type, describing the surface format.

+
+ + bb172611 + D3DFORMAT Format + D3DFORMAT Format +
+ + +

Member of the enumerated type, identifying this resource as a surface.

+
+ + bb172611 + D3DRESOURCETYPE Type + D3DRESOURCETYPE Type +
+ + +

Either the or values. For more information, see .

+
+ + bb172611 + D3DUSAGE Usage + D3DUSAGE Usage +
+ + +

Member of the enumerated type, specifying the class of memory allocated for this surface.

+
+ + bb172611 + D3DPOOL Pool + D3DPOOL Pool +
+ + +

Member of the enumerated type, specifying the levels of full-scene multisampling supported by the surface.

+
+ + bb172611 + D3DMULTISAMPLE_TYPE MultiSampleType + D3DMULTISAMPLE_TYPE MultiSampleType +
+ + +

Quality level. The valid range is between zero and one less than the level returned by pQualityLevels used by CheckDeviceMultiSampleType. Passing a larger value returns the error, . The MultisampleQuality values of paired render targets, depth stencil surfaces and the MultiSample type must all match.

+
+ + bb172611 + unsigned int MultiSampleQuality + unsigned int MultiSampleQuality +
+ + +

Width of the surface, in pixels.

+
+ + bb172611 + unsigned int Width + unsigned int Width +
+ + +

Height of the surface, in pixels.

+
+ + bb172611 + unsigned int Height + unsigned int Height +
+ + +

Describes a technique used by an effect.

+
+ +

Some video cards can render two textures in a single pass. However, if a card does not have this capability, it is often possible to render the same effect in two passes, using one texture for each pass.

+
+ + bb205468 + D3DXTECHNIQUE_DESC + D3DXTECHNIQUE_DESC +
+ + +

String that contains the technique name.

+
+ + bb205468 + const char* Name + char Name +
+ + +

Number of rendering passes the technique requires. See Remarks.

+
+ + bb205468 + unsigned int Passes + unsigned int Passes +
+ + +

The number of annotations. See Add Information to Effect Parameters with_Annotations.

+
+ + bb205468 + unsigned int Annotations + unsigned int Annotations +
+ + +

Describes an animation track and specifies blending weight, speed, and position for the track at a given time.

+
+ +

Tracks with the same priority are blended together, and the two resulting values are then blended using the priority blend factor. A track must have an animation set (stored separately) associated with it.

+
+ + bb205474 + D3DXTRACK_DESC + D3DXTRACK_DESC +
+ + +

Priority type, as defined in .

+
+ + bb205474 + D3DXPRIORITY_TYPE Priority + D3DXPRIORITY_TYPE Priority +
+ + +

Weight value. The weight determines the proportion of this track to blend with other tracks.

+
+ + bb205474 + float Weight + float Weight +
+ + +

Speed value. This is used similarly to a multiplier to scale the period of the track.

+
+ + bb205474 + float Speed + float Speed +
+ + +

Time position of the track, in the local timeframe of its current animation set.

+
+ + bb205474 + double Position + double Position +
+ + +

Track enable/disable. To enable, set to TRUE. To disable, set to .

+
+ + bb205474 + BOOL Enable + BOOL Enable +
+ + +

Describes a triangular high-order patch.

+
+ +

For example, the following diagram identifies the vertex order and segment numbers for a cubic B?zier triangle patch. The vertex order determines the segment numbers used by DrawTriPatch. The offset is the number of bytes to the first triangle patch vertex in the vertex buffer.

+
+ + bb172620 + D3DTRIPATCH_INFO + D3DTRIPATCH_INFO +
+ + +

Starting vertex offset, in number of vertices.

+
+ + bb172620 + unsigned int StartVertexOffset + unsigned int StartVertexOffset +
+ + +

Number of vertices.

+
+ + bb172620 + unsigned int NumVertices + unsigned int NumVertices +
+ + +

Member of the enumerated type, which defines the basis type for the triangular high-order patch. The only valid value for this member is .

+
+ + bb172620 + D3DBASISTYPE Basis + D3DBASISTYPE Basis +
+ + +

Member of the enumerated type, defining the degree type for the triangular high-order patch.

ValueNumber of vertices
10
3
N/A
21

?

N/A - Not available. Not supported.

+
+ + bb172620 + D3DDEGREETYPE Degree + D3DDEGREETYPE Degree +
+ + +

DirectX 8.1 and later versions only.

The structure describes vertex-cache information of a device.

+
+ +

DirectX 8.1 versions only.The Direct3D runtime calls a driver's D3dGetDriverState function to obtain vertex-cache information from the driver. In this D3dGetDriverState call, the runtime specifies the D3DDEVINFOID_VCACHE flag in the dwFlags member of the DD_GETDRIVERSTATEDATA structure that the runtime passes. The driver specifies vertex-cache information in a structure and returns it at the lpdwStates member of DD_GETDRIVERSTATEDATA.

DirectX 9.0 and later versions only.The Direct3D runtime specifies D3DDP2OP_CREATEQUERY and D3DDP2OP_ISSUEQUERY commands in calls to the driver's D3dDrawPrimitives2 callback to create driver-side resources for the query and then to asynchronously query the driver for vertex-cache information. In the call with the D3DDP2OP_CREATEQUERY command, the runtime specifies the query type in the QueryType member of the D3DHAL_DP2CREATEQUERY structure.

When the driver completes a vertex-cache query, the driver sets the total size of the response buffer in the dwErrorOffset member of the D3DHAL_DRAWPRIMITIVES2DATA structure and sets the ddrval member of D3DHAL_DRAWPRIMITIVES2DATA to for successful completion. The driver also overwrites the incoming command buffer with the outgoing response buffer. This response buffer contains a D3DHAL_DP2RESPONSEQUERY structure that identifies a response for the vertex-cache query. This D3DHAL_DP2RESPONSEQUERY is followed by the vertex-cache data in the structure.

+
+ + ff544702 + D3DDEVINFO_VCACHE + D3DDEVINFO_VCACHE +
+ + +

Specifies the bit pattern. The driver must specify the bit pattern as the CACH four-character code (FOURCC) value. The driver can use the MAKEFOURCC macro as follows to specify the FOURCC value as CACH:

MAKEFOURCC('C', 'A', 'C', 'H');
+
+ + ff544702 + unsigned int Pattern + unsigned int Pattern +
+ + +

Specifies the method of mesh optimization. The driver can use one of the following values to specify the mesh optimization that it uses:

ValueMeaning

(0)

Longest strips optimization

D3DXMESHOPT_VCACHE (1)

Vertex-cache based optimization

?

+
+ + ff544702 + unsigned int OptMethod + unsigned int OptMethod +
+ + +

Specifies the effective size, in entries, for which the driver optimizes the vertex cache. The actual cache size is not required to be the size specified in CacheSize because in most cases the actual cache size turns out to be larger. The driver only specifies an optimized size in CacheSize if it also specifies D3DXMESHOPT_VCACHE in the OptMethod member.

+
+ + ff544702 + unsigned int CacheSize + unsigned int CacheSize +
+ + +

Specifies the number that should be used as part of a trial-and-error procedure when determining when to restart the strips list. This number can be set from 1 to the value in the CacheSize member. Typically, the best values are near CacheSize/2.

+
+ + ff544702 + unsigned int MagicNumber + unsigned int MagicNumber +
+ + + No documentation. + + + D3DVERTEXBUFFER_DESC + D3DVERTEXBUFFER_DESC + + + + No documentation. + + + D3DFORMAT Format + D3DFORMAT Format + + + + No documentation. + + + D3DRESOURCETYPE Type + D3DRESOURCETYPE Type + + + + No documentation. + + + D3DUSAGE Usage + D3DUSAGE Usage + + + + No documentation. + + + D3DPOOL Pool + D3DPOOL Pool + + + + No documentation. + + + unsigned int Size + unsigned int Size + + + + No documentation. + + + D3DFVF FVF + D3DFVF FVF + + + +

Defines the vertex data layout. Each vertex can contain one or more data types, and each data type is described by a vertex element.

+
+ +

Vertex data is defined using an array of structures. Use D3DDECL_END to declare the last element in the declaration.

+
+ + bb172630 + D3DVERTEXELEMENT9 + D3DVERTEXELEMENT9 +
+ + +

Stream number.

+
+ + bb172630 + unsigned short Stream + unsigned short Stream +
+ + +

Offset from the beginning of the vertex data to the data associated with the particular data type.

+
+ + bb172630 + unsigned short Offset + unsigned short Offset +
+ + +

The data type, specified as a . One of several predefined types that define the data size. Some methods have an implied type.

+
+ + bb172630 + D3DDECLTYPE Type + D3DDECLTYPE Type +
+ + +

The method specifies the tessellator processing, which determines how the tessellator interprets (or operates on) the vertex data. For more information, see .

+
+ + bb172630 + D3DDECLMETHOD Method + D3DDECLMETHOD Method +
+ + +

Defines what the data will be used for; that is, the interoperability between vertex data layouts and vertex shaders. Each usage acts to bind a vertex declaration to a vertex shader. In some cases, they have a special interpretation. For example, an element that specifies or is used by the N-patch tessellator to set up tessellation. See for a list of the available semantics. can be used for user-defined fields (which don't have an existing usage defined).

+
+ + bb172630 + D3DDECLUSAGE Usage + D3DDECLUSAGE Usage +
+ + +

Modifies the usage data to allow the user to specify multiple usage types.

+
+ + bb172630 + unsigned char UsageIndex + unsigned char UsageIndex +
+ + + Used for closing a VertexElement declaration. + + + + + Initializes the struct. + + + + + Initializes a new instance of the struct. + + The stream. + The offset. + The type. + The method. + The usage. + Index of the usage. + + + +

Vertex shader caps.

+
+ + bb172635 + D3DVSHADERCAPS2_0 + D3DVSHADERCAPS2_0 +
+ + +

Instruction predication is supported if this value is nonzero. See setp_comp - vs.

+
+ + bb172635 + D3DVS20CAPS Caps + D3DVS20CAPS Caps +
+ + +

Either 0 or 24, which represents the depth of the dynamic flow control instruction nesting. See .

+
+ + bb172635 + int DynamicFlowControlDepth + int DynamicFlowControlDepth +
+ + +

The number of temporary registers supported. See .

+
+ + bb172635 + int NumTemps + int NumTemps +
+ + +

The depth of nesting of the loop - vs/rep - vs and call - vs/callnz bool - vs instructions. See .

+
+ + bb172635 + int StaticFlowControlDepth + int StaticFlowControlDepth +
+ + +

Reports the number of triangles that have been processed and clipped by the runtime's software vertex processing.

+
+ +

Use the debug runtime and software vertex processing to get the number of non-clipped and clipped primitives for a particular scene. Primitives will typically be clipped based on a guard band (if one is present). The clipping guard band is set with parameters such as GuardBandLeft in .

+
+ + bb172544 + D3DDEVINFO_D3DVERTEXSTATS + D3DDEVINFO_D3DVERTEXSTATS +
+ + +

Total number of triangles that are not clipped in this frame.

+
+ + bb172544 + unsigned int NumRenderedTriangles + unsigned int NumRenderedTriangles +
+ + +

Number of new triangles generated by clipping.

+
+ + bb172544 + unsigned int NumExtraClippingTriangles + unsigned int NumExtraClippingTriangles +
+ + +

Describes a volume.

+
+ + bb172633 + D3DVOLUME_DESC + D3DVOLUME_DESC +
+ + +

Member of the enumerated type, describing the surface format of the volume.

+
+ + bb172633 + D3DFORMAT Format + D3DFORMAT Format +
+ + +

Member of the enumerated type, identifying this resource as a volume.

+
+ + bb172633 + D3DRESOURCETYPE Type + D3DRESOURCETYPE Type +
+ + +

Currently not used. Always returned as 0.

+
+ + bb172633 + D3DUSAGE Usage + D3DUSAGE Usage +
+ + +

Member of the enumerated type, specifying the class of memory allocated for this volume.

+
+ + bb172633 + D3DPOOL Pool + D3DPOOL Pool +
+ + +

Width of the volume, in pixels.

+
+ + bb172633 + unsigned int Width + unsigned int Width +
+ + +

Height of the volume, in pixels.

+
+ + bb172633 + unsigned int Height + unsigned int Height +
+ + +

Depth of the volume, in pixels.

+
+ + bb172633 + unsigned int Depth + unsigned int Depth +
+ + +

Specifies tolerance values for each vertex component when comparing vertices to determine if they are similar enough to be welded together.

+
+ +

The LPD3DXWELDEPSILONS type is defined as a reference to the structure.

 typedef  *LPD3DXWELDEPSILONS;	
+            
+
+ + Bb205560 + D3DXWELDEPSILONS + D3DXWELDEPSILONS +
+ + +

Position

+
+ + Bb205560 + float Position + float Position +
+ + +

Blend weight

+
+ + Bb205560 + float BlendWeights + float BlendWeights +
+ + +

Normal

+
+ + Bb205560 + float Normal + float Normal +
+ + +

Point size value

+
+ + Bb205560 + float PSize + float PSize +
+ + +

Specular lighting value

+
+ + Bb205560 + float Specular + float Specular +
+ + +

Diffuse lighting value

+
+ + Bb205560 + float Diffuse + float Diffuse +
+ + +

Tangent

+
+ + Bb205560 + float Tangent + float Tangent +
+ + +

Binormal

+
+ + Bb205560 + float Binormal + float Binormal +
+ + +

Tessellation factor

+
+ + Bb205560 + float TessFactor + float TessFactor +
+ + +

Eight texture coordinates

+
+ + Bb205560 + float Texcoord[8] + float Texcoord +
+ + +

Identifies compressed key frame animation data.

+
+ + bb174824 + XFILECOMPRESSEDANIMATIONSET + XFILECOMPRESSEDANIMATIONSET +
+ + +

Total size, in bytes, of the compressed data in the compressed key frame animation data buffer.

+
+ + bb174824 + unsigned int CompressedBlockSize + unsigned int CompressedBlockSize +
+ + +

Number of animation key frame ticks that occur per second.

+
+ + bb174824 + float TicksPerSec + float TicksPerSec +
+ + +

Type of the animation set playback loop. See .

+
+ + bb174824 + unsigned int PlaybackType + unsigned int PlaybackType +
+ + +

Minimum buffer size, in bytes, required to hold compressed key frame animation data. Value is equal to ( ( CompressedBlockSize + 3 ) / 4 ).

+
+ + bb174824 + unsigned int BufferLength + unsigned int BufferLength +
+ + + Shadow callback for . + + + + + Return a pointer to the unamanged version of this callback. + + The callback. + A pointer to a shadow c++ callback + + + + Internal Include Callback + + + + + A user-implemented method for opening and reading the contents of a shader #include file. + + This pointer + A -typed value that indicates the location of the #include file. + Name of the #include file. + Pointer to the container that includes the #include file. + Pointer to the buffer that Open returns that contains the include directives. This pointer remains valid until is called. + Pointer to the number of bytes that Open returns in ppData. + The user-implemented method should return S_OK. If Open fails when reading the #include file, the application programming interface (API) that caused Open to be called fails. This failure can occur in one of the following situations:The high-level shader language (HLSL) shader fails one of the D3D10CompileShader*** functions.The effect fails one of the D3D10CreateEffect*** functions. + HRESULT Open([None] D3D_INCLUDE_TYPE IncludeType,[None] const char* pFileName,[None] LPCVOID pParentData,[None] LPCVOID* ppData,[None] UINT* pBytes) + + + + A user-implemented method for closing a shader #include file. + + + If was successful, Close is guaranteed to be called before the API using the interface returns. + + This pointer + Pointer to the buffer that contains the include directives. This is the pointer that was returned by the corresponding call. + The user-implemented Close method should return S_OK. If Close fails when it closes the #include file, the application programming interface (API) that caused Close to be called fails. This failure can occur in one of the following situations:The high-level shader language (HLSL) shader fails one of the D3D10CompileShader*** functions.The effect fails one of the D3D10CreateEffect*** functions. + HRESULT Close([None] LPCVOID pData) + + + + Internal class used to initialize this assembly. + + + + + Initializes this assembly. + + + This method is called when the assembly is loaded. + + + + + The namespace provides a managed Direct3D9 API. + + bb219837 + Direct3D9 + Direct3D9 + + + The PaletteEntry struct contains the color and usage of an entry in a logical palette. + PALETTEENTRY + + + + The red intensity value for the palette entry. + + + + + The green intensity value for the palette entry. + + + + + The blue intensity value for the palette entry. + + + + + Indicates how the palette entry is to be used. + TODO define an enum for flags + + + + + Represents the compiled bytecode of a shader or effect. + + Blob + + + + Initializes a new instance of the class. + + A containing the compiled bytecode. + + + + Initializes a new instance of the class. + + A containing the compiled bytecode. + + + + Initializes a new instance of the class. + + The buffer. + + + + Initializes a new instance of the class. + + a pointer to a compiler bytecode + size of the bytecode + + + + Initializes a new instance of the class. + + The BLOB. + + + + Gets the size of the shader from a function pointer. + + The shader function pointer. + Size of the shader + + + + Assembles a shader from the given source data. + + The source shader data. + Compilation options. + A object representing the raw shader stream. + HRESULT D3DXAssembleShader([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs) + + + + Assembles a shader from the given source data. + + The source shader data. + Compilation options. + A object representing the raw shader stream. + HRESULT D3DXAssembleShader([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs) + + + + Assembles a shader from the given source data. + + The source shader data. + Macro definitions. + An interface to use for handling #include directives. + Compilation options. + A object representing the raw shader stream. + HRESULT D3DXAssembleShader([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs) + + + + Assembles a shader from the given source data. + + The source shader data. + Macro definitions. + An interface to use for handling #include directives. + Compilation options. + A object representing the raw shader stream. + HRESULT D3DXAssembleShader([In] const void* pSrcData,[In] unsigned int SrcDataLen,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs) + + + + Assembles a shader from file. + + Name of the shader file. + Compilation options. + A object representing the raw shader stream. + + + + Assembles a shader from file. + + Name of the shader file. + Macro definitions. + An interface to use for handling #include directives. + Compilation options. + + A object representing the raw shader stream. + + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + A set of macros to define during compilation. + An interface for handling include files. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + A set of macros to define during compilation. + An interface for handling include files. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles the provided shader or effect source. + + A string containing the source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + A set of macros to define during compilation. + An interface for handling include files. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles a shader or effect from a file on disk. + + The name of the source file to compile. + The shader target or set of shader features to compile against. + Shader compilation options. + A set of macros to define during compilation. + An interface for handling include files. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles a shader or effect from a file on disk. + + The name of the source file to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + A set of macros to define during compilation. + An interface for handling include files. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Compiles the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to compile. + The name of the shader entry-point function, or null for an effect file. + The shader target or set of shader features to compile against. + Shader compilation options. + A set of macros to define during compilation. + An interface for handling include files. + + The compiled shader bytecode, or null if the method fails. + + HRESULT D3DXCompileShader([In] const char* pSrcData,[In] unsigned int SrcDataLen,[In] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] const char* pFunctionName,[In] const char* pProfile,[In] unsigned int Flags,[In] ID3DXBuffer** ppShader,[In] ID3DXBuffer** ppErrorMsgs,[In] ID3DXConstantTable** ppConstantTable) + + + + Disassembles compiled HLSL code back into textual source. + + The textual source of the shader or effect. + HRESULT D3DXDisassembleShader([In] const void* pShader,[In] BOOL EnableColorCode,[In] const char* pComments,[In] ID3DXBuffer** ppDisassembly) + + + + Disassembles compiled HLSL code back into textual source. + + if set to true [enable color code]. + + The textual source of the shader or effect. + + HRESULT D3DXDisassembleShader([In] const void* pShader,[In] BOOL EnableColorCode,[In] const char* pComments,[In] ID3DXBuffer** ppDisassembly) + + + + Disassembles compiled HLSL code back into textual source. + + if set to true [enable color code]. + Commenting information to embed in the disassembly. + + The textual source of the shader or effect. + + HRESULT D3DXDisassembleShader([In] const void* pShader,[In] BOOL EnableColorCode,[In] const char* pComments,[In] ID3DXBuffer** ppDisassembly) + + + + Searches through the shader for the specified comment. + + A FOURCC code used to identify the comment. + The comment data. + HRESULT D3DXFindShaderComment([In] const void* pFunction,[In] unsigned int FourCC,[Out] const void** ppData,[Out] unsigned int* pSizeInBytes) + + + + Gets the set of semantics for shader inputs. + + The set of semantics for shader inputs. + HRESULT D3DXGetShaderInputSemantics([In] const void* pFunction,[In, Out, Buffer] D3DXSEMANTIC* pSemantics,[InOut] unsigned int* pCount) + + + + Gets the set of semantics for shader outputs. + + The set of semantics for shader outputs. + HRESULT D3DXGetShaderOutputSemantics([In] const void* pFunction,[In, Out, Buffer] D3DXSEMANTIC* pSemantics,[InOut] unsigned int* pCount) + + + + Gets the sampler names references in the shader. + + The set of referenced sampler names. + HRESULT D3DXGetShaderSamplers([In] const void* pFunction,[In] const char** pSamplers,[In] unsigned int* pCount) + + + + Extracts the major version component of a shader version number. + + The shader version number. + The major version component. + + + + Extracts the minor version component of a shader version number. + + The shader version number. + The minor version component. + + + + Converts a shader version number into a managed object. + + The shader version number. + The parsed shader version information. + + + + Loads from the specified stream. + + The stream. + A shader bytecode + + + + Saves to the specified file name. + + Name of the file. + + + + Saves this bycode to the specified stream. + + The stream. + + + + Froms the pointer. + + The pointer. + + + + + Preprocesses the provided shader or effect source. + + A string containing the source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + The preprocessed shader source. + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Preprocesses the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + The preprocessed shader source. + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Preprocesses the provided shader or effect source. + + An array of bytes containing the raw source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + The preprocessed shader source. + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Preprocesses the provided shader or effect source. + + The shader source PTR. + Length of the shader source. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + + The preprocessed shader source. + + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Preprocesses the provided shader or effect source. + + A string containing the source of the shader or effect to preprocess. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + The preprocessed shader source. + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Preprocesses a shader or effect from a file on disk. + + The name of the source file to compile. + The preprocessed shader source. + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Preprocesses a shader or effect from a file on disk. + + The name of the source file to compile. + A set of macros to define during preprocessing. + An interface for handling include files. + The preprocessed shader source. + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Preprocesses a shader or effect from a file on disk. + + The name of the source file to compile. + A set of macros to define during preprocessing. + An interface for handling include files. + When the method completes, contains a string of compilation errors, or an empty string if preprocessing succeeded. + The preprocessed shader source. + HRESULT D3DXPreprocessShader([In] const void* pSrcData,[In] unsigned int SrcDataSize,[In, Buffer] const D3DXMACRO* pDefines,[In] ID3DXInclude* pInclude,[In] ID3DXBuffer** ppShaderText,[In] ID3DXBuffer** ppErrorMsgs) + + + + Read a compiled shader bytecode from a Stream and return a ShaderBytecode + + + + + + + Read a compiled shader bytecode from a Stream and return a ShaderBytecode + + + + + + + Gets the buffer pointer. + + + + + Gets or sets the size of the buffer. + + + The size of the buffer. + + + + + Gets the shader constant table. + + HRESULT D3DXGetShaderConstantTable([In] const void* pFunction,[In] ID3DXConstantTable** ppConstantTable) + + + + Gets the version of the shader. + + unsigned int D3DXGetShaderVersion([In] const void* pFunction) + + + + Gets the raw data of the compiled bytecode. + + + + + Width of the texture. + + + + + Height of the texture. + + + + + Format of the texture. + + + + + Mip level count of the texture. + + + + + Helper methods to create special . + + + + + Calculates a specific TEXCOORDSIZEN . + + The size of the texcoord. The value must be in the range [1,4] (Number of floating point values) + Index of the coord. + The + If size is not in the range [1,4] + + + + + + Contains requested texture creation parameters for volume textures. + + None + + + + The requested width of the texture, in pixels. + + + + + The requested height of the texture, in pixels. + + + + + The requested depth of the texture, in pixels. + + + + + The requested surface format. + + + + + The requested mip level count. + + +
+
diff --git a/distribution/SharpDX.dll b/distribution/SharpDX.dll new file mode 100644 index 00000000..2bde40a6 Binary files /dev/null and b/distribution/SharpDX.dll differ diff --git a/distribution/SharpDX.xml b/distribution/SharpDX.xml new file mode 100644 index 00000000..3b583b3d --- /dev/null +++ b/distribution/SharpDX.xml @@ -0,0 +1,45844 @@ + + + + SharpDX + + + + + Represents a unit independant angle using a single-precision floating-point + internal representation. + + + + + Implement this interface to serialize datas with . + + + + + Reads or writes datas from/to the given binary serializer. + + The binary serializer. + + + + A value that specifies the size of a single degree. + + + + + A value that specifies the size of a single minute. + + + + + A value that specifies the size of a single second. + + + + + A value that specifies the size of a single radian. + + + + + A value that specifies the size of a single milliradian. + + + + + A value that specifies the size of a single gradian. + + + + + The internal representation of the angle. + + + + + Initializes a new instance of the SharpDX.AngleSingle structure with the + given unit dependant angle and unit type. + + A unit dependant measure of the angle. + The type of unit the angle argument is. + + + + Initializes a new instance of the SharpDX.AngleSingle structure using the + arc length formula (θ = s/r). + + The measure of the arc. + The radius of the circle. + + + + Wraps this SharpDX.AngleSingle to be in the range [π, -π]. + + + + + Wraps this SharpDX.AngleSingle to be in the range [0, 2π). + + + + + Wraps the SharpDX.AngleSingle given in the value argument to be in the range [π, -π]. + + A SharpDX.AngleSingle to wrap. + The SharpDX.AngleSingle that is wrapped. + + + + Wraps the SharpDX.AngleSingle given in the value argument to be in the range [0, 2π). + + A SharpDX.AngleSingle to wrap. + The SharpDX.AngleSingle that is wrapped. + + + + Compares two SharpDX.AngleSingle instances and returns the smaller angle. + + The first SharpDX.AngleSingle instance to compare. + The second SharpDX.AngleSingle instance to compare. + The smaller of the two given SharpDX.AngleSingle instances. + + + + Compares two SharpDX.AngleSingle instances and returns the greater angle. + + The first SharpDX.AngleSingle instance to compare. + The second SharpDX.AngleSingle instance to compare. + The greater of the two given SharpDX.AngleSingle instances. + + + + Adds two SharpDX.AngleSingle objects and returns the result. + + The first object to add. + The second object to add. + The value of the two objects added together. + + + + Subtracts two SharpDX.AngleSingle objects and returns the result. + + The first object to subtract. + The second object to subtract. + The value of the two objects subtracted. + + + + Multiplies two SharpDX.AngleSingle objects and returns the result. + + The first object to multiply. + The second object to multiply. + The value of the two objects multiplied together. + + + + Divides two SharpDX.AngleSingle objects and returns the result. + + The numerator object. + The denominator object. + The value of the two objects divided. + + + + Returns a System.Boolean that indicates whether the values of two SharpDX.Angle + objects are equal. + + The first object to compare. + The second object to compare. + True if the left and right parameters have the same value; otherwise, false. + + + + Returns a System.Boolean that indicates whether the values of two SharpDX.Angle + objects are not equal. + + The first object to compare. + The second object to compare. + True if the left and right parameters do not have the same value; otherwise, false. + + + + Returns a System.Boolean that indicates whether a SharpDX.Angle + object is less than another SharpDX.AngleSingle object. + + The first object to compare. + The second object to compare. + True if left is less than right; otherwise, false. + + + + Returns a System.Boolean that indicates whether a SharpDX.Angle + object is greater than another SharpDX.AngleSingle object. + + The first object to compare. + The second object to compare. + True if left is greater than right; otherwise, false. + + + + Returns a System.Boolean that indicates whether a SharpDX.Angle + object is less than or equal to another SharpDX.AngleSingle object. + + The first object to compare. + The second object to compare. + True if left is less than or equal to right; otherwise, false. + + + + Returns a System.Boolean that indicates whether a SharpDX.Angle + object is greater than or equal to another SharpDX.AngleSingle object. + + The first object to compare. + The second object to compare. + True if left is greater than or equal to right; otherwise, false. + + + + Returns the value of the SharpDX.AngleSingle operand. (The sign of + the operand is unchanged.) + + A SharpDX.AngleSingle object. + The value of the value parameter. + + + + Returns the the negated value of the SharpDX.AngleSingle operand. + + A SharpDX.AngleSingle object. + The negated value of the value parameter. + + + + Adds two SharpDX.AngleSingle objects and returns the result. + + The first object to add. + The second object to add. + The value of the two objects added together. + + + + Subtracts two SharpDX.AngleSingle objects and returns the result. + + The first object to subtract + The second object to subtract. + The value of the two objects subtracted. + + + + Multiplies two SharpDX.AngleSingle objects and returns the result. + + The first object to multiply. + The second object to multiply. + The value of the two objects multiplied together. + + + + Divides two SharpDX.AngleSingle objects and returns the result. + + The numerator object. + The denominator object. + The value of the two objects divided. + + + + Compares this instance to a specified object and returns an integer that + indicates whether the value of this instance is less than, equal to, or greater + than the value of the specified object. + + The object to compare. + + A signed integer that indicates the relationship of the current instance + to the obj parameter. If the value is less than zero, the current instance + is less than the other. If the value is zero, the current instance is equal + to the other. If the value is greater than zero, the current instance is + greater than the other. + + + + + Compares this instance to a second SharpDX.AngleSingle and returns + an integer that indicates whether the value of this instance is less than, + equal to, or greater than the value of the specified object. + + The object to compare. + + A signed integer that indicates the relationship of the current instance + to the obj parameter. If the value is less than zero, the current instance + is less than the other. If the value is zero, the current instance is equal + to the other. If the value is greater than zero, the current instance is + greater than the other. + + + + + Returns a value that indicates whether the current instance and a specified + SharpDX.AngleSingle object have the same value. + + The object to compare. + + Returns true if this SharpDX.AngleSingle object and another have the same value; + otherwise, false. + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this SharpDX.AngleSingle instance. + + A 32-bit signed integer hash code. + + + + Returns a value that indicates whether the current instance and a specified + object have the same value. + + The object to compare. + + Returns true if the obj parameter is a SharpDX.AngleSingle object or a type + capable of implicit conversion to a SharpDX.AngleSingle value, and + its value is equal to the value of the current SharpDX.Angle + object; otherwise, false. + + + + + + + + Gets or sets the total number of revolutions this SharpDX.AngleSingle represents. + + + + + Gets or sets the total number of degrees this SharpDX.AngleSingle represents. + + + + + Gets or sets the minutes component of the degrees this SharpDX.AngleSingle represents. + When setting the minutes, if the value is in the range (-60, 60) the whole degrees are + not changed; otherwise, the whole degrees may be changed. Fractional values may set + the seconds component. + + + + + Gets or sets the seconds of the degrees this SharpDX.AngleSingle represents. + When setting te seconds, if the value is in the range (-60, 60) the whole minutes + or whole degrees are not changed; otherwise, the whole minutes or whole degrees + may be changed. + + + + + Gets or sets the total number of radians this SharpDX.AngleSingle represents. + + + + + Gets or sets the total number of milliradians this SharpDX.AngleSingle represents. + One milliradian is equal to 1/(2000π). + + + + + Gets or sets the total number of gradians this SharpDX.AngleSingle represents. + + + + + Gets a System.Boolean that determines whether this SharpDX.Angle + is a right angle (i.e. 90° or π/2). + + + + + Gets a System.Boolean that determines whether this SharpDX.Angle + is a straight angle (i.e. 180° or π). + + + + + Gets a System.Boolean that determines whether this SharpDX.Angle + is a full rotation angle (i.e. 360° or 2π). + + + + + Gets a System.Boolean that determines whether this SharpDX.Angle + is an oblique angle (i.e. is not 90° or a multiple of 90°). + + + + + Gets a System.Boolean that determines whether this SharpDX.Angle + is an acute angle (i.e. less than 90° but greater than 0°). + + + + + Gets a System.Boolean that determines whether this SharpDX.Angle + is an obtuse angle (i.e. greater than 90° but less than 180°). + + + + + Gets a System.Boolean that determines whether this SharpDX.Angle + is a reflex angle (i.e. greater than 180° but less than 360°). + + + + + Gets a SharpDX.AngleSingle instance that complements this angle (i.e. the two angles add to 90°). + + + + + Gets a SharpDX.AngleSingle instance that supplements this angle (i.e. the two angles add to 180°). + + + + + Gets a new SharpDX.AngleSingle instance that represents the zero angle (i.e. 0°). + + + + + Gets a new SharpDX.AngleSingle instance that represents the right angle (i.e. 90° or π/2). + + + + + Gets a new SharpDX.AngleSingle instance that represents the straight angle (i.e. 180° or π). + + + + + Gets a new SharpDX.AngleSingle instance that represents the full rotation angle (i.e. 360° or 2π). + + + + + A boolean value stored on 4 bytes (instead of 1 in .NET). + + + + + Initializes a new instance of the class. + + if set to true [bool value]. + + + + Indicates whether this instance and a specified object are equal. + + The other. + true if and this instance are the same type and represent the same value; otherwise, false. + + + + Implements the ==. + + The left. + The right. + The result of the operator. + + + + Implements the !=. + + The left. + The right. + The result of the operator. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + + + + Represents an axis-aligned bounding box in three dimensional space. + + + + + The minimum point of the box. + + + + + The maximum point of the box. + + + + + Initializes a new instance of the struct. + + The minimum vertex of the bounding box. + The maximum vertex of the bounding box. + + + + Retrieves the eight corners of the bounding box. + + An array of points representing the eight corners of the bounding box. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The plane to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The box to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The sphere to test. + Whether the two objects intersected. + + + + Determines whether the current objects contains a point. + + The point to test. + The type of containment the two objects have. + + + + Determines whether the current objects contains a . + + The box to test. + The type of containment the two objects have. + + + + Determines whether the current objects contains a . + + The sphere to test. + The type of containment the two objects have. + + + + Constructs a that fully contains the given points. + + The points that will be contained by the box. + When the method completes, contains the newly constructed bounding box. + Thrown when is null. + + + + Constructs a that fully contains the given points. + + The points that will be contained by the box. + The newly constructed bounding box. + Thrown when is null. + + + + Constructs a from a given sphere. + + The sphere that will designate the extents of the box. + When the method completes, contains the newly constructed bounding box. + + + + Constructs a from a given sphere. + + The sphere that will designate the extents of the box. + The newly constructed bounding box. + + + + Constructs a that is as large as the total combined area of the two specified boxes. + + The first box to merge. + The second box to merge. + When the method completes, contains the newly constructed bounding box. + + + + Constructs a that is as large as the total combined area of the two specified boxes. + + The first box to merge. + The second box to merge. + The newly constructed bounding box. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Defines a frustum which can be used in frustum culling, zoom to Extents (zoom to fit) operations, + (matrix, frustum, camera) interchange, and many kind of intersection testing. + + + + + Creates a new instance of BoundingFrustum. + + Combined matrix that usually takes view × projection matrix. + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + Returns one of the 6 planes related to this frustum. + + Plane index where 0 fro Left, 1 for Right, 2 for Top, 3 for Bottom, 4 for Near, 5 for Far + + + + + Creates a new frustum relaying on perspective camera parameters + + The camera pos. + The look dir. + Up dir. + The fov. + The znear. + The zfar. + The aspect. + The bouding frustum calculated from perspective camera + + + + Creates a new frustum relaying on perspective camera parameters + + The camera params. + The bouding frustum from camera params + + + + Returns the 8 corners of the frustum, element0 is Near1 (near right down corner) + , element1 is Near2 (near right top corner) + , element2 is Near3 (near Left top corner) + , element3 is Near4 (near Left down corner) + , element4 is Far1 (far right down corner) + , element5 is Far2 (far right top corner) + , element6 is Far3 (far left top corner) + , element7 is Far4 (far left down corner) + + The 8 corners of the frustum + + + + Extracts perspective camera parameters from the frustum, dosn't work with orthographic frustums. + + Perspective camera parameters from the frustum + + + + Checks whether a point lay inside, intersects or lay outside the frustum. + + The point. + Type of the containment + + + + Checks whether a point lay inside, intersects or lay outside the frustum. + + The point. + Type of the containment + + + + Checks whether a group of points lay totally inside the frustum (Contains), or lay partially inside the frustum (Intersects), or lay outside the frustum (Disjoint). + + The points. + Type of the containment + + + + Checks whether a group of points lay totally inside the frsutrum (Contains), or lay partially inside the frustum (Intersects), or lay outside the frustum (Disjoint). + + The points. + Type of the containment. + + + + Determines the intersection relationship between the frustum and a bounding box. + + The box. + Type of the containment + + + + Determines the intersection relationship between the frustum and a bounding box. + + The box. + Type of the containment. + + + + Determines the intersection relationship between the frustum and a bounding sphere. + + The sphere. + Type of the containment + + + + Determines the intersection relationship between the frustum and a bounding sphere. + + The sphere. + Type of the containment. + + + + Determines the intersection relationship between the frustum and another bounding frustum. + + The frustum. + Type of the containment + + + + Determines the intersection relationship between the frustum and another bounding frustum. + + The frustum. + Type of the containment. + + + + Checks whether the current BoundingFrustum intersects a BoundingSphere. + + The sphere. + Type of the containment + + + + Checks whether the current BoundingFrustum intersects a BoundingSphere. + + The sphere. + Set to true if the current BoundingFrustum intersects a BoundingSphere. + + + + Checks whether the current BoundingFrustum intersects a BoundingBox. + + The box. + true if the current BoundingFrustum intersects a BoundingSphere. + + + + Checks whether the current BoundingFrustum intersects a BoundingBox. + + The box. + true if the current BoundingFrustum intersects a BoundingSphere. + + + + Checks whether the current BoundingFrustum intersects the specified Plane. + + The plane. + Plane intersection type. + + + + Checks whether the current BoundingFrustum intersects the specified Plane. + + The plane. + Plane intersection type. + + + + Get the width of the frustum at specified depth. + + the depth at which to calculate frustum width. + With of the frustum at the specified depth + + + + Get the height of the frustum at specified depth. + + the depth at which to calculate frustum height. + Height of the frustum at the specified depth + + + + Checks whether the current BoundingFrustum intersects the specified Ray. + + The ray. + true if the current BoundingFrustum intersects the specified Ray. + + + + Checks whether the current BoundingFrustum intersects the specified Ray. + + The Ray to check for intersection with. + The distance at which the ray enters the frustum if there is an intersection and the ray starts outside the frustum. + The distance at which the ray exits the frustum if there is an intersection. + true if the current BoundingFrustum intersects the specified Ray. + + + + Get the distance which when added to camera position along the lookat direction will do the effect of zoom to extents (zoom to fit) operation, + so all the passed points will fit in the current view. + if the returned value is poistive, the camera will move toward the lookat direction (ZoomIn). + if the returned value is negative, the camera will move in the revers direction of the lookat direction (ZoomOut). + + The points. + The zoom to fit distance + + + + Get the distance which when added to camera position along the lookat direction will do the effect of zoom to extents (zoom to fit) operation, + so all the passed points will fit in the current view. + if the returned value is poistive, the camera will move toward the lookat direction (ZoomIn). + if the returned value is negative, the camera will move in the revers direction of the lookat direction (ZoomOut). + + The bounding box. + The zoom to fit distance + + + + Get the vector shift which when added to camera position will do the effect of zoom to extents (zoom to fit) operation, + so all the passed points will fit in the current view. + + The points. + The zoom to fit vector + + + + Get the vector shift which when added to camera position will do the effect of zoom to extents (zoom to fit) operation, + so all the passed points will fit in the current view. + + The bounding box. + The zoom to fit vector + + + + + + + Gets or sets the Matrix that describes this bounding frustum. + + + + + Gets the near plane of the BoundingFrustum. + + + + + Gets the far plane of the BoundingFrustum. + + + + + Gets the left plane of the BoundingFrustum. + + + + + Gets the right plane of the BoundingFrustum. + + + + + Gets the top plane of the BoundingFrustum. + + + + + Gets the bottom plane of the BoundingFrustum. + + + + + Indicate whether the current BoundingFrustrum is Orthographic. + + + true if the current BoundingFrustrum is Orthographic; otherwise, false. + + + + + Represents a bounding sphere in three dimensional space. + + + + + The center of the sphere in three dimensional space. + + + + + The radious of the sphere. + + + + + Initializes a new instance of the struct. + + The center of the sphere in three dimensional space. + The radius of the sphere. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The plane to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a triangle. + + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The box to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The sphere to test. + Whether the two objects intersected. + + + + Determines whether the current objects contains a point. + + The point to test. + The type of containment the two objects have. + + + + Determines whether the current objects contains a triangle. + + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + The type of containment the two objects have. + + + + Determines whether the current objects contains a . + + The box to test. + The type of containment the two objects have. + + + + Determines whether the current objects contains a . + + The sphere to test. + The type of containment the two objects have. + + + + Constructs a that fully contains the given points. + + The points that will be contained by the sphere. + When the method completes, contains the newly constructed bounding sphere. + + + + Constructs a that fully contains the given points. + + The points that will be contained by the sphere. + The newly constructed bounding sphere. + + + + Constructs a from a given box. + + The box that will designate the extents of the sphere. + When the method completes, the newly constructed bounding sphere. + + + + Constructs a from a given box. + + The box that will designate the extents of the sphere. + The newly constructed bounding sphere. + + + + Constructs a that is the as large as the total combined area of the two specified spheres. + + The first sphere to merge. + The second sphere to merge. + When the method completes, contains the newly constructed bounding sphere. + + + + Constructs a that is the as large as the total combined area of the two specified spheres. + + The first sphere to merge. + The second sphere to merge. + The newly constructed bounding sphere. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Callback base implementation of . + + + + + Base class for a class. + + + + + Releases unmanaged resources and performs other cleanup operations before the + is reclaimed by garbage collection. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Occurs when this instance is starting to be disposed. + + + + + Occurs when this instance is fully disposed. + + + + + Gets a value indicating whether this instance is disposed. + + + true if this instance is disposed; otherwise, false. + + + + + Use this interface to tag a class that is called by an unmanaged + object. A class must dispose the + on dispose. + + + + + Gets or sets the unmanaged shadow callback. + + The unmanaged shadow callback. + + This property is set whenever this instance has an unmanaged shadow callback + registered. This callback must be disposed when disposing this instance. + + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + An observable collection. + + Type of a collection item + + + + Raised when an item is added to this instance. + + + + + + Raised when a item is removed from this instance. + + + + + + An event providing the item changed in a collection (inserted or removed). + + Type of a collection item + + + + Initializes a new instance of the class. + + The item from the collection. + + + + Gets the item from the collection that was inserted or removed. + + The collection item. + + + + Defines the viewport dimensions using float coordinates for (X,Y,Width,Height). + + + + + Position of the pixel coordinate of the upper-left corner of the viewport. + + + + + Position of the pixel coordinate of the upper-left corner of the viewport. + + + + + Width dimension of the viewport. + + + + + Height dimension of the viewport. + + + + + Gets or sets the minimum depth of the clip volume. + + + + + Gets or sets the maximum depth of the clip volume. + + + + + Initializes a new instance of the struct. + + The x coordinate of the upper-left corner of the viewport in pixels. + The y coordinate of the upper-left corner of the viewport in pixels. + The width of the viewport in pixels. + The height of the viewport in pixels. + + + + Initializes a new instance of the struct. + + The x coordinate of the upper-left corner of the viewport in pixels. + The y coordinate of the upper-left corner of the viewport in pixels. + The width of the viewport in pixels. + The height of the viewport in pixels. + The minimum depth of the clip volume. + The maximum depth of the clip volume. + + + + Initializes a new instance of the struct. + + A bounding box that defines the location and size of the viewport in a render target. + + + + Retrieves a string representation of this object. + + A that represents this instance. + + + + Projects a 3D vector from object space into screen space. + + The vector to project. + The projection matrix. + The view matrix. + The world matrix. + Vector3. + + + + Converts a screen space point into a corresponding point in world space. + + The vector to project. + The projection matrix. + The view matrix. + The world matrix. + Vector3. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Gets the size of this resource. + + The bounds. + + + + Gets the aspect ratio used by the viewport + + The aspect ratio. + + + + Defines a type converter for . + + + + + Provides a base class for mathematical type converters. + + + + + Converts values to a string. + + Type of the value + The context. + The culture. + The values. + A string representing the values + + + + Converts a string to values. + + Type of the value + The context. + The culture. + The string value. + An array of value or null if strValue is not a string. + + + + Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. + + An that provides a format context. + A that represents the type you want to convert from. + + true if this converter can perform the conversion; otherwise, false. + + + + + Returns whether this converter can convert the object to the specified type, using the specified context. + + An that provides a format context. + A that represents the type you want to convert to. + + true if this converter can perform the conversion; otherwise, false. + + + + + Returns whether changing a value on this object requires a call to to create a new value, using the specified context. + + An that provides a format context. + + true if changing a property on this object requires a call to to create a new value; otherwise, false. + + + + + Gets a value indicating whether this object supports properties using the specified context. + + An that provides a format context. + + true because should be called to find the properties of this object. This method never returns false. + + + + + Gets a collection of properties for the type of object specified by the value parameter. + + An that provides a format context. + An that specifies the type of object to get the properties for. + An array of type that will be used as a filter. + + A with the properties that are exposed for the component, or null if there are no properties. + + + + + Gets or sets the collection of exposed properties. + + The collection of exposed properties. + + + + Initializes a new instance of the class. + + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the parameter to. + + An that represents the converted value. + + + The parameter is null. + + + The conversion cannot be performed. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + + The conversion cannot be performed. + + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + An that provides a format context. + An of new property values. + + An representing the given , or null if the object cannot be created. This method always returns null. + + + + + A fast method to pass array of to SharpDX methods. + + + + + Initializes a new instance of the class. + + The array. + + + + Initializes a new instance of the class. + + The size. + + + + Gets an object at the specified index. + + The index. + A + + + + Sets an object at the specified index. + + The index. + The value. + + + + + + + Gets the pointer to the native array associated to this instance. + + + + + Gets the length. + + + + + A typed version of + + Type of the + + + + Initializes a new instance of the class. + + The array. + + + + Initializes a new instance of the class. + + The size. + + + + Gets or sets the with the specified i. + + + + + Generic class to hold a shader compilation results. + + Type of the class containing the generated bytecode. + + + + Initializes a new instance of the class. + + The bytecode. + Result code from compilation. + The message. + + + + + + + Gets the Shader bytecode. + + + + + Gets the result code from the compilation. + + + + + Gets a value indicating whether this instance has errors. + + + true if this instance has errors; otherwise, false. + + + + + Gets the message. + + + Message are warning or error messages. + + + + + Represents a four dimensional mathematical vector of bool (32 bits per bool value). + + + + + The size of the type, in bytes. + + + + + A with all of its components set to false. + + + + + The X unit (true, 0, 0, 0). + + + + + The Y unit (0, true, 0, 0). + + + + + The Z unit (0, 0, true, 0). + + + + + The W unit (0, 0, 0, true). + + + + + A with all of its components set to true. + + + + + The X component of the vector. + + + + + The Y component of the vector. + + + + + The Z component of the vector. + + + + + The W component of the vector. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + Initial value for the X component of the vector. + Initial value for the Y component of the vector. + Initial value for the Z component of the vector. + Initial value for the W component of the vector. + + + + Initializes a new instance of the struct. + + The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Creates an array containing the elements of the vector. + + A four-element array containing the components of the vector. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Performs an implicit conversion from array to . + + The input. + The result of the conversion. + + + + Performs an implicit conversion from to array. + + The input. + The result of the conversion. + + + + + + + The X component of the vector. + + + + + The Y component of the vector. + + + + + The Z component of the vector. + + + + + The W component of the vector. + + + + + Gets or sets the component at the specified index. + + The value of the X, Y, Z, or W component, depending on the index. + The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + The assembly is the core assembly providing infrastructure for all managed DirectX API. + + + + + Represents a 32-bit color (4 bytes) in the form of RGBA (in byte order: R, G, B, A). + + + List of predefined . + + + + + The red component of the color. + + + + + The green component of the color. + + + + + The blue component of the color. + + + + + The alpha component of the color. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The red component of the color. + The green component of the color. + The blue component of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + The red component of the color. + The green component of the color. + The blue component of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + The red, green, blue, and alpha components of the color. + + + + Initializes a new instance of the struct. + + The red, green, and blue compoennts of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + A packed integer containing all four color components in RGBA order. + + + + Initializes a new instance of the struct. + + A packed integer containing all four color components in RGBA order. + + + + Initializes a new instance of the struct. + + The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Initializes a new instance of the struct. + + The values to assign to the alpha, red, green, and blue components of the color. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Converts the color into a packed integer. + + A packed integer containing all four color components. + + + + Converts the color into a packed integer. + + A packed integer containing all four color components. + + + + Converts the color into a three component vector. + + A three component vector containing the red, green, and blue components of the color. + + + + Converts the color into a three component color. + + A three component color containing the red, green, and blue components of the color. + + + + Converts the color into a four component vector. + + A four component vector containing all four color components. + + + + Creates an array containing the elements of the color. + + A four-element array containing the components of the color in RGBA order. + + + + Gets the brightness. + + The Hue-Saturation-Brightness (HSB) saturation for this + + + + Gets the hue. + + The Hue-Saturation-Brightness (HSB) saturation for this + + + + Gets the saturation. + + The Hue-Saturation-Brightness (HSB) saturation for this + + + + Adds two colors. + + The first color to add. + The second color to add. + When the method completes, completes the sum of the two colors. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + WHen the method completes, contains the difference of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract + The difference of the two colors. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + When the method completes, contains the modulated color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + When the method completes, contains the scaled color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + The scaled color. + + + + Negates a color. + + The color to negate. + When the method completes, contains the negated color. + + + + Negates a color. + + The color to negate. + The negated color. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Converts the color from a packed BGRA integer. + + A packed integer containing all four color components in BGRA order + A color. + + + + Converts the color from a packed BGRA integer. + + A packed integer containing all four color components in BGRA order + A color. + + + + Converts the color from a packed BGRA integer. + + A packed integer containing all four color components in RGBA order + A color. + + + + Converts the color from a packed BGRA integer. + + A packed integer containing all four color components in RGBA order + A color. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two colors. + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two colors. + + + + Returns a color containing the smallest components of the specified colorss. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the largest components of the source colorss. + + + + Returns a color containing the largest components of the specified colorss. + + The first source color. + The second source color. + A color containing the largest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the smallest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + A color containing the smallest components of the source colors. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + When the method completes, contains the adjusted color. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + The adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + When the method completes, contains the adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + The adjusted color. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Assert a color (return it unchanged). + + The color to assert (unchange). + The asserted (unchanged) color. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + The difference of the two colors. + + + + Negates a color. + + The color to negate. + A negated color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + + The result of the conversion. + + + + + Performs an explicit conversion from to . + + The value. + + The result of the conversion. + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Zero color. + + + + + Transparent color. + + + + + AliceBlue color. + + + + + AntiqueWhite color. + + + + + Aqua color. + + + + + Aquamarine color. + + + + + Azure color. + + + + + Beige color. + + + + + Bisque color. + + + + + Black color. + + + + + BlanchedAlmond color. + + + + + Blue color. + + + + + BlueViolet color. + + + + + Brown color. + + + + + BurlyWood color. + + + + + CadetBlue color. + + + + + Chartreuse color. + + + + + Chocolate color. + + + + + Coral color. + + + + + CornflowerBlue color. + + + + + Cornsilk color. + + + + + Crimson color. + + + + + Cyan color. + + + + + DarkBlue color. + + + + + DarkCyan color. + + + + + DarkGoldenrod color. + + + + + DarkGray color. + + + + + DarkGreen color. + + + + + DarkKhaki color. + + + + + DarkMagenta color. + + + + + DarkOliveGreen color. + + + + + DarkOrange color. + + + + + DarkOrchid color. + + + + + DarkRed color. + + + + + DarkSalmon color. + + + + + DarkSeaGreen color. + + + + + DarkSlateBlue color. + + + + + DarkSlateGray color. + + + + + DarkTurquoise color. + + + + + DarkViolet color. + + + + + DeepPink color. + + + + + DeepSkyBlue color. + + + + + DimGray color. + + + + + DodgerBlue color. + + + + + Firebrick color. + + + + + FloralWhite color. + + + + + ForestGreen color. + + + + + Fuchsia color. + + + + + Gainsboro color. + + + + + GhostWhite color. + + + + + Gold color. + + + + + Goldenrod color. + + + + + Gray color. + + + + + Green color. + + + + + GreenYellow color. + + + + + Honeydew color. + + + + + HotPink color. + + + + + IndianRed color. + + + + + Indigo color. + + + + + Ivory color. + + + + + Khaki color. + + + + + Lavender color. + + + + + LavenderBlush color. + + + + + LawnGreen color. + + + + + LemonChiffon color. + + + + + LightBlue color. + + + + + LightCoral color. + + + + + LightCyan color. + + + + + LightGoldenrodYellow color. + + + + + LightGray color. + + + + + LightGreen color. + + + + + LightPink color. + + + + + LightSalmon color. + + + + + LightSeaGreen color. + + + + + LightSkyBlue color. + + + + + LightSlateGray color. + + + + + LightSteelBlue color. + + + + + LightYellow color. + + + + + Lime color. + + + + + LimeGreen color. + + + + + Linen color. + + + + + Magenta color. + + + + + Maroon color. + + + + + MediumAquamarine color. + + + + + MediumBlue color. + + + + + MediumOrchid color. + + + + + MediumPurple color. + + + + + MediumSeaGreen color. + + + + + MediumSlateBlue color. + + + + + MediumSpringGreen color. + + + + + MediumTurquoise color. + + + + + MediumVioletRed color. + + + + + MidnightBlue color. + + + + + MintCream color. + + + + + MistyRose color. + + + + + Moccasin color. + + + + + NavajoWhite color. + + + + + Navy color. + + + + + OldLace color. + + + + + Olive color. + + + + + OliveDrab color. + + + + + Orange color. + + + + + OrangeRed color. + + + + + Orchid color. + + + + + PaleGoldenrod color. + + + + + PaleGreen color. + + + + + PaleTurquoise color. + + + + + PaleVioletRed color. + + + + + PapayaWhip color. + + + + + PeachPuff color. + + + + + Peru color. + + + + + Pink color. + + + + + Plum color. + + + + + PowderBlue color. + + + + + Purple color. + + + + + Red color. + + + + + RosyBrown color. + + + + + RoyalBlue color. + + + + + SaddleBrown color. + + + + + Salmon color. + + + + + SandyBrown color. + + + + + SeaGreen color. + + + + + SeaShell color. + + + + + Sienna color. + + + + + Silver color. + + + + + SkyBlue color. + + + + + SlateBlue color. + + + + + SlateGray color. + + + + + Snow color. + + + + + SpringGreen color. + + + + + SteelBlue color. + + + + + Tan color. + + + + + Teal color. + + + + + Thistle color. + + + + + Tomato color. + + + + + Turquoise color. + + + + + Violet color. + + + + + Wheat color. + + + + + White color. + + + + + WhiteSmoke color. + + + + + Yellow color. + + + + + YellowGreen color. + + + + + Gets or sets the component at the specified index. + + The value of the alpha, red, green, or blue component, depending on the index. + The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + Represents a 32-bit color (4 bytes) in the form of BGRA (in byte order: B, G, B, A). + + + + + The blue component of the color. + + + + + The green component of the color. + + + + + The red component of the color. + + + + + The alpha component of the color. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The red component of the color. + The green component of the color. + The blue component of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + The red component of the color. + The green component of the color. + The blue component of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + The red, green, blue, and alpha components of the color. + + + + Initializes a new instance of the struct. + + The red, green, and blue compoennts of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + A packed integer containing all four color components in BGRA order. + + + + Initializes a new instance of the struct. + + A packed integer containing all four color components in BGRA. + + + + Initializes a new instance of the struct. + + The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Initializes a new instance of the struct. + + The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Converts the color into a packed integer. + + A packed integer containing all four color components. + + + + Converts the color into a packed integer. + + A packed integer containing all four color components. + + + + Converts the color into a three component vector. + + A three component vector containing the red, green, and blue components of the color. + + + + Converts the color into a three component color. + + A three component color containing the red, green, and blue components of the color. + + + + Converts the color into a four component vector. + + A four component vector containing all four color components. + + + + Creates an array containing the elements of the color. + + A four-element array containing the components of the color in BGRA order. + + + + Gets the brightness. + + The Hue-Saturation-Brightness (HSB) saturation for this + + + + Gets the hue. + + The Hue-Saturation-Brightness (HSB) saturation for this + + + + Gets the saturation. + + The Hue-Saturation-Brightness (HSB) saturation for this + + + + Converts the color from a packed BGRA integer. + + A packed integer containing all four color components in BGRA order + A color. + + + + Converts the color from a packed BGRA integer. + + A packed integer containing all four color components in BGRA order + A color. + + + + Converts the color from a packed RGBA integer. + + A packed integer containing all four color components in RGBA order + A color. + + + + Converts the color from a packed RGBA integer. + + A packed integer containing all four color components in RGBA order + A color. + + + + Adds two colors. + + The first color to add. + The second color to add. + When the method completes, completes the sum of the two colors. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + WHen the method completes, contains the difference of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract + The difference of the two colors. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + When the method completes, contains the modulated color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + When the method completes, contains the scaled color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + The scaled color. + + + + Negates a color. + + The color to negate. + When the method completes, contains the negated color. + + + + Negates a color. + + The color to negate. + The negated color. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two colors. + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two colors. + + + + Returns a color containing the smallest components of the specified colorss. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the largest components of the source colorss. + + + + Returns a color containing the largest components of the specified colorss. + + The first source color. + The second source color. + A color containing the largest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the smallest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + A color containing the smallest components of the source colors. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + When the method completes, contains the adjusted color. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + The adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + When the method completes, contains the adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + The adjusted color. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Assert a color (return it unchanged). + + The color to assert (unchange). + The asserted (unchanged) color. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + The difference of the two colors. + + + + Negates a color. + + The color to negate. + A negated color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + + The result of the conversion. + + + + + Performs an explicit conversion from to . + + The value. + + The result of the conversion. + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Gets or sets the component at the specified index. + + The value of the alpha, red, green, or blue component, depending on the index. + The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + Defines a type converter for . + + + + + Initializes a new instance of the class. + + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the parameter to. + + An that represents the converted value. + + + The parameter is null. + + + The conversion cannot be performed. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + + The conversion cannot be performed. + + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + An that provides a format context. + An of new property values. + + An representing the given , or null if the object cannot be created. This method always returns null. + + + + + Base interface for a component base. + + + + + Gets the name of this component. + + The name. + + + + A service registry is a that provides methods to register and unregister services. + + + + + Adds a service to this service provider. + + The type of service to add. + The instance of the service provider to add. + Service type cannot be null + Service is already registered + + + + Removes the object providing a specified service. + + The type of service. + + + + Occurs when a new service is added. + + + + + Occurs when when a service is removed. + + + + + Path utility methods. + + + + + Transform a path by replacing '/' by '\' and transforming relative '..' or current path '.' to an absolute path. See remarks. + + A path string + A normalized path. + + Unlike , this doesn't make a path absolute to the actual file system. + + + + + Specify the size used for encoding length for array while using a , just before an array is encoded. + + + + + Use variable length 7Bit Encoding that will output from 1 byte to 5 byte depending on the range of length value. + + + + + Output a length as a byte. The length must not be greater than 255. + + + + + Output a length as an ushort. The length must not be greater than 65535. + + + + + Output a length as an int. The length must not be greater than 2^31 - 1. + + + + + The namespace contains a serialization API. + + + + + Flags used when serializing a value with a . + + + + + Normal serialize (not dynamic, not nullable). + + + + + Serialize a value as a dynamic value (the output stream will contain a magic-code for each encoded object). + + + + + Serialize a value that can be null. + + + + + A singleton string is a string that has a unique instance in memory, See remarks for usage scenarios. + + + This class should mostly be used internally for performance reasons, in scenarios where equals/hashcode + could be invoked frequently, and the set of strings is limited. Internally, + string is using the method and also is precaching the hashcode of the string. + + + + + Initializes a new instance of the struct. + + The text. + + + + Implements the operator ==. + + The left. + The right. + The result of the operator. + + + + Implements the operator !=. + + The left. + The right. + The result of the operator. + + + + Implements the operator ==. + + The left. + The right. + The result of the operator. + + + + Implements the operator !=. + + The left. + The right. + The result of the operator. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explcit conversion from to . + + The value. + The result of the conversion. + + + + A lighweight Component base class. + + + + + Occurs while this component is disposing and before it is disposed. + + + + + Gets or sets a value indicating whether the name of this instance is immutable. + + true if this instance is name immutable; otherwise, false. + + + + Initializes a new instance of the class with a mutable name. + + + + + Initializes a new instance of the class with an immutable name. + + The name. + + + + Gets the name of this component. + + The name. + + + + Gets or sets the tag associated to this object. + + The tag. + + + + Pointer to a native buffer with a specific size. + + + + + Gets an Empty Data Pointer. + + + + + Initializes a new instance of the struct. + + The pointer. + The size. + + + + Initializes a new instance of the struct. + + The pointer. + The size. + + + + Pointer to the buffer. + + + + + Size in bytes of the buffer. + + + + + Implements the ==. + + The left. + The right. + The result of the operator. + + + + Implements the !=. + + The left. + The right. + The result of the operator. + + + + The namespace contains design-time converters for all vectors structures. + + + + + The namespace contains classes to help to diagnostic of COM object lifecycles Dispose and Release methods. + + + + + The namespace contains enumerations and structures shared by , and assemblies. + + + + + A class to dispose instances and allocated unmanaged memory. + + + + + Disposes of object resources. + + If true, managed resources should be + disposed of in addition to unmanaged resources. + + + + Adds a object or a allocated using to the list of the objects to dispose. + + To dispose. + If toDispose argument is not IDisposable or a valid memory pointer allocated by + + + + Dispose a disposable object and set the reference to null. Removes this object from this instance.. + + Object to dispose. + + + + Removes a disposable object to the list of the objects to dispose. + + + To dispose. + + + + Gets the number of elements to dispose. + + The number of elements to dispose. + + + + Frustum camera parameters. + + + + + Position of the camera. + + + + + Looking at direction of the camera. + + + + + Up direction. + + + + + Field of view. + + + + + Z near distance. + + + + + Z far distance. + + + + + Aspect ratio. + + + + + Equality comparer using the identify of the object. + + Type of the parameter + + From http://stackoverflow.com/questions/8946790/how-to-use-an-objects-identity-as-key-for-dictionaryk-v. + + + + + Represents a three dimensional mathematical int vector. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + The X unit (1, 0, 0). + + + + + The Y unit (0, 1, 0). + + + + + The Z unit (0, 0, 1). + + + + + A with all of its components set to one. + + + + + The X component of the vector. + + + + + The Y component of the vector. + + + + + The Z component of the vector. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + Initial value for the X component of the vector. + Initial value for the Y component of the vector. + Initial value for the Z component of the vector. + + + + Initializes a new instance of the struct. + + The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Creates an array containing the elements of the vector. + + A four-element array containing the components of the vector. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + When the method completes, contains the sum of the two vectors. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + When the method completes, contains the difference of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + When the method completes, contains the modulated vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + The modulated vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Reverses the direction of a given vector. + + The vector to negate. + When the method completes, contains a vector facing in the opposite direction. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the largest components of the source vectors. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the largest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the smallest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the smallest components of the source vectors. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Assert a vector (return it unchanged). + + The vector to assert (unchange). + The asserted (unchanged) vector. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Performs an implicit conversion from array to . + + The input. + The result of the conversion. + + + + Performs an implicit conversion from to array. + + The input. + The result of the conversion. + + + + Gets or sets the component at the specified index. + + The value of the X, Y, Z, or W component, depending on the index. + The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + The namespace contains helper classes in replacement of some classes in useful under Windows 8 Metro. + + + + + This enumeration defines constants that indicate the role that the system has assigned to an audio endpoint device. + + dd370842 + ERole + ERole + + + + Games, system notification sounds, and voice commands + + + + + Music, movies, narration, and live music recording. + + + + + Voice communications (talking to another person). + + + + + The namespace contains common structures and helper classes for audio/video processing. + + + + + Use this attribute to specify the id of a dynamic type with . + + + + + Initializes a new instance of the class. + + The id to register as a dynamic type. + + + + Initializes a new instance of the class. + + The id to register as a dynamic type. + + + + Gets the id. + + The id. + + + + Exceptions thrown when an invalid chunk is decoded. + + + + + Initializes a new instance of the class with a specified error message. + + The chunk id. + The expected chunk id. + + + + Gets the chunk id. + + The chunk id. + + + + Gets the expected chunk id. + + The expected chunk id. + + + + Serializer action. + + The value to read or write. + The serializer. + + + + This class provides serialization methods for types implementing the . + + + BinarySerializer is a basic binary serializer with the following features: +
    +
  • 10x times faster and smaller than default System Serialization and Xml Serialization.
  • +
  • Supports for all primitive types, array/List<T>/Dictionary of primitive types, custom data via (struct or class) and array/List/Dictionary of custom data.
  • +
  • Optimized binary format, data serialized to the strict minimum.
  • +
  • Should be compatible with Win8/WinRT, Desktop.
  • +
  • Not reflection based serializer, but fully compile time serializer.
  • +
  • Format could be readback from C/C++.
  • + +
+
+
+ + + Initializes a new instance of the class. + + The stream to read or write to. + The read or write mode. + + + + Initializes a new instance of the class. + + The stream to read or write to. + The read or write mode. + Default encoding used for strings. This parameter can be overriden later using Encoding property. + + + + Gets a tag value with the specified key. + + The tag key. + A tag value associated to a key + + + + Determines whether a tag with a specified key is already stored. + + The key. + true if a tag with a specified key is already stored; otherwise, false. + + + + Removes a tag with the specified key. + + The key. + + + + Sets a tag value with the specified key. + + The key. + The value. + + + + + Register a dynamic serializer for a particular type implementing the interface and having the . + + Type of the element to serialize. + + + + Register a dynamic serializer for a particular type implementing the interface. + + Type of the element to serialize. + The id to use for serializing T. + + + + Register a dynamic array serializer for a particular type implementing the interface. + + Type of the element in the array. + The id to use for serializing T[]. + + + + Register a dynamic List<T> serializer for a particular type implementing the interface. + + Type of the element in the List<T>. + The id to use for serializing List<T>. + + + + Register a dynamic serializer using an external action. + + Type of the element to serialize. + The id to use for serializing T. + The serializer. + + + + Begin to serialize a a new chunk. + + The chunk id. + If the chuck to read is not the expecting chunk. + + A Chunk is an identifiable portion of data that will serialized. Chunk are usefull to encapsulate a variable + data (and check for the presence of the chunk Id). Chunk are storing a 4 bytes identifier and the length of + the chunk before reading/writing actual datas. + + + + + Ends a chunk. + + If there EndChunk is called without a previous BeginChunk. + If the size of data read from the chunk is different from chunk size. + + + + Deserialize a data from the underlying stream. + + Type of the data to load. + An instance of the loaded data. + + + + Serializes the specified value to the underlying stream. + + Type of the data to save. + The value to save. + + + + Flush the underlying + + + + + Serializes a dynamic value that can be nullable. + + Known type of the value to serialize. The known type is not the runtime type that will be actually serialized. + The value to serialize based on its runtime type. + + + + Serializes a dynamic value. + + Known type of the value to serialize. The known type is not the runtime type that will be actually serialized. + The value to serialize based on its runtime type. + Type of serialization, see . + + + + Serializes a static value implementing the interface. + + Type of the data to serialize. + The value to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a static value implementing the interface. Unlike , + this method doesn't allocate a new instance when reading but use the reference value. + + Type of the data to serialize. + The value to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes an enum value. + + Type of the enum to serialize. + The value to serialize + If type T is not an enum. + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes an array of primitives using serialization methods implemented by this instance for each item in the array. + + Type of the primitive data to serialize. + An array of primitive value to serialize + The serializer to user to serialize the T values. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes count elements in an array of primitives using serialization methods implemented by this instance for each item in the array. + + Type of the primitive data to serialize. + An array of primitive value to serialize + Count elements to serialize. See remarks. + The serializer to user to serialize the T values. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value.
+ Caution: Also unlike the plain array version, the count is not serialized. This method is usefull + when we want to serialize the count of an array separately from the array. +
+
+ + + Serializes an array of static values that are implementing the interface. + + Type of the data to serialize. + An array of value to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes an array of static values that are implementing the interface. + + Type of the data to serialize. + An array of value to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes count elements in an array of static values that are implementing the interface. + + Type of the data to serialize. + An array of value to serialize + Count elements to serialize. See remarks. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value.
+ Caution: Also unlike the plain array version, the count is not serialized. This method is usefull + when we want to serialize the count of an array separately from the array. +
+
+ + + Serializes an array of bytes. + + An array of bytes to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes an array of bytes. + + An array of bytes to serialize + Count elements to serialize. See remarks. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value.
+ Caution: Also unlike the plain array version, the count is not serialized. This method is usefull + when we want to serialize the count of an array separately from the array. +
+
+ + + Serializes a list of static values that are implementing the interface. + + Type of the data to serialize. + A list of value to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a list of primitive values using a specific serializer method from this instance. + + Type of the data to serialize. + A list of value to serialize + A method of this instance to serialize the primitive T type + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes count elements from a list of static values that are implementing the interface. + + Type of the data to serialize. + A list of value to serialize + Count elements to serialize. See remarks. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value.
+ Caution: Also unlike the plain array version, the count is not serialized. This method is usefull + when we want to serialize the count of an array separately from the array. +
+
+ + + Serializes count elements from a list of primitive values using a specific serializer method from this instance. + + Type of the data to serialize. + A list of value to serialize + A method of this instance to serialize the primitive T type + Count elements to serialize. See remarks. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value.
+ Caution: Also unlike the plain array version, the count is not serialized. This method is usefull + when we want to serialize the count of an array separately from the array. +
+
+ + + Serializes a dictionary of key/values that are both implementing the interface. + + Type of key to serialize. + Type of value to serialize. + A dictionary to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a dictionary of key/values. + + Type of key to serialize that is implementing the interface. + Type of primitive value with its associated serializer. + A dictionary to serialize + Serializer used for the TValue. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a dictionary of key/values. + + Type of primitive value with its associated serializer. + Type of value to serialize that is implementing the interface. + A dictionary to serialize + Serializer used for the TKey. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a dictionary of key/values. + + Type of primitive key with its associated serializer. + Type of primitive value with its associated serializer. + A dictionary to serialize + Serializer used for the TKey. + Serializer used for the TValue. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single string value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + This string is serialized with the current set on this instance. + + + + + Serializes a single string value. + + The value to serialize + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + This string is serialized with the current set on this instance. + + + + + Serializes a single string value. + + The value to serialize + Write a null byte at the end of the string. + Type of serialization, see . + + Note that depending on the serialization , this method reads or writes the value. + This string is serialized with the current set on this instance. + + + + + Serializes a single fixed length string value. + + The value to serialize + Read/write a specific number of characters. + + Note that depending on the serialization , this method reads or writes the value. + This string is serialized with the current set on this instance. + + + + + Serializes a single boolean value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single byte value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single sbyte value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single short value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single ushort value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single int value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single int as a packed value (from 1 byte to 5 byte. if value < 128, then 1 byte...etc.) + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a memory region. + + The pointer to an unmanaged memory region. For read operation, this pointer must be allocated by the caller. + If the end of stream was reached before reading all the bytes. + Note that depending on the serialization , this method reads or writes the value. + This method doesn't serialize the sizeInBytes of the region, so the size must be serialized serparetely. + + + + + Serializes a memory region. + + The data pointer. For read operation, this pointer must be allocated by the caller. + The size in bytes. See remarks. + If the end of stream was reached before reading all the bytes. + Note that depending on the serialization , this method reads or writes the value. + This method doesn't serialize the sizeInBytes of the region, so the size must be serialized serparetely. + + + + + Serializes a single uint value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single long value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single ulong value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single char value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single float value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single double value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single DateTime value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Serializes a single Guid value. + + The value to serialize + + Note that depending on the serialization , this method reads or writes the value. + + + + + Underlying stream this instance is reading/writing to. + + + + + Reader used to directly read from the underlying stream. + + + + + Writer used to directly write to the underlying stream. + + + + + Gets or sets the serialization mode. + + The serialization mode. + + + + Gets or sets the encoding used to serialized strings. + + The encoding. + When setting a null encoding + + + + Enables to serialize an object only once using object reference. Default is false. + + true if [allow null]; otherwise, false. + If an invalid matching pair of true/false is detected. + + + + Serialization mode used by . + + + + + Reads the data from the stream. + + + + + Writes the data to the stream. + + + + + Shadow attribute used to associate a COM callbackable interface to its Shadow implementation. + + + + + Initializes a new instance of class. + + Type of the associated shadow + + + + Get ShadowAttribute from type. + + Type to get shadow attribute + The associated shadow attribute or null if no shadow attribute were found + + + + Gets the value. + + + + + Represents a 4x4 mathematical Matrix5x4. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + The identity . + + + + + Value at row 1 column 1 of the Matrix5x4. + + + + + Value at row 1 column 2 of the Matrix5x4. + + + + + Value at row 1 column 3 of the Matrix5x4. + + + + + Value at row 1 column 4 of the Matrix5x4. + + + + + Value at row 2 column 1 of the Matrix5x4. + + + + + Value at row 2 column 2 of the Matrix5x4. + + + + + Value at row 2 column 3 of the Matrix5x4. + + + + + Value at row 2 column 4 of the Matrix5x4. + + + + + Value at row 3 column 1 of the Matrix5x4. + + + + + Value at row 3 column 2 of the Matrix5x4. + + + + + Value at row 3 column 3 of the Matrix5x4. + + + + + Value at row 3 column 4 of the Matrix5x4. + + + + + Value at row 4 column 1 of the Matrix5x4. + + + + + Value at row 4 column 2 of the Matrix5x4. + + + + + Value at row 4 column 3 of the Matrix5x4. + + + + + Value at row 4 column 4 of the Matrix5x4. + + + + + Value at row 5 column 1 of the Matrix5x4. + + + + + Value at row 5 column 2 of the Matrix5x4. + + + + + Value at row 5 column 3 of the Matrix5x4. + + + + + Value at row 5 column 4 of the Matrix5x4. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The value to assign at row 1 column 1 of the Matrix5x4. + The value to assign at row 1 column 2 of the Matrix5x4. + The value to assign at row 1 column 3 of the Matrix5x4. + The value to assign at row 1 column 4 of the Matrix5x4. + The value to assign at row 2 column 1 of the Matrix5x4. + The value to assign at row 2 column 2 of the Matrix5x4. + The value to assign at row 2 column 3 of the Matrix5x4. + The value to assign at row 2 column 4 of the Matrix5x4. + The value to assign at row 3 column 1 of the Matrix5x4. + The value to assign at row 3 column 2 of the Matrix5x4. + The value to assign at row 3 column 3 of the Matrix5x4. + The value to assign at row 3 column 4 of the Matrix5x4. + The value to assign at row 4 column 1 of the Matrix5x4. + The value to assign at row 4 column 2 of the Matrix5x4. + The value to assign at row 4 column 3 of the Matrix5x4. + The value to assign at row 4 column 4 of the Matrix5x4. + The value to assign at row 5 column 1 of the Matrix5x4. + The value to assign at row 5 column 2 of the Matrix5x4. + The value to assign at row 5 column 3 of the Matrix5x4. + The value to assign at row 5 column 4 of the Matrix5x4. + + + + Initializes a new instance of the struct. + + The values to assign to the components of the Matrix5x4. This must be an array with sixteen elements. + Thrown when is null. + Thrown when contains more or less than sixteen elements. + + + + Determines the sum of two matrices. + + The first Matrix5x4 to add. + The second Matrix5x4 to add. + When the method completes, contains the sum of the two matrices. + + + + Determines the sum of two matrices. + + The first Matrix5x4 to add. + The second Matrix5x4 to add. + The sum of the two matrices. + + + + Determines the difference between two matrices. + + The first Matrix5x4 to subtract. + The second Matrix5x4 to subtract. + When the method completes, contains the difference between the two matrices. + + + + Determines the difference between two matrices. + + The first Matrix5x4 to subtract. + The second Matrix5x4 to subtract. + The difference between the two matrices. + + + + Scales a Matrix5x4 by the given value. + + The Matrix5x4 to scale. + The amount by which to scale. + When the method completes, contains the scaled Matrix5x4. + + + + Scales a Matrix5x4 by the given value. + + The Matrix5x4 to scale. + The amount by which to scale. + When the method completes, contains the scaled Matrix5x4. + + + + Negates a Matrix5x4. + + The Matrix5x4 to be negated. + When the method completes, contains the negated Matrix5x4. + + + + Negates a Matrix5x4. + + The Matrix5x4 to be negated. + The negated Matrix5x4. + + + + Performs a linear interpolation between two matricies. + + Start Matrix5x4. + End Matrix5x4. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two matricies. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two matricies. + + Start Matrix5x4. + End Matrix5x4. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two matrices. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two matricies. + + Start Matrix5x4. + End Matrix5x4. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two matrices. + + + + Performs a cubic interpolation between two matrices. + + Start Matrix5x4. + End Matrix5x4. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two matrices. + + + + Creates a Matrix5x4 that scales along the x-axis, y-axis, y-axis and w-axis + + Scaling factor for all three axes. + When the method completes, contains the created scaling Matrix5x4. + + + + Creates a Matrix5x4 that scales along the x-axis, y-axis, and y-axis. + + Scaling factor for all three axes. + The created scaling Matrix5x4. + + + + Creates a Matrix5x4 that scales along the x-axis, y-axis, z-axis and w-axis. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + Scaling factor that is applied along the z-axis. + When the method completes, contains the created scaling Matrix5x4. + + + + Creates a Matrix5x4 that scales along the x-axis, y-axis, z-axis and w-axis. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + Scaling factor that is applied along the z-axis. + Scaling factor that is applied along the w-axis. + The created scaling Matrix5x4. + + + + Creates a Matrix5x4 that uniformally scales along all three axis. + + The uniform scale that is applied along all axis. + When the method completes, contains the created scaling Matrix5x4. + + + + Creates a Matrix5x4 that uniformally scales along all three axis. + + The uniform scale that is applied along all axis. + The created scaling Matrix5x4. + + + + Creates a translation Matrix5x4 using the specified offsets. + + The offset for all three coordinate planes. + When the method completes, contains the created translation Matrix5x4. + + + + Creates a translation Matrix5x4 using the specified offsets. + + The offset for all three coordinate planes. + The created translation Matrix5x4. + + + + Creates a translation Matrix5x4 using the specified offsets. + + X-coordinate offset. + Y-coordinate offset. + Z-coordinate offset. + When the method completes, contains the created translation Matrix5x4. + + + + Creates a translation Matrix5x4 using the specified offsets. + + X-coordinate offset. + Y-coordinate offset. + Z-coordinate offset. + W-coordinate offset. + The created translation Matrix5x4. + + + + Adds two matricies. + + The first Matrix5x4 to add. + The second Matrix5x4 to add. + The sum of the two matricies. + + + + Assert a Matrix5x4 (return it unchanged). + + The Matrix5x4 to assert (unchange). + The asserted (unchanged) Matrix5x4. + + + + Subtracts two matricies. + + The first Matrix5x4 to subtract. + The second Matrix5x4 to subtract. + The difference between the two matricies. + + + + Negates a Matrix5x4. + + The Matrix5x4 to negate. + The negated Matrix5x4. + + + + Scales a Matrix5x4 by a given value. + + The Matrix5x4 to scale. + The amount by which to scale. + The scaled Matrix5x4. + + + + Scales a Matrix5x4 by a given value. + + The Matrix5x4 to scale. + The amount by which to scale. + The scaled Matrix5x4. + + + + Scales a Matrix5x4 by a given value. + + The Matrix5x4 to scale. + The amount by which to scale. + The scaled Matrix5x4. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Gets or sets the first row in the Matrix5x4; that is M11, M12, M13, and M14. + + + + + Gets or sets the second row in the Matrix5x4; that is M21, M22, M23, and M24. + + + + + Gets or sets the third row in the Matrix5x4; that is M31, M32, M33, and M34. + + + + + Gets or sets the fourth row in the Matrix5x4; that is M41, M42, M43, and M44. + + + + + Gets or sets the fifth row in the Matrix5x4; that is M51, M52, M53, and M54. + + + + + Gets or sets the translation of the Matrix5x4; that is M41, M42, and M43. + + + + + Gets or sets the scale of the Matrix5x4; that is M11, M22, and M33. + + + + + Gets a value indicating whether this instance is an identity Matrix5x4. + + + true if this instance is an identity Matrix5x4; otherwise, false. + + + + + Gets or sets the component at the specified index. + + The value of the Matrix5x4 component, depending on the index. + The zero-based index of the component to access. + The value of the component at the specified index. + Thrown when the is out of the range [0, 15]. + + + + Gets or sets the component at the specified index. + + The value of the Matrix5x4 component, depending on the index. + The row of the Matrix5x4 to access. + The column of the Matrix5x4 to access. + The value of the component at the specified index. + Thrown when the or is out of the range [0, 3]. + + + + Descriptor used to provide detailed message for a particular . + + + + + Initializes a new instance of the class. + + The HRESULT error code. + The module (ex: SharpDX.Direct2D1). + The API code (ex: D2D1_ERR_...). + The description of the result code if any. + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Performs an implicit conversion from to . + + The result. + + The result of the conversion. + + + + + Implements the operator ==. + + The left. + The right. + The result of the operator. + + + + Implements the operator !=. + + The left. + The right. + The result of the operator. + + + + Registers a provider. + + Type of the descriptors provider. + + Providers are usually registered at module init when SharpDX assemblies are loaded. + + + + + Finds the specified result descriptor. + + The result code. + A descriptor for the specified result + + + + Gets the result. + + + + + Gets the module (ex: SharpDX.Direct2D1) + + + + + Gets the native API code (ex: D2D1_ERR_ ...) + + + + + Gets the API code (ex: DemiceRemoved ...) + + + + + Gets the description of the result code if any. + + + + + Structure using the same layout than . + + + + + Initializes a new instance of the struct. + + The x. + The y. + + + + Width. + + + + + Height. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + + + + Structure using the same layout than . + + + + + Initializes a new instance of the struct. + + The x. + The y. + + + + Width. + + + + + Height. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + + + + Structure using the same layout than . + + + + + Initializes a new instance of the struct. + + The x. + The y. + + + + Left coordinate. + + + + + Top coordinate. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + Performs an implicit conversion from to . + + The input. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The input. + + The result of the conversion. + + + + + + + + Structure using the same layout than . + + + + + Initializes a new instance of the struct. + + The x. + The y. + + + + Left coordinate. + + + + + Top coordinate. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + + + + Structure using the same layout than + + + + + Initializes a new instance of the struct. + + The x-y position of this rectangle. + The x-y size of this rectangle. + + + + Initializes a new instance of the struct. + + The x. + The y. + The width. + The height. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + The Position. + + + + + The Size. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + + + + Left coordinate. + + + + + Top coordinate. + + + + + Width of this rectangle. + + + + + Height of this rectangle. + + + + + Helper class for PIX. + + + + + Marks the beginning of a user-defined event. PIX can use this event to trigger an action. + + The Event color. + The Event Name. + The zero-based level of the hierarchy that this event is starting in. If an error occurs, the return value will be negative. + D3DPERF_BeginEvent + + + + Marks the beginning of a user-defined event. PIX can use this event to trigger an action. + + The Event color. + The Event formatted Name. + The parameters to use for the formatted name. + + The zero-based level of the hierarchy that this event is starting in. If an error occurs, the return value will be negative. + + D3DPERF_BeginEvent + + + + Mark the end of a user-defined event. PIX can use this event to trigger an action. + + The level of the hierarchy in which the event is ending. If an error occurs, this value is negative. + D3DPERF_EndEvent + + + + Mark an instantaneous event. PIX can use this event to trigger an action. + + The color. + The name. + D3DPERF_SetMarker + + + + Mark an instantaneous event. PIX can use this event to trigger an action. + + The color. + The name to format. + The parameters to use to format the name. + D3DPERF_SetMarker + + + + Set this to false to notify PIX that the target program does not give permission to be profiled. + + if set to true PIX profiling is authorized. Default to true. + D3DPERF_SetOptions + + + + Gets a value indicating whether this instance is currently profiled by PIX. + + + true if this instance is currently profiled; otherwise, false. + + D3DPERF_GetStatus + + + + Structure using the same layout than + + + + + An empty drawing rectangle. + + + + + Initializes a new instance of the struct. + + The x. + The y. + The width. + The height. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Left coordinate. + + + + + Top coordinate. + + + + + Width of this rectangle. + + + + + Height of this rectangle. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + + + + Implements the operator ==. + + The left. + The right. + + The result of the operator. + + + + + Implements the operator !=. + + The left. + The right. + + The result of the operator. + + + + + + + + Windows File Helper. + + + + + Opens a binary file, reads the contents of the file into a byte array, and then closes the file. + + The file to open for reading. + A byte array containing the contents of the file. + + + + Opens a text file, reads all lines of the file, and then closes the file. + + The file to open for reading. + A string containing all lines of the file. + + + + Opens a text file, reads all lines of the file, and then closes the file. + + The file to open for reading. + A string containing all lines of the file. + + + + Reads to a file. + + The file handle. + The buffer. + The number of bytes to read. + The number of bytes read. + The overlapped. + A Result + ReadFile + + + + Writes to a file. + + The file handle. + The buffer. + The number of bytes to read. + The number of bytes read. + The overlapped. + A Result + WriteFile + + + + Sets the file pointer. + + The handle. + The distance to move. + The distance to move high. + The seek origin. + + SetFilePointerEx + + + + Sets the end of file. + + The handle. + + SetEndOfFile + + + + Creates the file. + + Name of the file. + The desired access. + The share mode. + The security attributes. + The creation disposition. + The flags and attributes. + The template file. + A handle to the created file. IntPtr.Zero if failed. + CreateFile + + + + Gets the size of the file. + + The handle. + Size of the file. + + GetFileSizeEx + + + + Windows File Helper. + + + + + Initializes a new instance of the class. + + Name of the file. + The file mode. + The access mode. + The share mode. + + + + + + + + + + + + + + + + Reads a block of bytes from the stream and writes the data in a given buffer. + + When this method returns, contains the specified buffer with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. + The byte offset in array at which the read bytes will be placed. + The maximum number of bytes to read. + array is null. + The total number of bytes read into the buffer. This might be less than the number of bytes requested if that number of bytes are not currently available, or zero if the end of the stream is reached. + + + + + + + Writes a block of bytes to this stream using data from a buffer. + + The buffer containing data to write to the stream. + The zero-based byte offset in buffer at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + + + + + + + + + + + + + + + + Native File access flags. + + + + + Read access. + + + + + Write access. + + + + + Read/Write Access, + + + + + Execute access. + + + + + All access + + + + + Native file attributes. + + + + + None attribute. + + + + + Read only attribute. + + + + + Hidden attribute. + + + + + System attribute. + + + + + Directory attribute. + + + + + Archive attribute. + + + + + Device attribute. + + + + + Normal attribute. + + + + + Temporary attribute. + + + + + Sparse file attribute. + + + + + ReparsePoint attribute. + + + + + Compressed attribute. + + + + + Offline attribute. + + + + + Not content indexed attribute. + + + + + Encrypted attribute. + + + + + Write through attribute. + + + + + Overlapped attribute. + + + + + No buffering attribute. + + + + + Random access attribute. + + + + + Sequential scan attribute. + + + + + Delete on close attribute. + + + + + Backup semantics attribute. + + + + + Post semantics attribute. + + + + + Open reparse point attribute. + + + + + Open no recall attribute. + + + + + First pipe instance attribute. + + + + + Native file creation disposition. + + + + + Creates a new file. The function fails if a specified file exists. + + + + + Creates a new file, always. + If a file exists, the function overwrites the file, clears the existing attributes, combines the specified file attributes, + and flags with FILE_ATTRIBUTE_ARCHIVE, but does not set the security descriptor that the SECURITY_ATTRIBUTES structure specifies. + + + + + Opens a file. The function fails if the file does not exist. + + + + + Opens a file, always. + If a file does not exist, the function creates a file as if dwCreationDisposition is CREATE_NEW. + + + + + Opens a file and truncates it so that its size is 0 (zero) bytes. The function fails if the file does not exist. + The calling process must open the file with the GENERIC_WRITE access right. + + + + + Native file share. + + + + + None flag. + + + + + Enables subsequent open operations on an object to request read access. + Otherwise, other processes cannot open the object if they request read access. + If this flag is not specified, but the object has been opened for read access, the function fails. + + + + + Enables subsequent open operations on an object to request write access. + Otherwise, other processes cannot open the object if they request write access. + If this flag is not specified, but the object has been opened for write access, the function fails. + + + + + Read and Write flags. + + + + + Enables subsequent open operations on an object to request delete access. + Otherwise, other processes cannot open the object if they request delete access. + If this flag is not specified, but the object has been opened for delete access, the function fails. + + + + + Direct2D Matrix3x2 3x2. Use and implicit cast to . + + + + + Gets the identity matrix. + + The identity matrix. + + + + Element (1,1) + + + + + Element (1,2) + + + + + Element (2,1) + + + + + Element (2,2) + + + + + Element (3,1) + + + + + Element (3,2) + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The value to assign at row 1 column 1 of the matrix. + The value to assign at row 1 column 2 of the matrix. + The value to assign at row 2 column 1 of the matrix. + The value to assign at row 2 column 2 of the matrix. + The value to assign at row 3 column 1 of the matrix. + The value to assign at row 3 column 2 of the matrix. + + + + Initializes a new instance of the struct. + + The values to assign to the components of the matrix. This must be an array with sixteen elements. + Thrown when is null. + Thrown when contains more or less than sixteen elements. + + + + Creates an array containing the elements of the matrix. + + A sixteen-element array containing the components of the matrix. + + + + Determines the sum of two matrices. + + The first matrix to add. + The second matrix to add. + When the method completes, contains the sum of the two matrices. + + + + Determines the sum of two matrices. + + The first matrix to add. + The second matrix to add. + The sum of the two matrices. + + + + Determines the difference between two matrices. + + The first matrix to subtract. + The second matrix to subtract. + When the method completes, contains the difference between the two matrices. + + + + Determines the difference between two matrices. + + The first matrix to subtract. + The second matrix to subtract. + The difference between the two matrices. + + + + Scales a matrix by the given value. + + The matrix to scale. + The amount by which to scale. + When the method completes, contains the scaled matrix. + + + + Scales a matrix by the given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Determines the product of two matrices. + + The first matrix to multiply. + The second matrix to multiply. + The product of the two matrices. + + + + Determines the product of two matrices. + + The first matrix to multiply. + The second matrix to multiply. + The product of the two matrices. + + + + Scales a matrix by the given value. + + The matrix to scale. + The amount by which to scale. + When the method completes, contains the scaled matrix. + + + + Determines the quotient of two matrices. + + The first matrix to divide. + The second matrix to divide. + When the method completes, contains the quotient of the two matrices. + + + + Negates a matrix. + + The matrix to be negated. + When the method completes, contains the negated matrix. + + + + Negates a matrix. + + The matrix to be negated. + The negated matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor for all three axes. + When the method completes, contains the created scaling matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor for all three axes. + The created scaling matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + When the method completes, contains the created scaling matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + The created scaling matrix. + + + + Creates a matrix that uniformally scales along all three axis. + + The uniform scale that is applied along all axis. + When the method completes, contains the created scaling matrix. + + + + Creates a matrix that uniformally scales along all three axis. + + The uniform scale that is applied along all axis. + The created scaling matrix. + + + + Creates a matrix that is scaling from a specified center. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + The center of the scaling. + The created scaling matrix. + + + + Creates a matrix that is scaling from a specified center. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + The center of the scaling. + The created scaling matrix. + + + + Calculates the determinant of this matrix. + + Result of the determinant. + + + + Creates a matrix that rotates. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis. + When the method completes, contains the created rotation matrix. + + + + Creates a matrix that rotates. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis. + The created rotation matrix. + + + + Creates a translation matrix using the specified offsets. + + The offset for all three coordinate planes. + When the method completes, contains the created translation matrix. + + + + Creates a translation matrix using the specified offsets. + + The offset for all three coordinate planes. + The created translation matrix. + + + + Creates a translation matrix using the specified offsets. + + X-coordinate offset. + Y-coordinate offset. + Z-coordinate offset. + When the method completes, contains the created translation matrix. + + + + Creates a translation matrix using the specified offsets. + + X-coordinate offset. + Y-coordinate offset. + Z-coordinate offset. + The created translation matrix. + + + + Transforms a vector by this matrix. + + The matrix to use as a tranformation matrix. + The original vector to apply the transformation. + The result of the transformation for the input vector. + + + + Transforms a vector by this matrix. + + The matrix to use as a tranformation matrix. + The original vector to apply the transformation. + The result of the transformation for the input vector. + + + + + Adds two matricies. + + The first matrix to add. + The second matrix to add. + The sum of the two matricies. + + + + Assert a matrix (return it unchanged). + + The matrix to assert (unchange). + The asserted (unchanged) matrix. + + + + Subtracts two matricies. + + The first matrix to subtract. + The second matrix to subtract. + The difference between the two matricies. + + + + Negates a matrix. + + The matrix to negate. + The negated matrix. + + + + Scales a matrix by a given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Scales a matrix by a given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Multiplies two matricies. + + The first matrix to multiply. + The second matrix to multiply. + The product of the two matricies. + + + + Scales a matrix by a given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Divides two matricies. + + The first matrix to divide. + The second matrix to divide. + The quotient of the two matricies. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Performs an implicit conversion from to . + + The matrix. + The result of the conversion. + + + + Gets or sets the first row in the matrix; that is M11, M12. + + + + + Gets or sets the second row in the matrix; that is M21, M22. + + + + + Gets or sets the third row in the matrix; that is M31, M32. + + + + + Gets or sets the first column in the matrix; that is M11, M21, M31. + + + + + Gets or sets the second column in the matrix; that is M12, M22, M32, and M42. + + + + + Gets or sets the translation of the matrix; that is M41, M42. + + + + + Gets or sets the scale of the matrix; that is M11, M22. + + + + + Gets a value indicating whether this instance is an identity matrix. + + + true if this instance is an identity matrix; otherwise, false. + + + + + Gets or sets the component at the specified index. + + The value of the matrix component, depending on the index. + The zero-based index of the component to access. + The value of the component at the specified index. + Thrown when the is out of the range [0, 5]. + + + + Gets or sets the component at the specified index. + + The value of the matrix component, depending on the index. + The row of the matrix to access. + The column of the matrix to access. + The value of the component at the specified index. + Thrown when the or is out of the range [0, 3]. + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + The ShadowContainer is the main container used internally to keep references to all native COM/C++ callbacks. + It is stored in the property . + + + + + Contains static methods to help in determining intersections, containment, etc. + + + + + Determines the closest point between a point and a triangle. + + The point to test. + The first vertex to test. + The second vertex to test. + The third vertex to test. + When the method completes, contains the closest point between the two objects. + + + + Determines the closest point between a and a point. + + The plane to test. + The point to test. + When the method completes, contains the closest point between the two objects. + + + + Determines the closest point between a and a point. + + The box to test. + The point to test. + When the method completes, contains the closest point between the two objects. + + + + Determines the closest point between a and a point. + + + The point to test. + When the method completes, contains the closest point between the two objects; + or, if the point is directly in the center of the sphere, contains . + + + + Determines the closest point between a and a . + + The first sphere to test. + The second sphere to test. + When the method completes, contains the closest point between the two objects; + or, if the point is directly in the center of the sphere, contains . + + If the two spheres are overlapping, but not directly ontop of each other, the closest point + is the 'closest' point of intersection. This can also be considered is the deepest point of + intersection. + + + + + Determines the distance between a and a point. + + The plane to test. + The point to test. + The distance between the two objects. + + + + Determines the distance between a and a point. + + The box to test. + The point to test. + The distance between the two objects. + + + + Determines the distance between a and a . + + The first box to test. + The second box to test. + The distance between the two objects. + + + + Determines the distance between a and a point. + + The sphere to test. + The point to test. + The distance between the two objects. + + + + Determines the distance between a and a . + + The first sphere to test. + The second sphere to test. + The distance between the two objects. + + + + Determines whether there is an intersection between a and a point. + + The ray to test. + The point to test. + Whether the two objects intersect. + + + + Determines whether there is an intersection between a and a . + + The first ray to test. + The second ray to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersect. + + This method performs a ray vs ray intersection test based on the following formula + from Goldman. + s = det([o_2 - o_1, d_2, d_1 x d_2]) / ||d_1 x d_2||^2 + t = det([o_2 - o_1, d_1, d_1 x d_2]) / ||d_1 x d_2||^2 + Where o_1 is the position of the first ray, o_2 is the position of the second ray, + d_1 is the normalized direction of the first ray, d_2 is the normalized direction + of the second ray, det denotes the determinant of a matrix, x denotes the cross + product, [ ] denotes a matrix, and || || denotes the length or magnitude of a vector. + + + + + Determines whether there is an intersection between a and a . + + The ray to test. + The plane to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersect. + + + + Determines whether there is an intersection between a and a . + + The ray to test. + The plane to test + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a triangle. + + The ray to test. + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + This method tests if the ray intersects either the front or back of the triangle. + If the ray is parallel to the triangle's plane, no intersection is assumed to have + happened. If the intersection of the ray and the triangle is behind the origin of + the ray, no intersection is assumed to have happened. In both cases of assumptions, + this method returns false. + + + + + Determines whether there is an intersection between a and a triangle. + + The ray to test. + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The ray to test. + The box to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The ray to test. + The box to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The ray to test. + The sphere to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The ray to test. + The sphere to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a point. + + The plane to test. + The point to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The first plane to test. + The second plane to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The first plane to test. + The second plane to test. + When the method completes, contains the line of intersection + as a , or a zero ray if there was no intersection. + Whether the two objects intersected. + + Although a ray is set to have an origin, the ray returned by this method is really + a line in three dimensions which has no real origin. The ray is considered valid when + both the positive direction is used and when the negative direction is used. + + + + + Determines whether there is an intersection between a and a triangle. + + The plane to test. + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The plane to test. + The box to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The plane to test. + The sphere to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The first box to test. + The second box to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + The box to test. + The sphere to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a triangle. + + The sphere to test. + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + Whether the two objects intersected. + + + + Determines whether there is an intersection between a and a . + + First sphere to test. + Second sphere to test. + Whether the two objects intersected. + + + + Determines whether a contains a point. + + The box to test. + The point to test. + The type of containment the two objects have. + + + + Determines whether a contains a . + + The first box to test. + The second box to test. + The type of containment the two objects have. + + + + Determines whether a contains a . + + The box to test. + The sphere to test. + The type of containment the two objects have. + + + + Determines whether a contains a point. + + The sphere to test. + The point to test. + The type of containment the two objects have. + + + + Determines whether a contains a triangle. + + The sphere to test. + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + The type of containment the two objects have. + + + + Determines whether a contains a . + + The sphere to test. + The box to test. + The type of containment the two objects have. + + + + Determines whether a contains a . + + The first sphere to test. + The second sphere to test. + The type of containment the two objects have. + + + + Represents a color in the form of rgb. + + + + + The Black color (0, 0, 0). + + + + + The White color (1, 1, 1, 1). + + + + + The red component of the color. + + + + + The green component of the color. + + + + + The blue component of the color. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The red component of the color. + The green component of the color. + The blue component of the color. + + + + Initializes a new instance of the struct. + + The red, green, and blue components of the color. + + + + Initializes a new instance of the struct. + + A packed integer containing all three color components in RGB order. + The alpha component is ignored. + + + + Initializes a new instance of the struct. + + The values to assign to the red, green, and blue components of the color. This must be an array with three elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Converts the color into a packed integer. + + A packed integer containing all three color components. + The alpha channel is set to 255. + + + + Converts the color into a packed integer. + + A packed integer containing all three color components. + The alpha channel is set to 255. + + + + Converts the color into a three component vector. + + A three component vector containing the red, green, and blue components of the color. + + + + Creates an array containing the elements of the color. + + A three-element array containing the components of the color. + + + + Adds two colors. + + The first color to add. + The second color to add. + When the method completes, completes the sum of the two colors. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + WHen the method completes, contains the difference of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract + The difference of the two colors. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + When the method completes, contains the modulated color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + When the method completes, contains the scaled color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + The scaled color. + + + + Negates a color. + + The color to negate. + When the method completes, contains the negated color. + + + + Negates a color. + + The color to negate. + The negated color. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two colors. + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two colors. + + + + Returns a color containing the smallest components of the specified colorss. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the largest components of the source colorss. + + + + Returns a color containing the largest components of the specified colorss. + + The first source color. + The second source color. + A color containing the largest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the smallest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + A color containing the smallest components of the source colors. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + When the method completes, contains the adjusted color. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + The adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + When the method completes, contains the adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + The adjusted color. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Assert a color (return it unchanged). + + The color to assert (unchange). + The asserted (unchanged) color. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + The difference of the two colors. + + + + Negates a color. + + The color to negate. + A negated color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Gets or sets the component at the specified index. + + The value of the red, green, or blue component, depending on the index. + The index of the component to access. Use 0 for the red component, 1 for the green component, and 2 for the blue component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 2]. + + + + Represents a color in the form of rgba. + + + + + The Black color (0, 0, 0, 1). + + + + + The White color (1, 1, 1, 1). + + + + + The red component of the color. + + + + + The green component of the color. + + + + + The blue component of the color. + + + + + The alpha component of the color. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The red component of the color. + The green component of the color. + The blue component of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + The red, green, blue, and alpha components of the color. + + + + Initializes a new instance of the struct. + + The red, green, and blue compoennts of the color. + The alpha component of the color. + + + + Initializes a new instance of the struct. + + A packed integer containing all four color components in RGBA order. + + + + Initializes a new instance of the struct. + + A packed integer containing all four color components in RGBA order. + + + + Initializes a new instance of the struct. + + The values to assign to the red, green, blue, and alpha components of the color. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Initializes a new instance of the struct. + + used to initialize the color. + + + + Initializes a new instance of the struct. + + used to initialize the color. + The alpha component of the color. + + + + Converts the color into a packed integer. + + A packed integer containing all four color components. + + + + Converts the color into a packed integer. + + A packed integer containing all four color components. + + + + Converts the color into a packed integer. + + A packed integer containing all four color components. + + + + Converts the color into a three component vector. + + A three component vector containing the red, green, and blue components of the color. + + + + Converts the color into a four component vector. + + A four component vector containing all four color components. + + + + Creates an array containing the elements of the color. + + A four-element array containing the components of the color. + + + + Adds two colors. + + The first color to add. + The second color to add. + When the method completes, completes the sum of the two colors. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + WHen the method completes, contains the difference of the two colors. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract + The difference of the two colors. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + When the method completes, contains the modulated color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + When the method completes, contains the scaled color. + + + + Scales a color. + + The color to scale. + The amount by which to scale. + The scaled color. + + + + Negates a color. + + The color to negate. + When the method completes, contains the negated color. + + + + Negates a color. + + The color to negate. + The negated color. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two colors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two colors. + + + + Performs a cubic interpolation between two colors. + + Start color. + End color. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two colors. + + + + Returns a color containing the smallest components of the specified colorss. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the largest components of the source colorss. + + + + Returns a color containing the largest components of the specified colorss. + + The first source color. + The second source color. + A color containing the largest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + When the method completes, contains an new color composed of the smallest components of the source colors. + + + + Returns a color containing the smallest components of the specified colors. + + The first source color. + The second source color. + A color containing the smallest components of the source colors. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + When the method completes, contains the adjusted color. + + + + Adjusts the contrast of a color. + + The color whose contrast is to be adjusted. + The amount by which to adjust the contrast. + The adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + When the method completes, contains the adjusted color. + + + + Adjusts the saturation of a color. + + The color whose saturation is to be adjusted. + The amount by which to adjust the saturation. + The adjusted color. + + + + Adds two colors. + + The first color to add. + The second color to add. + The sum of the two colors. + + + + Assert a color (return it unchanged). + + The color to assert (unchange). + The asserted (unchanged) color. + + + + Subtracts two colors. + + The first color to subtract. + The second color to subtract. + The difference of the two colors. + + + + Negates a color. + + The color to negate. + A negated color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Scales a color. + + The factor by which to scale the color. + The color to scale. + The scaled color. + + + + Modulates two colors. + + The first color to modulate. + The second color to modulate. + The modulated color. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + + The result of the conversion. + + + + + Performs an explicit conversion from to . + + The value. + + The result of the conversion. + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Gets or sets the component at the specified index. + + The value of the red, green, blue, and alpha components, depending on the index. + The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + Gets or sets the unmanaged callback. + + The unmanaged callback. + + This property is set whenever this instance has an unmanaged callback + registered. This callback must be disposed when disposing this instance. + + + + + Root IUnknown class to interop with COM object + + + + + Root class for all Cpp interop object. + + + + + The native pointer + + + + + Default constructor. + + Pointer to Cpp Object + + + + Initializes a new instance of the class. + + + + + Performs an explicit conversion from to . + + The CPP object. + + The result of the conversion. + + + + + Initializes this instance with a pointer from a temporary object and set the pointer of the temporary + object to IntPtr.Zero. + + The instance to get the NativePointer. + + + + Initializes this instance with a pointer from a temporary object and set the pointer of the temporary + object to IntPtr.Zero. + + The instance to get the NativePointer. + + + + Method called when is going to be update. + + + + + Method called when the is updated. + + + + + Instantiate a ComObject from a native pointer. + + The ComObject class that will be returned + The native pointer to a com object. + An instance of T binded to the native pointer + + + + Get a pointer to the underlying Cpp Object + + + + + Base interface for Component Object Model (COM). + + + + + Queries the supported COM interface on this instance. + + The guid of the interface. + The output COM object reference. + If successfull, + + + + Increments the reference count for an interface on this instance. + + The method returns the new reference count. + + + + Decrements the reference count for an interface on this instance. + + The method returns the new reference count. + + + + Initializes a new instance of the class. + + Pointer to Cpp Object + + + + Initializes a new instance of the class from a IUnknown object. + + Reference to a IUnknown object + + + + Initializes a new instance of the class. + + + + + Query this instance for a particular COM GUID/interface support. + + GUID query interface + output object associated with this GUID, IntPtr.Zero in interface is not supported + If this object doesn't support the interface + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Query instance for a particular COM GUID/interface support. + + GUID query interface + If this object doesn't support the interface + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Query this instance for a particular COM interface support. + + The type of the COM interface to query + An instance of the queried interface + If this object doesn't support the interface + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Query this instance for a particular COM interface support. + + The type of the COM interface to query + An instance of the queried interface + If this object doesn't support the interface + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Queries a managed object for a particular COM interface support (This method is a shortcut to ) + + The type of the COM interface to query + The managed COM object. + An instance of the queried interface + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Queries a managed object for a particular COM interface support (This method is a shortcut to ) + + The type of the COM interface to query + The managed COM object. + An instance of the queried interface + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Safely dispose a referencem if not null, and set it to null after dispose. + + The type of COM interface to dispose + Object to dispose + + The reference will be set to null after dispose. + + + + + Queries a managed object for a particular COM interface support. + + The type of the COM interface to query + The managed COM object. + An instance of the queried interface + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Query Interface for a particular interface support. + + An instance of the queried interface or null if it is not supported + + ms682521 + IUnknown::QueryInterface + IUnknown::QueryInterface + + + + Performs an explicit conversion from to . + + The native pointer. + + The result of the conversion. + + + + + Query Interface for a particular interface support and attach to the given instance. + + + + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + ms682317 + IUnknown::Release + IUnknown::Release + + + + Base class for unmanaged callabackable Com object. + + + + + Initializes a new instance of the class. + + Pointer to Cpp Object + + + + Initializes a new instance of the class. + + + + + Implements but it cannot not be set. + This is only used to support for interop with unmanaged callback. + + + + + A COM Interface Callback + + + + + An Interface shadow callback + + + + + Initializes the specified shadow instance from a vtbl and a callback. + + The callback. + + + + Return the unmanaged pointer from a tuple and instances. + + The type of the callback. + The callback. + A pointer to the unamanaged C++ object of the callback + + + + Gets the callback. + + + + + Gets the VTBL associated with this shadow instance. + + + + + Default Constructor. + + number of methods to allocate in the VTBL + + + + Add a method supported by this interface. This method is typically called from inherited constructor. + + the managed delegate method + + + + Gets the pointer to the vtbl. + + + + + A compilation exception. + + + + + The base class for errors that occur in SharpDX. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The result code that caused this exception. + + + + Initializes a new instance of the class. + + The result descriptor. + + + + Initializes a new instance of the class. + + The error result code. + The message describing the exception. + + + + Initializes a new instance of the class. + + The error result code. + The message describing the exception. + formatting arguments + + + + Initializes a new instance of the class. + + The message describing the exception. + formatting arguments + + + + Initializes a new instance of the class. + + The message describing the exception. + The exception that caused this exception. + formatting arguments + + + + Gets the Result code for the exception. This value indicates + the specific type of failure that occured within SharpDX. + + + + + Gets the Result code for the exception. This value indicates + the specific type of failure that occured within SharpDX. + + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The error code. + The message. + + + + A disposable component base class. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with an immutable name. + + The name. + + + + Releases unmanaged and - optionally - managed resources + + + + + Disposes of object resources. + + If true, managed resources should be + disposed of in addition to unmanaged resources. + + + + Adds a disposable object to the list of the objects to dispose. + + To dispose. + + + + Dispose a disposable object and set the reference to null. Removes this object from the ToDispose list. + + Object to dispose. + + + + Removes a disposable object to the list of the objects to dispose. + + + To dispose. + + + + Gets or sets the disposables. + + The disposables. + + + + Gets or sets a value indicating whether this instance is attached to a collector. + + + true if this instance is attached to a collector; otherwise, false. + + + + + Gets a value indicating whether this instance is disposed. + + + true if this instance is disposed; otherwise, false. + + + + + Occurs when when Dispose is called. + + + + + Global configuration. + + + + + Enables or disables object tracking. Default is disabled (false). + + + Object Tracking is used to track COM object lifecycle creation/dispose. When this option is enabled + objects can be tracked using . Using Object tracking has a significant + impact on performance and should be used only while debugging. + + + + + Enables or disables release of ComObject on finalizer. Default is disabled (false). + + + + + Throws a when a shader or effect compilation error occured. Default is enabled (true). + + + + + Provides access to data organized in 3D. + + + + + Initializes a new instance of the struct. + + The datapointer. + The row pitch. + The slice pitch. + + + + Initializes a new instance of the struct. + + The data pointer. + + + + Pointer to the data. + + + + + Gets the number of bytes per row. + + + + + Gets the number of bytes per slice (for a 3D texture, a slice is a 2D image) + + + + + Provides access to data organized in 2D. + + + + + Initializes a new instance of the class. + + The data pointer. + The pitch. + + + + Pointer to the data. + + + + + Gets the number of bytes per row. + + + + + Provides a stream interface to a buffer located in unmanaged memory. + + + + + Initializes a new instance of the class from a Blob buffer. + + The buffer. + + + + Initializes a new instance of the class, using a managed buffer as a backing store. + + + A managed array to be used as a backing store. + true if reading from the buffer should be allowed; otherwise, false. + true if writing to the buffer should be allowed; otherwise, false. + Index inside the buffer in terms of element count (not size in bytes). + True to keep the managed buffer and pin it, false will allocate unmanaged memory and make a copy of it. Default is true. + + + + + Initializes a new instance of the class, and allocates a new buffer to use as a backing store. + + The size of the buffer to be allocated, in bytes. + + true if reading from the buffer should be allowed; otherwise, false. + + true if writing to the buffer should be allowed; otherwise, false. + + + + Initializes a new instance of the class, using an unmanaged buffer as a backing store. + + A pointer to the buffer to be used as a backing store. + The size of the buffer provided, in bytes. + + true if reading from the buffer should be allowed; otherwise, false. + + true if writing to the buffer should be allowed; otherwise, false. + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Not supported. + + Always thrown. + + + + Reads a single value from the current stream and advances the current + position within this stream by the number of bytes read. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The type of the value to be read from the stream. + The value that was read. + This stream does not support reading. + + + + Reads a float. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + a float from the stream + + + + Reads a int. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an int from the stream + + + + Reads a short. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an short from the stream + + + + Reads a bool. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an bool from the stream + + + + Reads a Vector2. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Vector2 from the stream + + + + Reads a Vector3. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Vector3 from the stream + + + + Reads a Vector4. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Vector4 from the stream + + + + Reads a Color3. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Color3 from the stream + + + + Reads a Color4. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Color4 from the stream + + + + Reads a Half. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Half from the stream + + + + Reads a Half2. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Half2 from the stream + + + + Reads a Half3. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Half3 from the stream + + + + Reads a Half4. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + an Half4 from the stream + + + + Reads a Matrix. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + a Matrix from the stream + + + + Reads a Quaternion. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + a Quaternion from the stream + + + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + An array of values to be read from the stream. + The zero-based byte offset in buffer at which to begin storing + the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The number of bytes read from the stream. + This stream does not support reading. + + + + Reads a sequence of bytes from the current stream and advances the current position within this stream by the number of bytes written. + + An array of bytes. This method copies bytes from to the current stream. + The zero-based byte offset in at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Reads an array of values from the current stream, and advances the current position + within this stream by the number of bytes written. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The type of the values to be read from the stream. + An array of values that was read from the current stream. + + + + Reads a sequence of elements from the current stream into a target buffer and + advances the position within the stream by the number of bytes read. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + An array of values to be read from the stream. + The zero-based byte offset in buffer at which to begin storing + the data read from the current stream. + The number of values to be read from the current stream. + The number of bytes read from the stream. + This stream does not support reading. + + + + Sets the position within the current stream. + + Attempted to seek outside of the bounds of the stream. + + + + Not supported. + + Always ignored. + Always thrown. + + + + Writes a single value to the stream, and advances the current position + within this stream by the number of bytes written. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The type of the value to be written to the stream. + The value to write to the stream. + The stream does not support writing. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes the specified value. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The value. + + + + Writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + An array of bytes. This method copies count bytes from buffer to the current stream. + The zero-based byte offset in buffer at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + This stream does not support writing. + + + + When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. + + An array of bytes. This method copies bytes from to the current stream. + The zero-based byte offset in at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Writes an array of values to the current stream, and advances the current position + within this stream by the number of bytes written. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + An array of values to be written to the current stream. + This stream does not support writing. + + + + Writes a range of bytes to the current stream, and advances the current position + within this stream by the number of bytes written. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + A pointer to the location to start copying from. + The number of bytes to copy from source to the current stream. + This stream does not support writing. + + + + Writes an array of values to the current stream, and advances the current position + within this stream by the number of bytes written. + + + In order to provide faster read/write, this operation doesn't check stream bound. + A client must carefully not read/write above the size of this datastream. + + The type of the values to be written to the stream. + An array of values to be written to the stream. + The zero-based offset in data at which to begin copying values to the current stream. + The number of values to be written to the current stream. If this is zero, + all of the contents will be written. + This stream does not support writing. + + + + Performs an explicit conversion from to . + + The from value. + The result of the conversion. + + + + Gets a value indicating whether the current stream supports reading. + + + true if the stream supports reading; otherwise, false. + + + + Gets a value indicating whether the current stream supports seeking. + + Always true. + + + + Gets a value indicating whether the current stream supports writing. + + + true if the stream supports writing; otherwise, false. + + + + Gets the internal pointer to the current stream's backing store. + + An IntPtr to the buffer being used as a backing store. + + + + Gets the length in bytes of the stream. + + A long value representing the length of the stream in bytes. + + + + Gets or sets the position within the current stream. + + The current position within the stream. + Stream Class + + + + Gets the position pointer. + + The position pointer. + + + + Gets the length of the remaining. + + The length of the remaining. + + + + Provides methods to perform fast read/write random access data on a buffer located in an unmanaged memory. + + + This class doesn't validate the position read/write from. It is the responsability of the client of this class + to verify that access is done within the size of the buffer. + + + + + Creates the specified user buffer. + + Type of the buffer. + The buffer to use as a DataBuffer. + Index inside the buffer in terms of element count (not size in bytes). + True to keep the managed buffer and pin it, false will allocate unmanaged memory and make a copy of it. Default is true. + An instance of a DataBuffer + + + + Initializes a new instance of the class, and allocates a new buffer to use as a backing store. + + The size of the buffer to be allocated, in bytes. + + is less than 1. + + + + Initializes a new instance of the class, using an unmanaged buffer as a backing store. + + A pointer to the buffer to be used as a backing store. + The size of the buffer provided, in bytes. + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Clears the buffer. + + + + + Gets a single value from the current buffer at the specified position. + + Relative position in bytes from the beginning of the buffer to get the data from. + The type of the value to be read from the buffer. + The value that was read. + + + + Gets a float. + + Relative position in bytes from the beginning of the buffer to get the data from. + a float from the buffer + + + + Gets a int. + + Relative position in bytes from the beginning of the buffer to get the data from. + an int from the buffer + + + + Gets a short. + + Relative position in bytes from the beginning of the buffer to get the data from. + an short from the buffer + + + + Gets a bool. + + Relative position in bytes from the beginning of the buffer to get the data from. + an bool from the buffer + + + + Gets a Vector2. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Vector2 from the buffer + + + + Gets a Vector3. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Vector3 from the buffer + + + + Gets a Vector4. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Vector4 from the buffer + + + + Gets a Color3. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Color3 from the buffer + + + + Gets a Color4. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Color4 from the buffer + + + + Gets a Half. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Half from the buffer + + + + Gets a Half2. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Half2 from the buffer + + + + Gets a Half3. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Half3 from the buffer + + + + Gets a Half4. + + Relative position in bytes from the beginning of the buffer to get the data from. + an Half4 from the buffer + + + + Gets a Matrix. + + Relative position in bytes from the beginning of the buffer to get the data from. + a Matrix from the buffer + + + + Gets a Quaternion. + + Relative position in bytes from the beginning of the buffer to get the data from. + a Quaternion from the buffer + + + + Gets an array of values from a position in the buffer. + + Relative position in bytes from the beginning of the buffer to get the data from. + number of T instance to get from the positionInBytes + The type of the values to be read from the buffer. + An array of values that was read from the current buffer. + + + + Gets a sequence of elements from a position in the buffer into a target buffer. + + Relative position in bytes from the beginning of the buffer to get the data from. + An array of values to be read from the buffer. + The zero-based byte offset in buffer at which to begin storing + the data read from the current buffer. + The number of values to be read from the current buffer. + + + + Sets a single value to the buffer at a specified position. + + The type of the value to be written to the buffer. + Relative position in bytes from the beginning of the buffer to set the data to. + The value to write to the buffer. + + + + Sets a single value to the buffer at a specified position. + + The type of the value to be written to the buffer. + Relative position in bytes from the beginning of the buffer to set the data to. + The value to write to the buffer. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets the specified value. + + Relative position in bytes from the beginning of the buffer to set the data to. + The value. + + + + Sets an array of values to a specified position into the buffer. + + Relative position in bytes from the beginning of the buffer to set the data to. + An array of values to be written to the current buffer. + + + + Sets a range of data to a specified position into the buffer. + + Relative position in bytes from the beginning of the buffer to set the data to. + A pointer to the location to start copying from. + The number of bytes to copy from source to the current buffer. + + + + Sets an array of values to a specified position into the buffer. + + The type of the values to be written to the buffer. + Relative position in bytes from the beginning of the buffer to set the data to. + An array of values to be written to the buffer. + The zero-based offset in data at which to begin copying values to the current buffer. + The number of values to be written to the current buffer. If this is zero, + all of the contents will be written. + + + + Performs an explicit conversion from to . + + The from value. + The result of the conversion. + + + + Gets a pointer to the buffer used as a backing store.. + + An IntPtr to the buffer being used as a backing store. + + + + Gets the length in bytes of the buffer. + + A long value representing the length of the buffer in bytes. + + + + Provides a type converter to convert objects to and from various + other representations. + + + + + Initializes a new instance of the class. + + + + + Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. + + A that provides a format context. + A System::Type that represents the type you want to convert from. + + true if this converter can perform the conversion; otherwise, false. + + + + Returns whether this converter can convert the object to the specified type, using the specified context. + + A that provides a format context. + A that represents the type you want to convert to. + + true if this converter can perform the conversion; otherwise, false. + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + An that represents the converted value. + + + + Converts the given value object to the specified type, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + A that represents the type you want to convert to. + An that represents the converted value. + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + A that provides a format context. + An of new property values. + An representing the given , or null if the object cannot be created. + + + + Returns whether changing a value on this object requires a call to System::ComponentModel::TypeConverter::CreateInstance(System::Collections::IDictionary^) + to create a new value, using the specified context. + + A that provides a format context. + + false if changing a property on this object requires a call to System::ComponentModel::TypeConverter::CreateInstance(System::Collections::IDictionary^) to create a new value; otherwise, false. + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + A that provides a format context. + An that specifies the type of array for which to get properties. + An array of type that is used as a filter. + A with the properties that are exposed for this data type, or a null reference (Nothing in Visual Basic) if there are no properties. + + + + Returns whether this object supports properties, using the specified context. + + A that provides a format context. + + true if GetProperties should be called to find the properties of this object; otherwise, false. + + + + Provides a type converter to convert objects to and from various + other representations. + + + + + Initializes a new instance of the class. + + + + + Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. + + A that provides a format context. + A System.Type that represents the type you want to convert from. + + true if this converter can perform the conversion; otherwise, false. + + + + Returns whether this converter can convert the object to the specified type, using the specified context. + + A that provides a format context. + A that represents the type you want to convert to. + + true if this converter can perform the conversion; otherwise, false. + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + An that represents the converted value. + + + + Converts the given value object to the specified type, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + A that represents the type you want to convert to. + An that represents the converted value. + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + A that provides a format context. + An of new property values. + An representing the given , or null if the object cannot be created. + + + + Returns whether changing a value on this object requires a call to System::ComponentModel::TypeConverter::CreateInstance(System::Collections::IDictionary^) + to create a new value, using the specified context. + + A that provides a format context. + + false if changing a property on this object requires a call to System.ComponentModel::TypeConverter::CreateInstance(System::Collections::IDictionary^) to create a new value; otherwise, false. + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + A that provides a format context. + An that specifies the type of array for which to get properties. + An array of type that is used as a filter. + A with the properties that are exposed for this data type, or a null reference (Nothing in Visual Basic) if there are no properties. + + + + Returns whether this object supports properties, using the specified context. + + A that provides a format context. + + true if GetProperties should be called to find the properties of this object; otherwise, false. + + + + Provides a type converter to convert objects to and from various + other representations. + + + + + Initializes a new instance of the class. + + + + + Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. + + A that provides a format context. + A System::Type that represents the type you want to convert from. + + true if this converter can perform the conversion; otherwise, false. + + + + Returns whether this converter can convert the object to the specified type, using the specified context. + + A that provides a format context. + A that represents the type you want to convert to. + + true if this converter can perform the conversion; otherwise, false. + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + An that represents the converted value. + + + + Converts the given value object to the specified type, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + A that represents the type you want to convert to. + An that represents the converted value. + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + A that provides a format context. + An of new property values. + An representing the given , or null if the object cannot be created. + + + + Returns whether changing a value on this object requires a call to System::ComponentModel::TypeConverter::CreateInstance(System::Collections::IDictionary^) + to create a new value, using the specified context. + + A that provides a format context. + + false if changing a property on this object requires a call to System::ComponentModel::TypeConverter::CreateInstance(System::Collections::IDictionary^) + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + A that provides a format context. + An that specifies the type of array for which to get properties. + An array of type that is used as a filter. + A with the properties that are exposed for this data type, or a null reference (Nothing in Visual Basic) if there are no properties. + + + + Returns whether this object supports properties, using the specified context. + + A that provides a format context. + + true if GetProperties should be called to find the properties of this object; otherwise, false. + + + + Provides a type converter to convert objects to and from various + other representations. + + + + + Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. + + A that provides a format context. + A System::Type that represents the type you want to convert from. + + true if this converter can perform the conversion; otherwise, false. + + + + Returns whether this converter can convert the object to the specified type, using the specified context. + + A that provides a format context. + A that represents the type you want to convert to. + + true if this converter can perform the conversion; otherwise, false. + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + An that represents the converted value. + + + + Converts the given value object to the specified type, using the specified context and culture information. + + A that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + A that represents the type you want to convert to. + An that represents the converted value. + + + + Defines a type converter for . + + + + + Initializes a new instance of the class. + + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the parameter to. + + An that represents the converted value. + + + The parameter is null. + + + The conversion cannot be performed. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + + The conversion cannot be performed. + + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + An that provides a format context. + An of new property values. + + An representing the given , or null if the object cannot be created. This method always returns null. + + + + + Defines a type converter for . + + + + + Initializes a new instance of the class. + + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the parameter to. + + An that represents the converted value. + + + The parameter is null. + + + The conversion cannot be performed. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + + The conversion cannot be performed. + + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + An that provides a format context. + An of new property values. + + An representing the given , or null if the object cannot be created. This method always returns null. + + + + + Defines a type converter for . + + + + + Initializes a new instance of the class. + + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the parameter to. + + An that represents the converted value. + + + The parameter is null. + + + The conversion cannot be performed. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + + The conversion cannot be performed. + + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + An that provides a format context. + An of new property values. + + An representing the given , or null if the object cannot be created. This method always returns null. + + + + + Defines a type converter for . + + + + + Initializes a new instance of the class. + + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the parameter to. + + An that represents the converted value. + + + The parameter is null. + + + The conversion cannot be performed. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + + The conversion cannot be performed. + + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + An that provides a format context. + An of new property values. + + An representing the given , or null if the object cannot be created. This method always returns null. + + + + + Defines a type converter for . + + + + + Initializes a new instance of the class. + + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the parameter to. + + An that represents the converted value. + + + The parameter is null. + + + The conversion cannot be performed. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + + The conversion cannot be performed. + + + + + Creates an instance of the type that this is associated with, using the specified context, given a set of property values for the object. + + An that provides a format context. + An of new property values. + + An representing the given , or null if the object cannot be created. This method always returns null. + + + + + Contains information about a tracked COM object. + + + + + Initializes a new instance of the class. + + The creation time. + The com object to track. + The stack trace. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets the time the object was created. + + The creation time. + + + + Gets a weak reference to the tracked object. + + The weak reference to the tracked object. + + + + Gets the stack trace when the track object was created. + + The stack trace. + + + + Gets a value indicating whether the tracked object is alive. + + true if tracked object is alive; otherwise, false. + + + + Track all allocated objects. + + + + + Initializes the class. + + + + + Called when [process exit]. + + The sender. + The instance containing the event data. + + + + Tracks the specified COM object. + + The COM object. + + + + Finds a list of object reference from a specified COM object pointer. + + The COM object pointer. + A list of object reference + + + + Finds the object reference for a specific COM object. + + The COM object. + An object reference + + + + Untracks the specified COM object. + + The COM object. + + + + Reports all COM object that are active and not yet disposed. + + + + + Reports all COM object that are active and not yet disposed. + + + + + Describes the type of angle. + + + + + Specifies an angle measurement in revolutions. + + + + + Specifies an angle measurement in degrees. + + + + + Specifies an angle measurement in radians. + + + + + Specifies an angle measurement in gradians. + + + + + Describes how one bounding volume contains another. + + + + + The two bounding volumes don't intersect at all. + + + + + One bounding volume completely contains another. + + + + + The two bounding volumes overlap. + + + + + Describes the result of an intersection with a plane in three dimensions. + + + + + The object is behind the plane. + + + + + The object is in front of the plane. + + + + + The object is intersecting the plane. + + + + + FunctionCallback + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + +

Driver type options.

+
+ +

The driver type is required when calling or .

+
+ + ff476328 + D3D_DRIVER_TYPE + D3D_DRIVER_TYPE +
+ + +

The driver type is unknown.

+
+ + ff476328 + D3D_DRIVER_TYPE_UNKNOWN + D3D_DRIVER_TYPE_UNKNOWN +
+ + +

A hardware driver, which implements Direct3D features in hardware. This is the primary driver that you should use in your Direct3D applications because it provides the best performance. A hardware driver uses hardware acceleration (on supported hardware) but can also use software for parts of the pipeline that are not supported in hardware. This driver type is often referred to as a hardware abstraction layer or HAL.

+
+ + ff476328 + D3D_DRIVER_TYPE_HARDWARE + D3D_DRIVER_TYPE_HARDWARE +
+ + +

A reference driver, which is a software implementation that supports every Direct3D feature. A reference driver is designed for accuracy rather than speed and as a result is slow but accurate. The rasterizer portion of the driver does make use of special CPU instructions whenever it can, but it is not intended for retail applications; use it only for feature testing, demonstration of functionality, debugging, or verifying bugs in other drivers. This driver is installed by the DirectX SDK. This driver may be referred to as a REF driver, a reference driver or a reference rasterizer.

+
+ + ff476328 + D3D_DRIVER_TYPE_REFERENCE + D3D_DRIVER_TYPE_REFERENCE +
+ + +

A null driver, which is a reference driver without render capability. This driver is commonly used for debugging non-rendering API calls, it is not appropriate for retail applications. This driver is installed by the DirectX SDK.

+
+ + ff476328 + D3D_DRIVER_TYPE_NULL + D3D_DRIVER_TYPE_NULL +
+ + +

A software driver, which is a driver implemented completely in software. The software implementation is not intended for a high-performance application due to its very slow performance.

+
+ + ff476328 + D3D_DRIVER_TYPE_SOFTWARE + D3D_DRIVER_TYPE_SOFTWARE +
+ + +

A WARP driver, which is a high-performance software rasterizer. The rasterizer supports feature levels 9_1 through level 10.1 with a high performance software implementation. For information about limitations creating a WARP device on certain feature levels, see Limitations Creating WARP and Reference Devices. For more information about using a WARP driver, see Windows Advanced Rasterization Platform (WARP) In-Depth Guide.

+
+ + ff476328 + D3D_DRIVER_TYPE_WARP + D3D_DRIVER_TYPE_WARP +
+ + +

Describes the set of features targeted by a Direct3D device.

+
+ +

For an overview of the capabilities of each feature level, see Overview For Each Feature Level.

For information about limitations creating nonhardware-type devices on certain feature levels, see Limitations Creating WARP and Reference Devices.

+
+ + ff476329 + D3D_FEATURE_LEVEL + D3D_FEATURE_LEVEL +
+ + +

Targets features supported by feature level 9.1 including shader model 2.

+
+ + ff476329 + D3D_FEATURE_LEVEL_9_1 + D3D_FEATURE_LEVEL_9_1 +
+ + +

Targets features supported by feature level 9.2 including shader model 2.

+
+ + ff476329 + D3D_FEATURE_LEVEL_9_2 + D3D_FEATURE_LEVEL_9_2 +
+ + +

Targets features supported by feature level 9.3 including shader model 2.0b.

+
+ + ff476329 + D3D_FEATURE_LEVEL_9_3 + D3D_FEATURE_LEVEL_9_3 +
+ + +

Targets features supported by Direct3D 10.0 including shader model 4.

+
+ + ff476329 + D3D_FEATURE_LEVEL_10_0 + D3D_FEATURE_LEVEL_10_0 +
+ + +

Targets features supported by Direct3D 10.1 including shader model 4.

+
+ + ff476329 + D3D_FEATURE_LEVEL_10_1 + D3D_FEATURE_LEVEL_10_1 +
+ + +

Targets features supported by Direct3D 11.0 including shader model 5.

+
+ + ff476329 + D3D_FEATURE_LEVEL_11_0 + D3D_FEATURE_LEVEL_11_0 +
+ + +

Values that indicate how the pipeline interprets vertex data that is bound to the input-assembler stage. These primitive topology values determine how the vertex data is rendered on screen.

+
+ +

Use the method and a value from to bind a primitive topology to the input-assembler stage. Use the method to retrieve the primitive topology for the input-assembler stage.

The following diagram shows the various primitive types for a geometry shader object.

+
+ + ff728726 + D3D_PRIMITIVE_TOPOLOGY + D3D_PRIMITIVE_TOPOLOGY +
+ + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_UNDEFINED + D3D_PRIMITIVE_TOPOLOGY_UNDEFINED + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_POINTLIST + D3D_PRIMITIVE_TOPOLOGY_POINTLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_LINELIST + D3D_PRIMITIVE_TOPOLOGY_LINELIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_LINESTRIP + D3D_PRIMITIVE_TOPOLOGY_LINESTRIP + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST + D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_TRIANGLESTRIP + D3D_PRIMITIVE_TOPOLOGY_TRIANGLESTRIP + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_LINELIST_ADJ + D3D_PRIMITIVE_TOPOLOGY_LINELIST_ADJ + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_LINESTRIP_ADJ + D3D_PRIMITIVE_TOPOLOGY_LINESTRIP_ADJ + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST_ADJ + D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST_ADJ + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_TRIANGLESTRIP_ADJ + D3D_PRIMITIVE_TOPOLOGY_TRIANGLESTRIP_ADJ + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_1_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_1_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_2_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_2_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_3_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_3_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_4_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_4_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_5_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_5_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_6_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_6_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_7_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_7_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_8_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_8_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_9_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_9_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_10_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_10_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_11_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_11_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_12_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_12_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_13_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_13_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_14_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_14_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_15_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_15_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_16_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_16_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_17_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_17_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_18_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_18_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_19_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_19_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_20_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_20_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_21_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_21_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_22_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_22_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_23_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_23_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_24_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_24_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_25_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_25_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_26_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_26_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_27_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_27_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_28_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_28_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_29_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_29_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_30_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_30_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_31_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_31_CONTROL_POINT_PATCHLIST + + + + No documentation. + + + D3D_PRIMITIVE_TOPOLOGY_32_CONTROL_POINT_PATCHLIST + D3D_PRIMITIVE_TOPOLOGY_32_CONTROL_POINT_PATCHLIST + + + +

Values that identify the type of resource to be viewed as a shader resource.

+
+ +

A -typed value is specified in the ViewDimension member of the structure or the Dimension member of the structure.

+
+ + ff728736 + D3D_SRV_DIMENSION + D3D_SRV_DIMENSION +
+ + +

The type is unknown.

+
+ + ff728736 + D3D_SRV_DIMENSION_UNKNOWN + D3D_SRV_DIMENSION_UNKNOWN +
+ + +

The resource is a buffer.

+
+ + ff728736 + D3D_SRV_DIMENSION_BUFFER + D3D_SRV_DIMENSION_BUFFER +
+ + +

The resource is a 1D texture.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURE1D + D3D_SRV_DIMENSION_TEXTURE1D +
+ + +

The resource is an array of 1D textures.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURE1DARRAY + D3D_SRV_DIMENSION_TEXTURE1DARRAY +
+ + +

The resource is a 2D texture.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURE2D + D3D_SRV_DIMENSION_TEXTURE2D +
+ + +

The resource is an array of 2D textures.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURE2DARRAY + D3D_SRV_DIMENSION_TEXTURE2DARRAY +
+ + +

The resource is a multisampling 2D texture.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURE2DMS + D3D_SRV_DIMENSION_TEXTURE2DMS +
+ + +

The resource is an array of multisampling 2D textures.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURE2DMSARRAY + D3D_SRV_DIMENSION_TEXTURE2DMSARRAY +
+ + +

The resource is a 3D texture.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURE3D + D3D_SRV_DIMENSION_TEXTURE3D +
+ + +

The resource is a cube texture.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURECUBE + D3D_SRV_DIMENSION_TEXTURECUBE +
+ + +

The resource is an array of cube textures.

+
+ + ff728736 + D3D_SRV_DIMENSION_TEXTURECUBEARRAY + D3D_SRV_DIMENSION_TEXTURECUBEARRAY +
+ + +

The resource is an extended buffer.

+
+ + ff728736 + D3D_SRV_DIMENSION_BUFFEREX + D3D_SRV_DIMENSION_BUFFEREX +
+ + + Functions + + + + + Constant DebugObjectName. + WKPDID_D3DDebugObjectName + + + + Functions + + + + + +

Creates a buffer.

+
+

Number of bytes in the blob.

+

The address of a reference to the ID3DBlob interface that is used to retrieve the buffer.

+

Returns one of the following Direct3D 10 Return Codes.

+ +

The latest D3dcompiler_nn.dll contains the compiler function. Therefore, you are no longer required to create and use an arbitrary length data buffer by using the D3D10CreateBlob function that is contained in D3d10.dll.

+
+ + ff728672 + HRESULT D3DCreateBlob([In] SIZE_T Size,[Out, Fast] ID3D10Blob** ppBlob) + D3DCreateBlob +
+ + +

This interface is used to return arbitrary length data.

+
+ +

An is obtained by calling D3D10CreateBlob.

The ID3DBlob interface is type defined in the D3DCommon.h header file as a interface, which is fully defined in the D3DCommon.h header file. ID3DBlob is version neutral and can be used in code for any Direct3D version.

Blobs can be used as a data buffer, storing vertex, adjacency, and material information during mesh optimization and loading operations. Also, these objects are used to return object code and error messages in APIs that compile vertex, geometry and pixel shaders.

+
+ + bb173507 + ID3D10Blob + ID3D10Blob +
+ + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

Get a reference to the data.

+
+

Returns a reference.

+ + bb173508 + void* ID3D10Blob::GetBufferPointer() + ID3D10Blob::GetBufferPointer +
+ + +

Get the size.

+
+

The size of the data, in bytes.

+ + bb173509 + SIZE_T ID3D10Blob::GetBufferSize() + ID3D10Blob::GetBufferSize +
+ + +

Get a reference to the data.

+
+ + bb173508 + GetBufferPointer + GetBufferPointer + void* ID3D10Blob::GetBufferPointer() +
+ + +

Get the size.

+
+ + bb173509 + GetBufferSize + GetBufferSize + SIZE_T ID3D10Blob::GetBufferSize() +
+ + +

Defines a shader macro.

+
+ +

You can use shader macros in your shaders. The structure defines a single shader macro as shown in the following example:

  Shader_Macros[1] = { "zero", "0"  };	
+            

The following shader or effect creation functions take an array of shader macros as an input parameter:

  • D3D10CompileShader
  • D3DX10PreprocessShaderFromFile
  • D3DX11CreateAsyncShaderPreprocessProcessor
+
+ + ff728732 + D3D_SHADER_MACRO + D3D_SHADER_MACRO +
+ + +

The macro name.

+
+ + ff728732 + const char* Name + char Name +
+ + +

The macro definition.

+
+ + ff728732 + const char* Definition + char Definition +
+ + + Initializes a new instance of the struct. + + + The name. + + + The definition. + + + + + No documentation. + + + SPEAKER_FLAGS + SPEAKER_FLAGS + + + + No documentation. + + + SPEAKER_FRONT_LEFT + SPEAKER_FRONT_LEFT + + + + No documentation. + + + SPEAKER_FRONT_RIGHT + SPEAKER_FRONT_RIGHT + + + + No documentation. + + + SPEAKER_FRONT_CENTER + SPEAKER_FRONT_CENTER + + + + No documentation. + + + SPEAKER_LOW_FREQUENCY + SPEAKER_LOW_FREQUENCY + + + + No documentation. + + + SPEAKER_BACK_LEFT + SPEAKER_BACK_LEFT + + + + No documentation. + + + SPEAKER_BACK_RIGHT + SPEAKER_BACK_RIGHT + + + + No documentation. + + + SPEAKER_FRONT_LEFT_OF_CENTER + SPEAKER_FRONT_LEFT_OF_CENTER + + + + No documentation. + + + SPEAKER_FRONT_RIGHT_OF_CENTER + SPEAKER_FRONT_RIGHT_OF_CENTER + + + + No documentation. + + + SPEAKER_BACK_CENTER + SPEAKER_BACK_CENTER + + + + No documentation. + + + SPEAKER_SIDE_LEFT + SPEAKER_SIDE_LEFT + + + + No documentation. + + + SPEAKER_SIDE_RIGHT + SPEAKER_SIDE_RIGHT + + + + No documentation. + + + SPEAKER_TOP_CENTER + SPEAKER_TOP_CENTER + + + + No documentation. + + + SPEAKER_TOP_FRONT_LEFT + SPEAKER_TOP_FRONT_LEFT + + + + No documentation. + + + SPEAKER_TOP_FRONT_CENTER + SPEAKER_TOP_FRONT_CENTER + + + + No documentation. + + + SPEAKER_TOP_FRONT_RIGHT + SPEAKER_TOP_FRONT_RIGHT + + + + No documentation. + + + SPEAKER_TOP_BACK_LEFT + SPEAKER_TOP_BACK_LEFT + + + + No documentation. + + + SPEAKER_TOP_BACK_CENTER + SPEAKER_TOP_BACK_CENTER + + + + No documentation. + + + SPEAKER_TOP_BACK_RIGHT + SPEAKER_TOP_BACK_RIGHT + + + + No documentation. + + + SPEAKER_RESERVED + SPEAKER_RESERVED + + + + No documentation. + + + SPEAKER_ALL + SPEAKER_ALL + + + + No documentation. + + + SPEAKER_MONO + SPEAKER_MONO + + + + No documentation. + + + SPEAKER_STEREO + SPEAKER_STEREO + + + + No documentation. + + + SPEAKER_2POINT1 + SPEAKER_2POINT1 + + + + No documentation. + + + SPEAKER_SURROUND + SPEAKER_SURROUND + + + + No documentation. + + + SPEAKER_QUAD + SPEAKER_QUAD + + + + No documentation. + + + SPEAKER_4POINT1 + SPEAKER_4POINT1 + + + + No documentation. + + + SPEAKER_5POINT1 + SPEAKER_5POINT1 + + + + No documentation. + + + SPEAKER_7POINT1 + SPEAKER_7POINT1 + + + + No documentation. + + + SPEAKER_5POINT1_SURROUND + SPEAKER_5POINT1_SURROUND + + + + No documentation. + + + SPEAKER_7POINT1_SURROUND + SPEAKER_7POINT1_SURROUND + + + + None. + + + None + None + + + + No documentation. + + + HID_USAGE_ID + HID_USAGE_ID + + + + No documentation. + + + HID_USAGE_GENERIC_POINTER + HID_USAGE_GENERIC_POINTER + + + + No documentation. + + + HID_USAGE_GENERIC_MOUSE + HID_USAGE_GENERIC_MOUSE + + + + No documentation. + + + HID_USAGE_GENERIC_JOYSTICK + HID_USAGE_GENERIC_JOYSTICK + + + + No documentation. + + + HID_USAGE_GENERIC_GAMEPAD + HID_USAGE_GENERIC_GAMEPAD + + + + No documentation. + + + HID_USAGE_GENERIC_KEYBOARD + HID_USAGE_GENERIC_KEYBOARD + + + + No documentation. + + + HID_USAGE_GENERIC_KEYPAD + HID_USAGE_GENERIC_KEYPAD + + + + No documentation. + + + HID_USAGE_GENERIC_SYSTEM_CTL + HID_USAGE_GENERIC_SYSTEM_CTL + + + + No documentation. + + + HID_USAGE_GENERIC_X + HID_USAGE_GENERIC_X + + + + No documentation. + + + HID_USAGE_GENERIC_Y + HID_USAGE_GENERIC_Y + + + + No documentation. + + + HID_USAGE_GENERIC_Z + HID_USAGE_GENERIC_Z + + + + No documentation. + + + HID_USAGE_GENERIC_RX + HID_USAGE_GENERIC_RX + + + + No documentation. + + + HID_USAGE_GENERIC_RY + HID_USAGE_GENERIC_RY + + + + No documentation. + + + HID_USAGE_GENERIC_RZ + HID_USAGE_GENERIC_RZ + + + + No documentation. + + + HID_USAGE_GENERIC_SLIDER + HID_USAGE_GENERIC_SLIDER + + + + No documentation. + + + HID_USAGE_GENERIC_DIAL + HID_USAGE_GENERIC_DIAL + + + + No documentation. + + + HID_USAGE_GENERIC_WHEEL + HID_USAGE_GENERIC_WHEEL + + + + No documentation. + + + HID_USAGE_GENERIC_HATSWITCH + HID_USAGE_GENERIC_HATSWITCH + + + + No documentation. + + + HID_USAGE_GENERIC_COUNTED_BUFFER + HID_USAGE_GENERIC_COUNTED_BUFFER + + + + No documentation. + + + HID_USAGE_GENERIC_BYTE_COUNT + HID_USAGE_GENERIC_BYTE_COUNT + + + + No documentation. + + + HID_USAGE_GENERIC_MOTION_WAKEUP + HID_USAGE_GENERIC_MOTION_WAKEUP + + + + No documentation. + + + HID_USAGE_GENERIC_VX + HID_USAGE_GENERIC_VX + + + + No documentation. + + + HID_USAGE_GENERIC_VY + HID_USAGE_GENERIC_VY + + + + No documentation. + + + HID_USAGE_GENERIC_VZ + HID_USAGE_GENERIC_VZ + + + + No documentation. + + + HID_USAGE_GENERIC_VBRX + HID_USAGE_GENERIC_VBRX + + + + No documentation. + + + HID_USAGE_GENERIC_VBRY + HID_USAGE_GENERIC_VBRY + + + + No documentation. + + + HID_USAGE_GENERIC_VBRZ + HID_USAGE_GENERIC_VBRZ + + + + No documentation. + + + HID_USAGE_GENERIC_VNO + HID_USAGE_GENERIC_VNO + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_POWER + HID_USAGE_GENERIC_SYSCTL_POWER + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_SLEEP + HID_USAGE_GENERIC_SYSCTL_SLEEP + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_WAKE + HID_USAGE_GENERIC_SYSCTL_WAKE + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_CONTEXT_MENU + HID_USAGE_GENERIC_SYSCTL_CONTEXT_MENU + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_MAIN_MENU + HID_USAGE_GENERIC_SYSCTL_MAIN_MENU + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_APP_MENU + HID_USAGE_GENERIC_SYSCTL_APP_MENU + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_HELP_MENU + HID_USAGE_GENERIC_SYSCTL_HELP_MENU + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_MENU_EXIT + HID_USAGE_GENERIC_SYSCTL_MENU_EXIT + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_MENU_SELECT + HID_USAGE_GENERIC_SYSCTL_MENU_SELECT + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_MENU_RIGHT + HID_USAGE_GENERIC_SYSCTL_MENU_RIGHT + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_MENU_LEFT + HID_USAGE_GENERIC_SYSCTL_MENU_LEFT + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_MENU_UP + HID_USAGE_GENERIC_SYSCTL_MENU_UP + + + + No documentation. + + + HID_USAGE_GENERIC_SYSCTL_MENU_DOWN + HID_USAGE_GENERIC_SYSCTL_MENU_DOWN + + + + No documentation. + + + HID_USAGE_SIMULATION_RUDDER + HID_USAGE_SIMULATION_RUDDER + + + + No documentation. + + + HID_USAGE_SIMULATION_THROTTLE + HID_USAGE_SIMULATION_THROTTLE + + + + No documentation. + + + HID_USAGE_KEYBOARD_NOEVENT + HID_USAGE_KEYBOARD_NOEVENT + + + + No documentation. + + + HID_USAGE_KEYBOARD_ROLLOVER + HID_USAGE_KEYBOARD_ROLLOVER + + + + No documentation. + + + HID_USAGE_KEYBOARD_POSTFAIL + HID_USAGE_KEYBOARD_POSTFAIL + + + + No documentation. + + + HID_USAGE_KEYBOARD_UNDEFINED + HID_USAGE_KEYBOARD_UNDEFINED + + + + No documentation. + + + HID_USAGE_KEYBOARD_aA + HID_USAGE_KEYBOARD_aA + + + + No documentation. + + + HID_USAGE_KEYBOARD_zZ + HID_USAGE_KEYBOARD_zZ + + + + No documentation. + + + HID_USAGE_KEYBOARD_ONE + HID_USAGE_KEYBOARD_ONE + + + + No documentation. + + + HID_USAGE_KEYBOARD_ZERO + HID_USAGE_KEYBOARD_ZERO + + + + No documentation. + + + HID_USAGE_KEYBOARD_LCTRL + HID_USAGE_KEYBOARD_LCTRL + + + + No documentation. + + + HID_USAGE_KEYBOARD_LSHFT + HID_USAGE_KEYBOARD_LSHFT + + + + No documentation. + + + HID_USAGE_KEYBOARD_LALT + HID_USAGE_KEYBOARD_LALT + + + + No documentation. + + + HID_USAGE_KEYBOARD_LGUI + HID_USAGE_KEYBOARD_LGUI + + + + No documentation. + + + HID_USAGE_KEYBOARD_RCTRL + HID_USAGE_KEYBOARD_RCTRL + + + + No documentation. + + + HID_USAGE_KEYBOARD_RSHFT + HID_USAGE_KEYBOARD_RSHFT + + + + No documentation. + + + HID_USAGE_KEYBOARD_RALT + HID_USAGE_KEYBOARD_RALT + + + + No documentation. + + + HID_USAGE_KEYBOARD_RGUI + HID_USAGE_KEYBOARD_RGUI + + + + No documentation. + + + HID_USAGE_KEYBOARD_SCROLL_LOCK + HID_USAGE_KEYBOARD_SCROLL_LOCK + + + + No documentation. + + + HID_USAGE_KEYBOARD_NUM_LOCK + HID_USAGE_KEYBOARD_NUM_LOCK + + + + No documentation. + + + HID_USAGE_KEYBOARD_CAPS_LOCK + HID_USAGE_KEYBOARD_CAPS_LOCK + + + + No documentation. + + + HID_USAGE_KEYBOARD_F1 + HID_USAGE_KEYBOARD_F1 + + + + No documentation. + + + HID_USAGE_KEYBOARD_F12 + HID_USAGE_KEYBOARD_F12 + + + + No documentation. + + + HID_USAGE_KEYBOARD_RETURN + HID_USAGE_KEYBOARD_RETURN + + + + No documentation. + + + HID_USAGE_KEYBOARD_ESCAPE + HID_USAGE_KEYBOARD_ESCAPE + + + + No documentation. + + + HID_USAGE_KEYBOARD_DELETE + HID_USAGE_KEYBOARD_DELETE + + + + No documentation. + + + HID_USAGE_KEYBOARD_PRINT_SCREEN + HID_USAGE_KEYBOARD_PRINT_SCREEN + + + + No documentation. + + + HID_USAGE_LED_NUM_LOCK + HID_USAGE_LED_NUM_LOCK + + + + No documentation. + + + HID_USAGE_LED_CAPS_LOCK + HID_USAGE_LED_CAPS_LOCK + + + + No documentation. + + + HID_USAGE_LED_SCROLL_LOCK + HID_USAGE_LED_SCROLL_LOCK + + + + No documentation. + + + HID_USAGE_LED_COMPOSE + HID_USAGE_LED_COMPOSE + + + + No documentation. + + + HID_USAGE_LED_KANA + HID_USAGE_LED_KANA + + + + No documentation. + + + HID_USAGE_LED_POWER + HID_USAGE_LED_POWER + + + + No documentation. + + + HID_USAGE_LED_SHIFT + HID_USAGE_LED_SHIFT + + + + No documentation. + + + HID_USAGE_LED_DO_NOT_DISTURB + HID_USAGE_LED_DO_NOT_DISTURB + + + + No documentation. + + + HID_USAGE_LED_MUTE + HID_USAGE_LED_MUTE + + + + No documentation. + + + HID_USAGE_LED_TONE_ENABLE + HID_USAGE_LED_TONE_ENABLE + + + + No documentation. + + + HID_USAGE_LED_HIGH_CUT_FILTER + HID_USAGE_LED_HIGH_CUT_FILTER + + + + No documentation. + + + HID_USAGE_LED_LOW_CUT_FILTER + HID_USAGE_LED_LOW_CUT_FILTER + + + + No documentation. + + + HID_USAGE_LED_EQUALIZER_ENABLE + HID_USAGE_LED_EQUALIZER_ENABLE + + + + No documentation. + + + HID_USAGE_LED_SOUND_FIELD_ON + HID_USAGE_LED_SOUND_FIELD_ON + + + + No documentation. + + + HID_USAGE_LED_SURROUND_FIELD_ON + HID_USAGE_LED_SURROUND_FIELD_ON + + + + No documentation. + + + HID_USAGE_LED_REPEAT + HID_USAGE_LED_REPEAT + + + + No documentation. + + + HID_USAGE_LED_STEREO + HID_USAGE_LED_STEREO + + + + No documentation. + + + HID_USAGE_LED_SAMPLING_RATE_DETECT + HID_USAGE_LED_SAMPLING_RATE_DETECT + + + + No documentation. + + + HID_USAGE_LED_SPINNING + HID_USAGE_LED_SPINNING + + + + No documentation. + + + HID_USAGE_LED_CAV + HID_USAGE_LED_CAV + + + + No documentation. + + + HID_USAGE_LED_CLV + HID_USAGE_LED_CLV + + + + No documentation. + + + HID_USAGE_LED_RECORDING_FORMAT_DET + HID_USAGE_LED_RECORDING_FORMAT_DET + + + + No documentation. + + + HID_USAGE_LED_OFF_HOOK + HID_USAGE_LED_OFF_HOOK + + + + No documentation. + + + HID_USAGE_LED_RING + HID_USAGE_LED_RING + + + + No documentation. + + + HID_USAGE_LED_MESSAGE_WAITING + HID_USAGE_LED_MESSAGE_WAITING + + + + No documentation. + + + HID_USAGE_LED_DATA_MODE + HID_USAGE_LED_DATA_MODE + + + + No documentation. + + + HID_USAGE_LED_BATTERY_OPERATION + HID_USAGE_LED_BATTERY_OPERATION + + + + No documentation. + + + HID_USAGE_LED_BATTERY_OK + HID_USAGE_LED_BATTERY_OK + + + + No documentation. + + + HID_USAGE_LED_BATTERY_LOW + HID_USAGE_LED_BATTERY_LOW + + + + No documentation. + + + HID_USAGE_LED_SPEAKER + HID_USAGE_LED_SPEAKER + + + + No documentation. + + + HID_USAGE_LED_HEAD_SET + HID_USAGE_LED_HEAD_SET + + + + No documentation. + + + HID_USAGE_LED_HOLD + HID_USAGE_LED_HOLD + + + + No documentation. + + + HID_USAGE_LED_MICROPHONE + HID_USAGE_LED_MICROPHONE + + + + No documentation. + + + HID_USAGE_LED_COVERAGE + HID_USAGE_LED_COVERAGE + + + + No documentation. + + + HID_USAGE_LED_NIGHT_MODE + HID_USAGE_LED_NIGHT_MODE + + + + No documentation. + + + HID_USAGE_LED_SEND_CALLS + HID_USAGE_LED_SEND_CALLS + + + + No documentation. + + + HID_USAGE_LED_CALL_PICKUP + HID_USAGE_LED_CALL_PICKUP + + + + No documentation. + + + HID_USAGE_LED_CONFERENCE + HID_USAGE_LED_CONFERENCE + + + + No documentation. + + + HID_USAGE_LED_STAND_BY + HID_USAGE_LED_STAND_BY + + + + No documentation. + + + HID_USAGE_LED_CAMERA_ON + HID_USAGE_LED_CAMERA_ON + + + + No documentation. + + + HID_USAGE_LED_CAMERA_OFF + HID_USAGE_LED_CAMERA_OFF + + + + No documentation. + + + HID_USAGE_LED_ON_LINE + HID_USAGE_LED_ON_LINE + + + + No documentation. + + + HID_USAGE_LED_OFF_LINE + HID_USAGE_LED_OFF_LINE + + + + No documentation. + + + HID_USAGE_LED_BUSY + HID_USAGE_LED_BUSY + + + + No documentation. + + + HID_USAGE_LED_READY + HID_USAGE_LED_READY + + + + No documentation. + + + HID_USAGE_LED_PAPER_OUT + HID_USAGE_LED_PAPER_OUT + + + + No documentation. + + + HID_USAGE_LED_PAPER_JAM + HID_USAGE_LED_PAPER_JAM + + + + No documentation. + + + HID_USAGE_LED_REMOTE + HID_USAGE_LED_REMOTE + + + + No documentation. + + + HID_USAGE_LED_FORWARD + HID_USAGE_LED_FORWARD + + + + No documentation. + + + HID_USAGE_LED_REVERSE + HID_USAGE_LED_REVERSE + + + + No documentation. + + + HID_USAGE_LED_STOP + HID_USAGE_LED_STOP + + + + No documentation. + + + HID_USAGE_LED_REWIND + HID_USAGE_LED_REWIND + + + + No documentation. + + + HID_USAGE_LED_FAST_FORWARD + HID_USAGE_LED_FAST_FORWARD + + + + No documentation. + + + HID_USAGE_LED_PLAY + HID_USAGE_LED_PLAY + + + + No documentation. + + + HID_USAGE_LED_PAUSE + HID_USAGE_LED_PAUSE + + + + No documentation. + + + HID_USAGE_LED_RECORD + HID_USAGE_LED_RECORD + + + + No documentation. + + + HID_USAGE_LED_ERROR + HID_USAGE_LED_ERROR + + + + No documentation. + + + HID_USAGE_LED_SELECTED_INDICATOR + HID_USAGE_LED_SELECTED_INDICATOR + + + + No documentation. + + + HID_USAGE_LED_IN_USE_INDICATOR + HID_USAGE_LED_IN_USE_INDICATOR + + + + No documentation. + + + HID_USAGE_LED_MULTI_MODE_INDICATOR + HID_USAGE_LED_MULTI_MODE_INDICATOR + + + + No documentation. + + + HID_USAGE_LED_INDICATOR_ON + HID_USAGE_LED_INDICATOR_ON + + + + No documentation. + + + HID_USAGE_LED_INDICATOR_FLASH + HID_USAGE_LED_INDICATOR_FLASH + + + + No documentation. + + + HID_USAGE_LED_INDICATOR_SLOW_BLINK + HID_USAGE_LED_INDICATOR_SLOW_BLINK + + + + No documentation. + + + HID_USAGE_LED_INDICATOR_FAST_BLINK + HID_USAGE_LED_INDICATOR_FAST_BLINK + + + + No documentation. + + + HID_USAGE_LED_INDICATOR_OFF + HID_USAGE_LED_INDICATOR_OFF + + + + No documentation. + + + HID_USAGE_LED_FLASH_ON_TIME + HID_USAGE_LED_FLASH_ON_TIME + + + + No documentation. + + + HID_USAGE_LED_SLOW_BLINK_ON_TIME + HID_USAGE_LED_SLOW_BLINK_ON_TIME + + + + No documentation. + + + HID_USAGE_LED_SLOW_BLINK_OFF_TIME + HID_USAGE_LED_SLOW_BLINK_OFF_TIME + + + + No documentation. + + + HID_USAGE_LED_FAST_BLINK_ON_TIME + HID_USAGE_LED_FAST_BLINK_ON_TIME + + + + No documentation. + + + HID_USAGE_LED_FAST_BLINK_OFF_TIME + HID_USAGE_LED_FAST_BLINK_OFF_TIME + + + + No documentation. + + + HID_USAGE_LED_INDICATOR_COLOR + HID_USAGE_LED_INDICATOR_COLOR + + + + No documentation. + + + HID_USAGE_LED_RED + HID_USAGE_LED_RED + + + + No documentation. + + + HID_USAGE_LED_GREEN + HID_USAGE_LED_GREEN + + + + No documentation. + + + HID_USAGE_LED_AMBER + HID_USAGE_LED_AMBER + + + + No documentation. + + + HID_USAGE_LED_GENERIC_INDICATOR + HID_USAGE_LED_GENERIC_INDICATOR + + + + No documentation. + + + HID_USAGE_TELEPHONY_PHONE + HID_USAGE_TELEPHONY_PHONE + + + + No documentation. + + + HID_USAGE_TELEPHONY_ANSWERING_MACHINE + HID_USAGE_TELEPHONY_ANSWERING_MACHINE + + + + No documentation. + + + HID_USAGE_TELEPHONY_MESSAGE_CONTROLS + HID_USAGE_TELEPHONY_MESSAGE_CONTROLS + + + + No documentation. + + + HID_USAGE_TELEPHONY_HANDSET + HID_USAGE_TELEPHONY_HANDSET + + + + No documentation. + + + HID_USAGE_TELEPHONY_HEADSET + HID_USAGE_TELEPHONY_HEADSET + + + + No documentation. + + + HID_USAGE_TELEPHONY_KEYPAD + HID_USAGE_TELEPHONY_KEYPAD + + + + No documentation. + + + HID_USAGE_TELEPHONY_PROGRAMMABLE_BUTTON + HID_USAGE_TELEPHONY_PROGRAMMABLE_BUTTON + + + + No documentation. + + + HID_USAGE_TELEPHONY_REDIAL + HID_USAGE_TELEPHONY_REDIAL + + + + No documentation. + + + HID_USAGE_TELEPHONY_TRANSFER + HID_USAGE_TELEPHONY_TRANSFER + + + + No documentation. + + + HID_USAGE_TELEPHONY_DROP + HID_USAGE_TELEPHONY_DROP + + + + No documentation. + + + HID_USAGE_TELEPHONY_LINE + HID_USAGE_TELEPHONY_LINE + + + + No documentation. + + + HID_USAGE_TELEPHONY_RING_ENABLE + HID_USAGE_TELEPHONY_RING_ENABLE + + + + No documentation. + + + HID_USAGE_TELEPHONY_SEND + HID_USAGE_TELEPHONY_SEND + + + + No documentation. + + + HID_USAGE_TELEPHONY_KEYPAD_0 + HID_USAGE_TELEPHONY_KEYPAD_0 + + + + No documentation. + + + HID_USAGE_TELEPHONY_KEYPAD_D + HID_USAGE_TELEPHONY_KEYPAD_D + + + + No documentation. + + + HID_USAGE_TELEPHONY_HOST_AVAILABLE + HID_USAGE_TELEPHONY_HOST_AVAILABLE + + + + No documentation. + + + HID_USAGE_MS_BTH_HF_DIALNUMBER + HID_USAGE_MS_BTH_HF_DIALNUMBER + + + + No documentation. + + + HID_USAGE_MS_BTH_HF_DIALMEMORY + HID_USAGE_MS_BTH_HF_DIALMEMORY + + + + No documentation. + + + HID_USAGE_CONSUMERCTRL + HID_USAGE_CONSUMERCTRL + + + + No documentation. + + + HID_USAGE_DIGITIZER_PEN + HID_USAGE_DIGITIZER_PEN + + + + No documentation. + + + HID_USAGE_DIGITIZER_IN_RANGE + HID_USAGE_DIGITIZER_IN_RANGE + + + + No documentation. + + + HID_USAGE_DIGITIZER_TIP_SWITCH + HID_USAGE_DIGITIZER_TIP_SWITCH + + + + No documentation. + + + HID_USAGE_DIGITIZER_BARREL_SWITCH + HID_USAGE_DIGITIZER_BARREL_SWITCH + + + + No documentation. + + + HID_USAGE_PAGE + HID_USAGE_PAGE + + + + No documentation. + + + HID_USAGE_PAGE_UNDEFINED + HID_USAGE_PAGE_UNDEFINED + + + + No documentation. + + + HID_USAGE_PAGE_GENERIC + HID_USAGE_PAGE_GENERIC + + + + No documentation. + + + HID_USAGE_PAGE_SIMULATION + HID_USAGE_PAGE_SIMULATION + + + + No documentation. + + + HID_USAGE_PAGE_VR + HID_USAGE_PAGE_VR + + + + No documentation. + + + HID_USAGE_PAGE_SPORT + HID_USAGE_PAGE_SPORT + + + + No documentation. + + + HID_USAGE_PAGE_GAME + HID_USAGE_PAGE_GAME + + + + No documentation. + + + HID_USAGE_PAGE_KEYBOARD + HID_USAGE_PAGE_KEYBOARD + + + + No documentation. + + + HID_USAGE_PAGE_LED + HID_USAGE_PAGE_LED + + + + No documentation. + + + HID_USAGE_PAGE_BUTTON + HID_USAGE_PAGE_BUTTON + + + + No documentation. + + + HID_USAGE_PAGE_ORDINAL + HID_USAGE_PAGE_ORDINAL + + + + No documentation. + + + HID_USAGE_PAGE_TELEPHONY + HID_USAGE_PAGE_TELEPHONY + + + + No documentation. + + + HID_USAGE_PAGE_CONSUMER + HID_USAGE_PAGE_CONSUMER + + + + No documentation. + + + HID_USAGE_PAGE_DIGITIZER + HID_USAGE_PAGE_DIGITIZER + + + + No documentation. + + + HID_USAGE_PAGE_UNICODE + HID_USAGE_PAGE_UNICODE + + + + No documentation. + + + HID_USAGE_PAGE_ALPHANUMERIC + HID_USAGE_PAGE_ALPHANUMERIC + + + + No documentation. + + + HID_USAGE_PAGE_MICROSOFT_BLUETOOTH_HANDSFREE + HID_USAGE_PAGE_MICROSOFT_BLUETOOTH_HANDSFREE + + + + No documentation. + + + HID_USAGE_PAGE_MEDICAL + HID_USAGE_PAGE_MEDICAL + + + + No documentation. + + + HID_USAGE_PAGE_MONITOR_PAGE0 + HID_USAGE_PAGE_MONITOR_PAGE0 + + + + No documentation. + + + HID_USAGE_PAGE_MONITOR_PAGE1 + HID_USAGE_PAGE_MONITOR_PAGE1 + + + + No documentation. + + + HID_USAGE_PAGE_MONITOR_PAGE2 + HID_USAGE_PAGE_MONITOR_PAGE2 + + + + No documentation. + + + HID_USAGE_PAGE_MONITOR_PAGE3 + HID_USAGE_PAGE_MONITOR_PAGE3 + + + + No documentation. + + + HID_USAGE_PAGE_POWER_PAGE0 + HID_USAGE_PAGE_POWER_PAGE0 + + + + No documentation. + + + HID_USAGE_PAGE_POWER_PAGE1 + HID_USAGE_PAGE_POWER_PAGE1 + + + + No documentation. + + + HID_USAGE_PAGE_POWER_PAGE2 + HID_USAGE_PAGE_POWER_PAGE2 + + + + No documentation. + + + HID_USAGE_PAGE_POWER_PAGE3 + HID_USAGE_PAGE_POWER_PAGE3 + + + + No documentation. + + + HID_USAGE_PAGE_BARCODE + HID_USAGE_PAGE_BARCODE + + + + No documentation. + + + HID_USAGE_PAGE_SCALE + HID_USAGE_PAGE_SCALE + + + + No documentation. + + + HID_USAGE_PAGE_MSR + HID_USAGE_PAGE_MSR + + + + No documentation. + + + WAVE_FORMAT_ENCODING + WAVE_FORMAT_ENCODING + + + + No documentation. + + + WAVE_FORMAT_UNKNOWN + WAVE_FORMAT_UNKNOWN + + + + No documentation. + + + WAVE_FORMAT_ADPCM + WAVE_FORMAT_ADPCM + + + + No documentation. + + + WAVE_FORMAT_IEEE_FLOAT + WAVE_FORMAT_IEEE_FLOAT + + + + No documentation. + + + WAVE_FORMAT_VSELP + WAVE_FORMAT_VSELP + + + + No documentation. + + + WAVE_FORMAT_IBM_CVSD + WAVE_FORMAT_IBM_CVSD + + + + No documentation. + + + WAVE_FORMAT_ALAW + WAVE_FORMAT_ALAW + + + + No documentation. + + + WAVE_FORMAT_MULAW + WAVE_FORMAT_MULAW + + + + No documentation. + + + WAVE_FORMAT_DTS + WAVE_FORMAT_DTS + + + + No documentation. + + + WAVE_FORMAT_DRM + WAVE_FORMAT_DRM + + + + No documentation. + + + WAVE_FORMAT_WMAVOICE9 + WAVE_FORMAT_WMAVOICE9 + + + + No documentation. + + + WAVE_FORMAT_WMAVOICE10 + WAVE_FORMAT_WMAVOICE10 + + + + No documentation. + + + WAVE_FORMAT_OKI_ADPCM + WAVE_FORMAT_OKI_ADPCM + + + + No documentation. + + + WAVE_FORMAT_DVI_ADPCM + WAVE_FORMAT_DVI_ADPCM + + + + No documentation. + + + WAVE_FORMAT_IMA_ADPCM + WAVE_FORMAT_IMA_ADPCM + + + + No documentation. + + + WAVE_FORMAT_MEDIASPACE_ADPCM + WAVE_FORMAT_MEDIASPACE_ADPCM + + + + No documentation. + + + WAVE_FORMAT_SIERRA_ADPCM + WAVE_FORMAT_SIERRA_ADPCM + + + + No documentation. + + + WAVE_FORMAT_G723_ADPCM + WAVE_FORMAT_G723_ADPCM + + + + No documentation. + + + WAVE_FORMAT_DIGISTD + WAVE_FORMAT_DIGISTD + + + + No documentation. + + + WAVE_FORMAT_DIGIFIX + WAVE_FORMAT_DIGIFIX + + + + No documentation. + + + WAVE_FORMAT_DIALOGIC_OKI_ADPCM + WAVE_FORMAT_DIALOGIC_OKI_ADPCM + + + + No documentation. + + + WAVE_FORMAT_MEDIAVISION_ADPCM + WAVE_FORMAT_MEDIAVISION_ADPCM + + + + No documentation. + + + WAVE_FORMAT_CU_CODEC + WAVE_FORMAT_CU_CODEC + + + + No documentation. + + + WAVE_FORMAT_YAMAHA_ADPCM + WAVE_FORMAT_YAMAHA_ADPCM + + + + No documentation. + + + WAVE_FORMAT_SONARC + WAVE_FORMAT_SONARC + + + + No documentation. + + + WAVE_FORMAT_DSPGROUP_TRUESPEECH + WAVE_FORMAT_DSPGROUP_TRUESPEECH + + + + No documentation. + + + WAVE_FORMAT_ECHOSC1 + WAVE_FORMAT_ECHOSC1 + + + + No documentation. + + + WAVE_FORMAT_AUDIOFILE_AF36 + WAVE_FORMAT_AUDIOFILE_AF36 + + + + No documentation. + + + WAVE_FORMAT_APTX + WAVE_FORMAT_APTX + + + + No documentation. + + + WAVE_FORMAT_AUDIOFILE_AF10 + WAVE_FORMAT_AUDIOFILE_AF10 + + + + No documentation. + + + WAVE_FORMAT_PROSODY_1612 + WAVE_FORMAT_PROSODY_1612 + + + + No documentation. + + + WAVE_FORMAT_LRC + WAVE_FORMAT_LRC + + + + No documentation. + + + WAVE_FORMAT_DOLBY_AC2 + WAVE_FORMAT_DOLBY_AC2 + + + + No documentation. + + + WAVE_FORMAT_GSM610 + WAVE_FORMAT_GSM610 + + + + No documentation. + + + WAVE_FORMAT_MSNAUDIO + WAVE_FORMAT_MSNAUDIO + + + + No documentation. + + + WAVE_FORMAT_ANTEX_ADPCME + WAVE_FORMAT_ANTEX_ADPCME + + + + No documentation. + + + WAVE_FORMAT_CONTROL_RES_VQLPC + WAVE_FORMAT_CONTROL_RES_VQLPC + + + + No documentation. + + + WAVE_FORMAT_DIGIREAL + WAVE_FORMAT_DIGIREAL + + + + No documentation. + + + WAVE_FORMAT_DIGIADPCM + WAVE_FORMAT_DIGIADPCM + + + + No documentation. + + + WAVE_FORMAT_CONTROL_RES_CR10 + WAVE_FORMAT_CONTROL_RES_CR10 + + + + No documentation. + + + WAVE_FORMAT_NMS_VBXADPCM + WAVE_FORMAT_NMS_VBXADPCM + + + + No documentation. + + + WAVE_FORMAT_CS_IMAADPCM + WAVE_FORMAT_CS_IMAADPCM + + + + No documentation. + + + WAVE_FORMAT_ECHOSC3 + WAVE_FORMAT_ECHOSC3 + + + + No documentation. + + + WAVE_FORMAT_ROCKWELL_ADPCM + WAVE_FORMAT_ROCKWELL_ADPCM + + + + No documentation. + + + WAVE_FORMAT_ROCKWELL_DIGITALK + WAVE_FORMAT_ROCKWELL_DIGITALK + + + + No documentation. + + + WAVE_FORMAT_XEBEC + WAVE_FORMAT_XEBEC + + + + No documentation. + + + WAVE_FORMAT_G721_ADPCM + WAVE_FORMAT_G721_ADPCM + + + + No documentation. + + + WAVE_FORMAT_G728_CELP + WAVE_FORMAT_G728_CELP + + + + No documentation. + + + WAVE_FORMAT_MSG723 + WAVE_FORMAT_MSG723 + + + + No documentation. + + + WAVE_FORMAT_MPEG + WAVE_FORMAT_MPEG + + + + No documentation. + + + WAVE_FORMAT_RT24 + WAVE_FORMAT_RT24 + + + + No documentation. + + + WAVE_FORMAT_PAC + WAVE_FORMAT_PAC + + + + No documentation. + + + WAVE_FORMAT_MPEGLAYER3 + WAVE_FORMAT_MPEGLAYER3 + + + + No documentation. + + + WAVE_FORMAT_LUCENT_G723 + WAVE_FORMAT_LUCENT_G723 + + + + No documentation. + + + WAVE_FORMAT_CIRRUS + WAVE_FORMAT_CIRRUS + + + + No documentation. + + + WAVE_FORMAT_ESPCM + WAVE_FORMAT_ESPCM + + + + No documentation. + + + WAVE_FORMAT_VOXWARE + WAVE_FORMAT_VOXWARE + + + + No documentation. + + + WAVE_FORMAT_CANOPUS_ATRAC + WAVE_FORMAT_CANOPUS_ATRAC + + + + No documentation. + + + WAVE_FORMAT_G726_ADPCM + WAVE_FORMAT_G726_ADPCM + + + + No documentation. + + + WAVE_FORMAT_G722_ADPCM + WAVE_FORMAT_G722_ADPCM + + + + No documentation. + + + WAVE_FORMAT_DSAT_DISPLAY + WAVE_FORMAT_DSAT_DISPLAY + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_BYTE_ALIGNED + WAVE_FORMAT_VOXWARE_BYTE_ALIGNED + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_AC8 + WAVE_FORMAT_VOXWARE_AC8 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_AC10 + WAVE_FORMAT_VOXWARE_AC10 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_AC16 + WAVE_FORMAT_VOXWARE_AC16 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_AC20 + WAVE_FORMAT_VOXWARE_AC20 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_RT24 + WAVE_FORMAT_VOXWARE_RT24 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_RT29 + WAVE_FORMAT_VOXWARE_RT29 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_RT29HW + WAVE_FORMAT_VOXWARE_RT29HW + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_VR12 + WAVE_FORMAT_VOXWARE_VR12 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_VR18 + WAVE_FORMAT_VOXWARE_VR18 + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_TQ40 + WAVE_FORMAT_VOXWARE_TQ40 + + + + No documentation. + + + WAVE_FORMAT_SOFTSOUND + WAVE_FORMAT_SOFTSOUND + + + + No documentation. + + + WAVE_FORMAT_VOXWARE_TQ60 + WAVE_FORMAT_VOXWARE_TQ60 + + + + No documentation. + + + WAVE_FORMAT_MSRT24 + WAVE_FORMAT_MSRT24 + + + + No documentation. + + + WAVE_FORMAT_G729A + WAVE_FORMAT_G729A + + + + No documentation. + + + WAVE_FORMAT_MVI_MVI2 + WAVE_FORMAT_MVI_MVI2 + + + + No documentation. + + + WAVE_FORMAT_DF_G726 + WAVE_FORMAT_DF_G726 + + + + No documentation. + + + WAVE_FORMAT_DF_GSM610 + WAVE_FORMAT_DF_GSM610 + + + + No documentation. + + + WAVE_FORMAT_ISIAUDIO + WAVE_FORMAT_ISIAUDIO + + + + No documentation. + + + WAVE_FORMAT_ONLIVE + WAVE_FORMAT_ONLIVE + + + + No documentation. + + + WAVE_FORMAT_SBC24 + WAVE_FORMAT_SBC24 + + + + No documentation. + + + WAVE_FORMAT_DOLBY_AC3_SPDIF + WAVE_FORMAT_DOLBY_AC3_SPDIF + + + + No documentation. + + + WAVE_FORMAT_MEDIASONIC_G723 + WAVE_FORMAT_MEDIASONIC_G723 + + + + No documentation. + + + WAVE_FORMAT_PROSODY_8KBPS + WAVE_FORMAT_PROSODY_8KBPS + + + + No documentation. + + + WAVE_FORMAT_ZYXEL_ADPCM + WAVE_FORMAT_ZYXEL_ADPCM + + + + No documentation. + + + WAVE_FORMAT_PHILIPS_LPCBB + WAVE_FORMAT_PHILIPS_LPCBB + + + + No documentation. + + + WAVE_FORMAT_PACKED + WAVE_FORMAT_PACKED + + + + No documentation. + + + WAVE_FORMAT_MALDEN_PHONYTALK + WAVE_FORMAT_MALDEN_PHONYTALK + + + + No documentation. + + + WAVE_FORMAT_RAW_AAC1 + WAVE_FORMAT_RAW_AAC1 + + + + No documentation. + + + WAVE_FORMAT_RHETOREX_ADPCM + WAVE_FORMAT_RHETOREX_ADPCM + + + + No documentation. + + + WAVE_FORMAT_IRAT + WAVE_FORMAT_IRAT + + + + No documentation. + + + WAVE_FORMAT_VIVO_G723 + WAVE_FORMAT_VIVO_G723 + + + + No documentation. + + + WAVE_FORMAT_VIVO_SIREN + WAVE_FORMAT_VIVO_SIREN + + + + No documentation. + + + WAVE_FORMAT_DIGITAL_G723 + WAVE_FORMAT_DIGITAL_G723 + + + + No documentation. + + + WAVE_FORMAT_SANYO_LD_ADPCM + WAVE_FORMAT_SANYO_LD_ADPCM + + + + No documentation. + + + WAVE_FORMAT_SIPROLAB_ACEPLNET + WAVE_FORMAT_SIPROLAB_ACEPLNET + + + + No documentation. + + + WAVE_FORMAT_SIPROLAB_ACELP4800 + WAVE_FORMAT_SIPROLAB_ACELP4800 + + + + No documentation. + + + WAVE_FORMAT_SIPROLAB_ACELP8V3 + WAVE_FORMAT_SIPROLAB_ACELP8V3 + + + + No documentation. + + + WAVE_FORMAT_SIPROLAB_G729 + WAVE_FORMAT_SIPROLAB_G729 + + + + No documentation. + + + WAVE_FORMAT_SIPROLAB_G729A + WAVE_FORMAT_SIPROLAB_G729A + + + + No documentation. + + + WAVE_FORMAT_SIPROLAB_KELVIN + WAVE_FORMAT_SIPROLAB_KELVIN + + + + No documentation. + + + WAVE_FORMAT_G726ADPCM + WAVE_FORMAT_G726ADPCM + + + + No documentation. + + + WAVE_FORMAT_QUALCOMM_PUREVOICE + WAVE_FORMAT_QUALCOMM_PUREVOICE + + + + No documentation. + + + WAVE_FORMAT_QUALCOMM_HALFRATE + WAVE_FORMAT_QUALCOMM_HALFRATE + + + + No documentation. + + + WAVE_FORMAT_TUBGSM + WAVE_FORMAT_TUBGSM + + + + No documentation. + + + WAVE_FORMAT_MSAUDIO1 + WAVE_FORMAT_MSAUDIO1 + + + + No documentation. + + + WAVE_FORMAT_WMAUDIO2 + WAVE_FORMAT_WMAUDIO2 + + + + No documentation. + + + WAVE_FORMAT_WMAUDIO3 + WAVE_FORMAT_WMAUDIO3 + + + + No documentation. + + + WAVE_FORMAT_WMAUDIO_LOSSLESS + WAVE_FORMAT_WMAUDIO_LOSSLESS + + + + No documentation. + + + WAVE_FORMAT_WMASPDIF + WAVE_FORMAT_WMASPDIF + + + + No documentation. + + + WAVE_FORMAT_UNISYS_NAP_ADPCM + WAVE_FORMAT_UNISYS_NAP_ADPCM + + + + No documentation. + + + WAVE_FORMAT_UNISYS_NAP_ULAW + WAVE_FORMAT_UNISYS_NAP_ULAW + + + + No documentation. + + + WAVE_FORMAT_UNISYS_NAP_ALAW + WAVE_FORMAT_UNISYS_NAP_ALAW + + + + No documentation. + + + WAVE_FORMAT_UNISYS_NAP_16K + WAVE_FORMAT_UNISYS_NAP_16K + + + + No documentation. + + + WAVE_FORMAT_CREATIVE_ADPCM + WAVE_FORMAT_CREATIVE_ADPCM + + + + No documentation. + + + WAVE_FORMAT_CREATIVE_FASTSPEECH8 + WAVE_FORMAT_CREATIVE_FASTSPEECH8 + + + + No documentation. + + + WAVE_FORMAT_CREATIVE_FASTSPEECH10 + WAVE_FORMAT_CREATIVE_FASTSPEECH10 + + + + No documentation. + + + WAVE_FORMAT_UHER_ADPCM + WAVE_FORMAT_UHER_ADPCM + + + + No documentation. + + + WAVE_FORMAT_QUARTERDECK + WAVE_FORMAT_QUARTERDECK + + + + No documentation. + + + WAVE_FORMAT_ILINK_VC + WAVE_FORMAT_ILINK_VC + + + + No documentation. + + + WAVE_FORMAT_RAW_SPORT + WAVE_FORMAT_RAW_SPORT + + + + No documentation. + + + WAVE_FORMAT_ESST_AC3 + WAVE_FORMAT_ESST_AC3 + + + + No documentation. + + + WAVE_FORMAT_GENERIC_PASSTHRU + WAVE_FORMAT_GENERIC_PASSTHRU + + + + No documentation. + + + WAVE_FORMAT_IPI_HSX + WAVE_FORMAT_IPI_HSX + + + + No documentation. + + + WAVE_FORMAT_IPI_RPELP + WAVE_FORMAT_IPI_RPELP + + + + No documentation. + + + WAVE_FORMAT_CS2 + WAVE_FORMAT_CS2 + + + + No documentation. + + + WAVE_FORMAT_SONY_SCX + WAVE_FORMAT_SONY_SCX + + + + No documentation. + + + WAVE_FORMAT_FM_TOWNS_SND + WAVE_FORMAT_FM_TOWNS_SND + + + + No documentation. + + + WAVE_FORMAT_BTV_DIGITAL + WAVE_FORMAT_BTV_DIGITAL + + + + No documentation. + + + WAVE_FORMAT_QDESIGN_MUSIC + WAVE_FORMAT_QDESIGN_MUSIC + + + + No documentation. + + + WAVE_FORMAT_VME_VMPCM + WAVE_FORMAT_VME_VMPCM + + + + No documentation. + + + WAVE_FORMAT_TPC + WAVE_FORMAT_TPC + + + + No documentation. + + + WAVE_FORMAT_OLIGSM + WAVE_FORMAT_OLIGSM + + + + No documentation. + + + WAVE_FORMAT_OLIADPCM + WAVE_FORMAT_OLIADPCM + + + + No documentation. + + + WAVE_FORMAT_OLICELP + WAVE_FORMAT_OLICELP + + + + No documentation. + + + WAVE_FORMAT_OLISBC + WAVE_FORMAT_OLISBC + + + + No documentation. + + + WAVE_FORMAT_OLIOPR + WAVE_FORMAT_OLIOPR + + + + No documentation. + + + WAVE_FORMAT_LH_CODEC + WAVE_FORMAT_LH_CODEC + + + + No documentation. + + + WAVE_FORMAT_NORRIS + WAVE_FORMAT_NORRIS + + + + No documentation. + + + WAVE_FORMAT_SOUNDSPACE_MUSICOMPRESS + WAVE_FORMAT_SOUNDSPACE_MUSICOMPRESS + + + + No documentation. + + + WAVE_FORMAT_MPEG_ADTS_AAC + WAVE_FORMAT_MPEG_ADTS_AAC + + + + No documentation. + + + WAVE_FORMAT_MPEG_RAW_AAC + WAVE_FORMAT_MPEG_RAW_AAC + + + + No documentation. + + + WAVE_FORMAT_MPEG_LOAS + WAVE_FORMAT_MPEG_LOAS + + + + No documentation. + + + WAVE_FORMAT_NOKIA_MPEG_ADTS_AAC + WAVE_FORMAT_NOKIA_MPEG_ADTS_AAC + + + + No documentation. + + + WAVE_FORMAT_NOKIA_MPEG_RAW_AAC + WAVE_FORMAT_NOKIA_MPEG_RAW_AAC + + + + No documentation. + + + WAVE_FORMAT_VODAFONE_MPEG_ADTS_AAC + WAVE_FORMAT_VODAFONE_MPEG_ADTS_AAC + + + + No documentation. + + + WAVE_FORMAT_VODAFONE_MPEG_RAW_AAC + WAVE_FORMAT_VODAFONE_MPEG_RAW_AAC + + + + No documentation. + + + WAVE_FORMAT_MPEG_HEAAC + WAVE_FORMAT_MPEG_HEAAC + + + + No documentation. + + + WAVE_FORMAT_DVM + WAVE_FORMAT_DVM + + + + No documentation. + + + WAVE_FORMAT_DTS2 + WAVE_FORMAT_DTS2 + + + + No documentation. + + + WAVE_FORMAT_EXTENSIBLE + WAVE_FORMAT_EXTENSIBLE + + + + No documentation. + + + WAVE_FORMAT_DEVELOPMENT + WAVE_FORMAT_DEVELOPMENT + + + + No documentation. + + + WAVE_FORMAT_PCM + WAVE_FORMAT_PCM + + + + No documentation. + + + STGC + STGC + + + + No documentation. + + + STGC_DEFAULT + STGC_DEFAULT + + + + No documentation. + + + STGC_OVERWRITE + STGC_OVERWRITE + + + + No documentation. + + + STGC_ONLYIFCURRENT + STGC_ONLYIFCURRENT + + + + No documentation. + + + STGC_DANGEROUSLYCOMMITMERELYTODISKCACHE + STGC_DANGEROUSLYCOMMITMERELYTODISKCACHE + + + + No documentation. + + + STGC_CONSOLIDATE + STGC_CONSOLIDATE + + + + No documentation. + + + SHARPDX_ERRORCODE + SHARPDX_ERRORCODE + + + + No documentation. + + + ERROR_SUCCESS + ERROR_SUCCESS + + + + No documentation. + + + ERROR_INVALID_FUNCTION + ERROR_INVALID_FUNCTION + + + + No documentation. + + + ERROR_FILE_NOT_FOUND + ERROR_FILE_NOT_FOUND + + + + No documentation. + + + ERROR_PATH_NOT_FOUND + ERROR_PATH_NOT_FOUND + + + + No documentation. + + + ERROR_TOO_MANY_OPEN_FILES + ERROR_TOO_MANY_OPEN_FILES + + + + No documentation. + + + ERROR_ACCESS_DENIED + ERROR_ACCESS_DENIED + + + + No documentation. + + + ERROR_INVALID_HANDLE + ERROR_INVALID_HANDLE + + + + No documentation. + + + ERROR_ARENA_TRASHED + ERROR_ARENA_TRASHED + + + + No documentation. + + + ERROR_NOT_ENOUGH_MEMORY + ERROR_NOT_ENOUGH_MEMORY + + + + No documentation. + + + ERROR_INVALID_BLOCK + ERROR_INVALID_BLOCK + + + + No documentation. + + + ERROR_BAD_ENVIRONMENT + ERROR_BAD_ENVIRONMENT + + + + No documentation. + + + ERROR_BAD_FORMAT + ERROR_BAD_FORMAT + + + + No documentation. + + + ERROR_INVALID_ACCESS + ERROR_INVALID_ACCESS + + + + No documentation. + + + ERROR_INVALID_DATA + ERROR_INVALID_DATA + + + + No documentation. + + + ERROR_OUTOFMEMORY + ERROR_OUTOFMEMORY + + + + No documentation. + + + ERROR_INVALID_DRIVE + ERROR_INVALID_DRIVE + + + + No documentation. + + + ERROR_CURRENT_DIRECTORY + ERROR_CURRENT_DIRECTORY + + + + No documentation. + + + ERROR_NOT_SAME_DEVICE + ERROR_NOT_SAME_DEVICE + + + + No documentation. + + + ERROR_NO_MORE_FILES + ERROR_NO_MORE_FILES + + + + No documentation. + + + ERROR_WRITE_PROTECT + ERROR_WRITE_PROTECT + + + + No documentation. + + + ERROR_BAD_UNIT + ERROR_BAD_UNIT + + + + No documentation. + + + ERROR_NOT_READY + ERROR_NOT_READY + + + + No documentation. + + + ERROR_BAD_COMMAND + ERROR_BAD_COMMAND + + + + No documentation. + + + ERROR_CRC + ERROR_CRC + + + + No documentation. + + + ERROR_BAD_LENGTH + ERROR_BAD_LENGTH + + + + No documentation. + + + ERROR_SEEK + ERROR_SEEK + + + + No documentation. + + + ERROR_NOT_DOS_DISK + ERROR_NOT_DOS_DISK + + + + No documentation. + + + ERROR_SECTOR_NOT_FOUND + ERROR_SECTOR_NOT_FOUND + + + + No documentation. + + + ERROR_OUT_OF_PAPER + ERROR_OUT_OF_PAPER + + + + No documentation. + + + ERROR_WRITE_FAULT + ERROR_WRITE_FAULT + + + + No documentation. + + + ERROR_READ_FAULT + ERROR_READ_FAULT + + + + No documentation. + + + ERROR_GEN_FAILURE + ERROR_GEN_FAILURE + + + + No documentation. + + + ERROR_SHARING_VIOLATION + ERROR_SHARING_VIOLATION + + + + No documentation. + + + ERROR_LOCK_VIOLATION + ERROR_LOCK_VIOLATION + + + + No documentation. + + + ERROR_WRONG_DISK + ERROR_WRONG_DISK + + + + No documentation. + + + ERROR_SHARING_BUFFER_EXCEEDED + ERROR_SHARING_BUFFER_EXCEEDED + + + + No documentation. + + + ERROR_HANDLE_EOF + ERROR_HANDLE_EOF + + + + No documentation. + + + ERROR_HANDLE_DISK_FULL + ERROR_HANDLE_DISK_FULL + + + + No documentation. + + + ERROR_NOT_SUPPORTED + ERROR_NOT_SUPPORTED + + + + No documentation. + + + ERROR_REM_NOT_LIST + ERROR_REM_NOT_LIST + + + + No documentation. + + + ERROR_DUP_NAME + ERROR_DUP_NAME + + + + No documentation. + + + ERROR_BAD_NETPATH + ERROR_BAD_NETPATH + + + + No documentation. + + + ERROR_NETWORK_BUSY + ERROR_NETWORK_BUSY + + + + No documentation. + + + ERROR_DEV_NOT_EXIST + ERROR_DEV_NOT_EXIST + + + + No documentation. + + + ERROR_TOO_MANY_CMDS + ERROR_TOO_MANY_CMDS + + + + No documentation. + + + ERROR_ADAP_HDW_ERR + ERROR_ADAP_HDW_ERR + + + + No documentation. + + + ERROR_BAD_NET_RESP + ERROR_BAD_NET_RESP + + + + No documentation. + + + ERROR_UNEXP_NET_ERR + ERROR_UNEXP_NET_ERR + + + + No documentation. + + + ERROR_BAD_REM_ADAP + ERROR_BAD_REM_ADAP + + + + No documentation. + + + ERROR_PRINTQ_FULL + ERROR_PRINTQ_FULL + + + + No documentation. + + + ERROR_NO_SPOOL_SPACE + ERROR_NO_SPOOL_SPACE + + + + No documentation. + + + ERROR_PRINT_CANCELLED + ERROR_PRINT_CANCELLED + + + + No documentation. + + + ERROR_NETNAME_DELETED + ERROR_NETNAME_DELETED + + + + No documentation. + + + ERROR_NETWORK_ACCESS_DENIED + ERROR_NETWORK_ACCESS_DENIED + + + + No documentation. + + + ERROR_BAD_DEV_TYPE + ERROR_BAD_DEV_TYPE + + + + No documentation. + + + ERROR_BAD_NET_NAME + ERROR_BAD_NET_NAME + + + + No documentation. + + + ERROR_TOO_MANY_NAMES + ERROR_TOO_MANY_NAMES + + + + No documentation. + + + ERROR_TOO_MANY_SESS + ERROR_TOO_MANY_SESS + + + + No documentation. + + + ERROR_SHARING_PAUSED + ERROR_SHARING_PAUSED + + + + No documentation. + + + ERROR_REQ_NOT_ACCEP + ERROR_REQ_NOT_ACCEP + + + + No documentation. + + + ERROR_REDIR_PAUSED + ERROR_REDIR_PAUSED + + + + No documentation. + + + ERROR_FILE_EXISTS + ERROR_FILE_EXISTS + + + + No documentation. + + + ERROR_CANNOT_MAKE + ERROR_CANNOT_MAKE + + + + No documentation. + + + ERROR_FAIL_I24 + ERROR_FAIL_I24 + + + + No documentation. + + + ERROR_OUT_OF_STRUCTURES + ERROR_OUT_OF_STRUCTURES + + + + No documentation. + + + ERROR_ALREADY_ASSIGNED + ERROR_ALREADY_ASSIGNED + + + + No documentation. + + + ERROR_INVALID_PASSWORD + ERROR_INVALID_PASSWORD + + + + No documentation. + + + ERROR_INVALID_PARAMETER + ERROR_INVALID_PARAMETER + + + + No documentation. + + + ERROR_NET_WRITE_FAULT + ERROR_NET_WRITE_FAULT + + + + No documentation. + + + ERROR_NO_PROC_SLOTS + ERROR_NO_PROC_SLOTS + + + + No documentation. + + + ERROR_TOO_MANY_SEMAPHORES + ERROR_TOO_MANY_SEMAPHORES + + + + No documentation. + + + ERROR_EXCL_SEM_ALREADY_OWNED + ERROR_EXCL_SEM_ALREADY_OWNED + + + + No documentation. + + + ERROR_SEM_IS_SET + ERROR_SEM_IS_SET + + + + No documentation. + + + ERROR_TOO_MANY_SEM_REQUESTS + ERROR_TOO_MANY_SEM_REQUESTS + + + + No documentation. + + + ERROR_INVALID_AT_INTERRUPT_TIME + ERROR_INVALID_AT_INTERRUPT_TIME + + + + No documentation. + + + ERROR_SEM_OWNER_DIED + ERROR_SEM_OWNER_DIED + + + + No documentation. + + + ERROR_SEM_USER_LIMIT + ERROR_SEM_USER_LIMIT + + + + No documentation. + + + ERROR_DISK_CHANGE + ERROR_DISK_CHANGE + + + + No documentation. + + + ERROR_DRIVE_LOCKED + ERROR_DRIVE_LOCKED + + + + No documentation. + + + ERROR_BROKEN_PIPE + ERROR_BROKEN_PIPE + + + + No documentation. + + + ERROR_OPEN_FAILED + ERROR_OPEN_FAILED + + + + No documentation. + + + ERROR_BUFFER_OVERFLOW + ERROR_BUFFER_OVERFLOW + + + + No documentation. + + + ERROR_DISK_FULL + ERROR_DISK_FULL + + + + No documentation. + + + ERROR_NO_MORE_SEARCH_HANDLES + ERROR_NO_MORE_SEARCH_HANDLES + + + + No documentation. + + + ERROR_INVALID_TARGET_HANDLE + ERROR_INVALID_TARGET_HANDLE + + + + No documentation. + + + ERROR_INVALID_CATEGORY + ERROR_INVALID_CATEGORY + + + + No documentation. + + + ERROR_INVALID_VERIFY_SWITCH + ERROR_INVALID_VERIFY_SWITCH + + + + No documentation. + + + ERROR_BAD_DRIVER_LEVEL + ERROR_BAD_DRIVER_LEVEL + + + + No documentation. + + + ERROR_CALL_NOT_IMPLEMENTED + ERROR_CALL_NOT_IMPLEMENTED + + + + No documentation. + + + ERROR_SEM_TIMEOUT + ERROR_SEM_TIMEOUT + + + + No documentation. + + + ERROR_INSUFFICIENT_BUFFER + ERROR_INSUFFICIENT_BUFFER + + + + No documentation. + + + ERROR_INVALID_NAME + ERROR_INVALID_NAME + + + + No documentation. + + + ERROR_INVALID_LEVEL + ERROR_INVALID_LEVEL + + + + No documentation. + + + ERROR_NO_VOLUME_LABEL + ERROR_NO_VOLUME_LABEL + + + + No documentation. + + + ERROR_MOD_NOT_FOUND + ERROR_MOD_NOT_FOUND + + + + No documentation. + + + ERROR_PROC_NOT_FOUND + ERROR_PROC_NOT_FOUND + + + + No documentation. + + + ERROR_WAIT_NO_CHILDREN + ERROR_WAIT_NO_CHILDREN + + + + No documentation. + + + ERROR_CHILD_NOT_COMPLETE + ERROR_CHILD_NOT_COMPLETE + + + + No documentation. + + + ERROR_DIRECT_ACCESS_HANDLE + ERROR_DIRECT_ACCESS_HANDLE + + + + No documentation. + + + ERROR_NEGATIVE_SEEK + ERROR_NEGATIVE_SEEK + + + + No documentation. + + + ERROR_SEEK_ON_DEVICE + ERROR_SEEK_ON_DEVICE + + + + No documentation. + + + ERROR_IS_JOIN_TARGET + ERROR_IS_JOIN_TARGET + + + + No documentation. + + + ERROR_IS_JOINED + ERROR_IS_JOINED + + + + No documentation. + + + ERROR_IS_SUBSTED + ERROR_IS_SUBSTED + + + + No documentation. + + + ERROR_NOT_JOINED + ERROR_NOT_JOINED + + + + No documentation. + + + ERROR_NOT_SUBSTED + ERROR_NOT_SUBSTED + + + + No documentation. + + + ERROR_JOIN_TO_JOIN + ERROR_JOIN_TO_JOIN + + + + No documentation. + + + ERROR_SUBST_TO_SUBST + ERROR_SUBST_TO_SUBST + + + + No documentation. + + + ERROR_JOIN_TO_SUBST + ERROR_JOIN_TO_SUBST + + + + No documentation. + + + ERROR_SUBST_TO_JOIN + ERROR_SUBST_TO_JOIN + + + + No documentation. + + + ERROR_BUSY_DRIVE + ERROR_BUSY_DRIVE + + + + No documentation. + + + ERROR_SAME_DRIVE + ERROR_SAME_DRIVE + + + + No documentation. + + + ERROR_DIR_NOT_ROOT + ERROR_DIR_NOT_ROOT + + + + No documentation. + + + ERROR_DIR_NOT_EMPTY + ERROR_DIR_NOT_EMPTY + + + + No documentation. + + + ERROR_IS_SUBST_PATH + ERROR_IS_SUBST_PATH + + + + No documentation. + + + ERROR_IS_JOIN_PATH + ERROR_IS_JOIN_PATH + + + + No documentation. + + + ERROR_PATH_BUSY + ERROR_PATH_BUSY + + + + No documentation. + + + ERROR_IS_SUBST_TARGET + ERROR_IS_SUBST_TARGET + + + + No documentation. + + + ERROR_SYSTEM_TRACE + ERROR_SYSTEM_TRACE + + + + No documentation. + + + ERROR_INVALID_EVENT_COUNT + ERROR_INVALID_EVENT_COUNT + + + + No documentation. + + + ERROR_TOO_MANY_MUXWAITERS + ERROR_TOO_MANY_MUXWAITERS + + + + No documentation. + + + ERROR_INVALID_LIST_FORMAT + ERROR_INVALID_LIST_FORMAT + + + + No documentation. + + + ERROR_LABEL_TOO_LONG + ERROR_LABEL_TOO_LONG + + + + No documentation. + + + ERROR_TOO_MANY_TCBS + ERROR_TOO_MANY_TCBS + + + + No documentation. + + + ERROR_SIGNAL_REFUSED + ERROR_SIGNAL_REFUSED + + + + No documentation. + + + ERROR_DISCARDED + ERROR_DISCARDED + + + + No documentation. + + + ERROR_NOT_LOCKED + ERROR_NOT_LOCKED + + + + No documentation. + + + ERROR_BAD_THREADID_ADDR + ERROR_BAD_THREADID_ADDR + + + + No documentation. + + + ERROR_BAD_ARGUMENTS + ERROR_BAD_ARGUMENTS + + + + No documentation. + + + ERROR_BAD_PATHNAME + ERROR_BAD_PATHNAME + + + + No documentation. + + + ERROR_SIGNAL_PENDING + ERROR_SIGNAL_PENDING + + + + No documentation. + + + ERROR_MAX_THRDS_REACHED + ERROR_MAX_THRDS_REACHED + + + + No documentation. + + + ERROR_LOCK_FAILED + ERROR_LOCK_FAILED + + + + No documentation. + + + ERROR_BUSY + ERROR_BUSY + + + + No documentation. + + + ERROR_CANCEL_VIOLATION + ERROR_CANCEL_VIOLATION + + + + No documentation. + + + ERROR_ATOMIC_LOCKS_NOT_SUPPORTED + ERROR_ATOMIC_LOCKS_NOT_SUPPORTED + + + + No documentation. + + + ERROR_INVALID_SEGMENT_NUMBER + ERROR_INVALID_SEGMENT_NUMBER + + + + No documentation. + + + ERROR_INVALID_ORDINAL + ERROR_INVALID_ORDINAL + + + + No documentation. + + + ERROR_ALREADY_EXISTS + ERROR_ALREADY_EXISTS + + + + No documentation. + + + ERROR_INVALID_FLAG_NUMBER + ERROR_INVALID_FLAG_NUMBER + + + + No documentation. + + + ERROR_SEM_NOT_FOUND + ERROR_SEM_NOT_FOUND + + + + No documentation. + + + ERROR_INVALID_STARTING_CODESEG + ERROR_INVALID_STARTING_CODESEG + + + + No documentation. + + + ERROR_INVALID_STACKSEG + ERROR_INVALID_STACKSEG + + + + No documentation. + + + ERROR_INVALID_MODULETYPE + ERROR_INVALID_MODULETYPE + + + + No documentation. + + + ERROR_INVALID_EXE_SIGNATURE + ERROR_INVALID_EXE_SIGNATURE + + + + No documentation. + + + ERROR_EXE_MARKED_INVALID + ERROR_EXE_MARKED_INVALID + + + + No documentation. + + + ERROR_BAD_EXE_FORMAT + ERROR_BAD_EXE_FORMAT + + + + No documentation. + + + ERROR_ITERATED_DATA_EXCEEDS_64k + ERROR_ITERATED_DATA_EXCEEDS_64k + + + + No documentation. + + + ERROR_INVALID_MINALLOCSIZE + ERROR_INVALID_MINALLOCSIZE + + + + No documentation. + + + ERROR_DYNLINK_FROM_INVALID_RING + ERROR_DYNLINK_FROM_INVALID_RING + + + + No documentation. + + + ERROR_IOPL_NOT_ENABLED + ERROR_IOPL_NOT_ENABLED + + + + No documentation. + + + ERROR_INVALID_SEGDPL + ERROR_INVALID_SEGDPL + + + + No documentation. + + + ERROR_AUTODATASEG_EXCEEDS_64k + ERROR_AUTODATASEG_EXCEEDS_64k + + + + No documentation. + + + ERROR_RING2SEG_MUST_BE_MOVABLE + ERROR_RING2SEG_MUST_BE_MOVABLE + + + + No documentation. + + + ERROR_RELOC_CHAIN_XEEDS_SEGLIM + ERROR_RELOC_CHAIN_XEEDS_SEGLIM + + + + No documentation. + + + ERROR_INFLOOP_IN_RELOC_CHAIN + ERROR_INFLOOP_IN_RELOC_CHAIN + + + + No documentation. + + + ERROR_ENVVAR_NOT_FOUND + ERROR_ENVVAR_NOT_FOUND + + + + No documentation. + + + ERROR_NO_SIGNAL_SENT + ERROR_NO_SIGNAL_SENT + + + + No documentation. + + + ERROR_FILENAME_EXCED_RANGE + ERROR_FILENAME_EXCED_RANGE + + + + No documentation. + + + ERROR_RING2_STACK_IN_USE + ERROR_RING2_STACK_IN_USE + + + + No documentation. + + + ERROR_META_EXPANSION_TOO_LONG + ERROR_META_EXPANSION_TOO_LONG + + + + No documentation. + + + ERROR_INVALID_SIGNAL_NUMBER + ERROR_INVALID_SIGNAL_NUMBER + + + + No documentation. + + + ERROR_THREAD_1_INACTIVE + ERROR_THREAD_1_INACTIVE + + + + No documentation. + + + ERROR_LOCKED + ERROR_LOCKED + + + + No documentation. + + + ERROR_TOO_MANY_MODULES + ERROR_TOO_MANY_MODULES + + + + No documentation. + + + ERROR_NESTING_NOT_ALLOWED + ERROR_NESTING_NOT_ALLOWED + + + + No documentation. + + + ERROR_EXE_MACHINE_TYPE_MISMATCH + ERROR_EXE_MACHINE_TYPE_MISMATCH + + + + No documentation. + + + ERROR_EXE_CANNOT_MODIFY_SIGNED_BINARY + ERROR_EXE_CANNOT_MODIFY_SIGNED_BINARY + + + + No documentation. + + + ERROR_EXE_CANNOT_MODIFY_STRONG_SIGNED_BINARY + ERROR_EXE_CANNOT_MODIFY_STRONG_SIGNED_BINARY + + + + No documentation. + + + ERROR_FILE_CHECKED_OUT + ERROR_FILE_CHECKED_OUT + + + + No documentation. + + + ERROR_CHECKOUT_REQUIRED + ERROR_CHECKOUT_REQUIRED + + + + No documentation. + + + ERROR_BAD_FILE_TYPE + ERROR_BAD_FILE_TYPE + + + + No documentation. + + + ERROR_FILE_TOO_LARGE + ERROR_FILE_TOO_LARGE + + + + No documentation. + + + ERROR_FORMS_AUTH_REQUIRED + ERROR_FORMS_AUTH_REQUIRED + + + + No documentation. + + + ERROR_VIRUS_INFECTED + ERROR_VIRUS_INFECTED + + + + No documentation. + + + ERROR_VIRUS_DELETED + ERROR_VIRUS_DELETED + + + + No documentation. + + + ERROR_PIPE_LOCAL + ERROR_PIPE_LOCAL + + + + No documentation. + + + ERROR_BAD_PIPE + ERROR_BAD_PIPE + + + + No documentation. + + + ERROR_PIPE_BUSY + ERROR_PIPE_BUSY + + + + No documentation. + + + ERROR_NO_DATA + ERROR_NO_DATA + + + + No documentation. + + + ERROR_PIPE_NOT_CONNECTED + ERROR_PIPE_NOT_CONNECTED + + + + No documentation. + + + ERROR_MORE_DATA + ERROR_MORE_DATA + + + + No documentation. + + + ERROR_VC_DISCONNECTED + ERROR_VC_DISCONNECTED + + + + No documentation. + + + ERROR_INVALID_EA_NAME + ERROR_INVALID_EA_NAME + + + + No documentation. + + + ERROR_EA_LIST_INCONSISTENT + ERROR_EA_LIST_INCONSISTENT + + + + No documentation. + + + ERROR_NO_MORE_ITEMS + ERROR_NO_MORE_ITEMS + + + + No documentation. + + + ERROR_CANNOT_COPY + ERROR_CANNOT_COPY + + + + No documentation. + + + ERROR_DIRECTORY + ERROR_DIRECTORY + + + + No documentation. + + + ERROR_EAS_DIDNT_FIT + ERROR_EAS_DIDNT_FIT + + + + No documentation. + + + ERROR_EA_FILE_CORRUPT + ERROR_EA_FILE_CORRUPT + + + + No documentation. + + + ERROR_EA_TABLE_FULL + ERROR_EA_TABLE_FULL + + + + No documentation. + + + ERROR_INVALID_EA_HANDLE + ERROR_INVALID_EA_HANDLE + + + + No documentation. + + + ERROR_EAS_NOT_SUPPORTED + ERROR_EAS_NOT_SUPPORTED + + + + No documentation. + + + ERROR_NOT_OWNER + ERROR_NOT_OWNER + + + + No documentation. + + + ERROR_TOO_MANY_POSTS + ERROR_TOO_MANY_POSTS + + + + No documentation. + + + ERROR_PARTIAL_COPY + ERROR_PARTIAL_COPY + + + + No documentation. + + + ERROR_OPLOCK_NOT_GRANTED + ERROR_OPLOCK_NOT_GRANTED + + + + No documentation. + + + ERROR_INVALID_OPLOCK_PROTOCOL + ERROR_INVALID_OPLOCK_PROTOCOL + + + + No documentation. + + + ERROR_DISK_TOO_FRAGMENTED + ERROR_DISK_TOO_FRAGMENTED + + + + No documentation. + + + ERROR_DELETE_PENDING + ERROR_DELETE_PENDING + + + + No documentation. + + + ERROR_INCOMPATIBLE_WITH_GLOBAL_SHORT_NAME_REGISTRY_SETTING + ERROR_INCOMPATIBLE_WITH_GLOBAL_SHORT_NAME_REGISTRY_SETTING + + + + No documentation. + + + ERROR_SHORT_NAMES_NOT_ENABLED_ON_VOLUME + ERROR_SHORT_NAMES_NOT_ENABLED_ON_VOLUME + + + + No documentation. + + + ERROR_SECURITY_STREAM_IS_INCONSISTENT + ERROR_SECURITY_STREAM_IS_INCONSISTENT + + + + No documentation. + + + ERROR_INVALID_LOCK_RANGE + ERROR_INVALID_LOCK_RANGE + + + + No documentation. + + + ERROR_IMAGE_SUBSYSTEM_NOT_PRESENT + ERROR_IMAGE_SUBSYSTEM_NOT_PRESENT + + + + No documentation. + + + ERROR_NOTIFICATION_GUID_ALREADY_DEFINED + ERROR_NOTIFICATION_GUID_ALREADY_DEFINED + + + + No documentation. + + + ERROR_MR_MID_NOT_FOUND + ERROR_MR_MID_NOT_FOUND + + + + No documentation. + + + ERROR_SCOPE_NOT_FOUND + ERROR_SCOPE_NOT_FOUND + + + + No documentation. + + + ERROR_FAIL_NOACTION_REBOOT + ERROR_FAIL_NOACTION_REBOOT + + + + No documentation. + + + ERROR_FAIL_SHUTDOWN + ERROR_FAIL_SHUTDOWN + + + + No documentation. + + + ERROR_FAIL_RESTART + ERROR_FAIL_RESTART + + + + No documentation. + + + ERROR_MAX_SESSIONS_REACHED + ERROR_MAX_SESSIONS_REACHED + + + + No documentation. + + + ERROR_THREAD_MODE_ALREADY_BACKGROUND + ERROR_THREAD_MODE_ALREADY_BACKGROUND + + + + No documentation. + + + ERROR_THREAD_MODE_NOT_BACKGROUND + ERROR_THREAD_MODE_NOT_BACKGROUND + + + + No documentation. + + + ERROR_PROCESS_MODE_ALREADY_BACKGROUND + ERROR_PROCESS_MODE_ALREADY_BACKGROUND + + + + No documentation. + + + ERROR_PROCESS_MODE_NOT_BACKGROUND + ERROR_PROCESS_MODE_NOT_BACKGROUND + + + + No documentation. + + + ERROR_INVALID_ADDRESS + ERROR_INVALID_ADDRESS + + + + No documentation. + + + ERROR_USER_PROFILE_LOAD + ERROR_USER_PROFILE_LOAD + + + + No documentation. + + + ERROR_ARITHMETIC_OVERFLOW + ERROR_ARITHMETIC_OVERFLOW + + + + No documentation. + + + ERROR_PIPE_CONNECTED + ERROR_PIPE_CONNECTED + + + + No documentation. + + + ERROR_PIPE_LISTENING + ERROR_PIPE_LISTENING + + + + No documentation. + + + ERROR_VERIFIER_STOP + ERROR_VERIFIER_STOP + + + + No documentation. + + + ERROR_ABIOS_ERROR + ERROR_ABIOS_ERROR + + + + No documentation. + + + ERROR_WX86_WARNING + ERROR_WX86_WARNING + + + + No documentation. + + + ERROR_WX86_ERROR + ERROR_WX86_ERROR + + + + No documentation. + + + ERROR_TIMER_NOT_CANCELED + ERROR_TIMER_NOT_CANCELED + + + + No documentation. + + + ERROR_UNWIND + ERROR_UNWIND + + + + No documentation. + + + ERROR_BAD_STACK + ERROR_BAD_STACK + + + + No documentation. + + + ERROR_INVALID_UNWIND_TARGET + ERROR_INVALID_UNWIND_TARGET + + + + No documentation. + + + ERROR_INVALID_PORT_ATTRIBUTES + ERROR_INVALID_PORT_ATTRIBUTES + + + + No documentation. + + + ERROR_PORT_MESSAGE_TOO_LONG + ERROR_PORT_MESSAGE_TOO_LONG + + + + No documentation. + + + ERROR_INVALID_QUOTA_LOWER + ERROR_INVALID_QUOTA_LOWER + + + + No documentation. + + + ERROR_DEVICE_ALREADY_ATTACHED + ERROR_DEVICE_ALREADY_ATTACHED + + + + No documentation. + + + ERROR_INSTRUCTION_MISALIGNMENT + ERROR_INSTRUCTION_MISALIGNMENT + + + + No documentation. + + + ERROR_PROFILING_NOT_STARTED + ERROR_PROFILING_NOT_STARTED + + + + No documentation. + + + ERROR_PROFILING_NOT_STOPPED + ERROR_PROFILING_NOT_STOPPED + + + + No documentation. + + + ERROR_COULD_NOT_INTERPRET + ERROR_COULD_NOT_INTERPRET + + + + No documentation. + + + ERROR_PROFILING_AT_LIMIT + ERROR_PROFILING_AT_LIMIT + + + + No documentation. + + + ERROR_CANT_WAIT + ERROR_CANT_WAIT + + + + No documentation. + + + ERROR_CANT_TERMINATE_SELF + ERROR_CANT_TERMINATE_SELF + + + + No documentation. + + + ERROR_UNEXPECTED_MM_CREATE_ERR + ERROR_UNEXPECTED_MM_CREATE_ERR + + + + No documentation. + + + ERROR_UNEXPECTED_MM_MAP_ERROR + ERROR_UNEXPECTED_MM_MAP_ERROR + + + + No documentation. + + + ERROR_UNEXPECTED_MM_EXTEND_ERR + ERROR_UNEXPECTED_MM_EXTEND_ERR + + + + No documentation. + + + ERROR_BAD_FUNCTION_TABLE + ERROR_BAD_FUNCTION_TABLE + + + + No documentation. + + + ERROR_NO_GUID_TRANSLATION + ERROR_NO_GUID_TRANSLATION + + + + No documentation. + + + ERROR_INVALID_LDT_SIZE + ERROR_INVALID_LDT_SIZE + + + + No documentation. + + + ERROR_INVALID_LDT_OFFSET + ERROR_INVALID_LDT_OFFSET + + + + No documentation. + + + ERROR_INVALID_LDT_DESCRIPTOR + ERROR_INVALID_LDT_DESCRIPTOR + + + + No documentation. + + + ERROR_TOO_MANY_THREADS + ERROR_TOO_MANY_THREADS + + + + No documentation. + + + ERROR_THREAD_NOT_IN_PROCESS + ERROR_THREAD_NOT_IN_PROCESS + + + + No documentation. + + + ERROR_PAGEFILE_QUOTA_EXCEEDED + ERROR_PAGEFILE_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_LOGON_SERVER_CONFLICT + ERROR_LOGON_SERVER_CONFLICT + + + + No documentation. + + + ERROR_SYNCHRONIZATION_REQUIRED + ERROR_SYNCHRONIZATION_REQUIRED + + + + No documentation. + + + ERROR_NET_OPEN_FAILED + ERROR_NET_OPEN_FAILED + + + + No documentation. + + + ERROR_IO_PRIVILEGE_FAILED + ERROR_IO_PRIVILEGE_FAILED + + + + No documentation. + + + ERROR_CONTROL_C_EXIT + ERROR_CONTROL_C_EXIT + + + + No documentation. + + + ERROR_MISSING_SYSTEMFILE + ERROR_MISSING_SYSTEMFILE + + + + No documentation. + + + ERROR_UNHANDLED_EXCEPTION + ERROR_UNHANDLED_EXCEPTION + + + + No documentation. + + + ERROR_APP_INIT_FAILURE + ERROR_APP_INIT_FAILURE + + + + No documentation. + + + ERROR_PAGEFILE_CREATE_FAILED + ERROR_PAGEFILE_CREATE_FAILED + + + + No documentation. + + + ERROR_INVALID_IMAGE_HASH + ERROR_INVALID_IMAGE_HASH + + + + No documentation. + + + ERROR_NO_PAGEFILE + ERROR_NO_PAGEFILE + + + + No documentation. + + + ERROR_ILLEGAL_FLOAT_CONTEXT + ERROR_ILLEGAL_FLOAT_CONTEXT + + + + No documentation. + + + ERROR_NO_EVENT_PAIR + ERROR_NO_EVENT_PAIR + + + + No documentation. + + + ERROR_DOMAIN_CTRLR_CONFIG_ERROR + ERROR_DOMAIN_CTRLR_CONFIG_ERROR + + + + No documentation. + + + ERROR_ILLEGAL_CHARACTER + ERROR_ILLEGAL_CHARACTER + + + + No documentation. + + + ERROR_UNDEFINED_CHARACTER + ERROR_UNDEFINED_CHARACTER + + + + No documentation. + + + ERROR_FLOPPY_VOLUME + ERROR_FLOPPY_VOLUME + + + + No documentation. + + + ERROR_BIOS_FAILED_TO_CONNECT_INTERRUPT + ERROR_BIOS_FAILED_TO_CONNECT_INTERRUPT + + + + No documentation. + + + ERROR_BACKUP_CONTROLLER + ERROR_BACKUP_CONTROLLER + + + + No documentation. + + + ERROR_MUTANT_LIMIT_EXCEEDED + ERROR_MUTANT_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_FS_DRIVER_REQUIRED + ERROR_FS_DRIVER_REQUIRED + + + + No documentation. + + + ERROR_CANNOT_LOAD_REGISTRY_FILE + ERROR_CANNOT_LOAD_REGISTRY_FILE + + + + No documentation. + + + ERROR_DEBUG_ATTACH_FAILED + ERROR_DEBUG_ATTACH_FAILED + + + + No documentation. + + + ERROR_SYSTEM_PROCESS_TERMINATED + ERROR_SYSTEM_PROCESS_TERMINATED + + + + No documentation. + + + ERROR_DATA_NOT_ACCEPTED + ERROR_DATA_NOT_ACCEPTED + + + + No documentation. + + + ERROR_VDM_HARD_ERROR + ERROR_VDM_HARD_ERROR + + + + No documentation. + + + ERROR_DRIVER_CANCEL_TIMEOUT + ERROR_DRIVER_CANCEL_TIMEOUT + + + + No documentation. + + + ERROR_REPLY_MESSAGE_MISMATCH + ERROR_REPLY_MESSAGE_MISMATCH + + + + No documentation. + + + ERROR_LOST_WRITEBEHIND_DATA + ERROR_LOST_WRITEBEHIND_DATA + + + + No documentation. + + + ERROR_CLIENT_SERVER_PARAMETERS_INVALID + ERROR_CLIENT_SERVER_PARAMETERS_INVALID + + + + No documentation. + + + ERROR_NOT_TINY_STREAM + ERROR_NOT_TINY_STREAM + + + + No documentation. + + + ERROR_STACK_OVERFLOW_READ + ERROR_STACK_OVERFLOW_READ + + + + No documentation. + + + ERROR_CONVERT_TO_LARGE + ERROR_CONVERT_TO_LARGE + + + + No documentation. + + + ERROR_FOUND_OUT_OF_SCOPE + ERROR_FOUND_OUT_OF_SCOPE + + + + No documentation. + + + ERROR_ALLOCATE_BUCKET + ERROR_ALLOCATE_BUCKET + + + + No documentation. + + + ERROR_MARSHALL_OVERFLOW + ERROR_MARSHALL_OVERFLOW + + + + No documentation. + + + ERROR_INVALID_VARIANT + ERROR_INVALID_VARIANT + + + + No documentation. + + + ERROR_BAD_COMPRESSION_BUFFER + ERROR_BAD_COMPRESSION_BUFFER + + + + No documentation. + + + ERROR_AUDIT_FAILED + ERROR_AUDIT_FAILED + + + + No documentation. + + + ERROR_TIMER_RESOLUTION_NOT_SET + ERROR_TIMER_RESOLUTION_NOT_SET + + + + No documentation. + + + ERROR_INSUFFICIENT_LOGON_INFO + ERROR_INSUFFICIENT_LOGON_INFO + + + + No documentation. + + + ERROR_BAD_DLL_ENTRYPOINT + ERROR_BAD_DLL_ENTRYPOINT + + + + No documentation. + + + ERROR_BAD_SERVICE_ENTRYPOINT + ERROR_BAD_SERVICE_ENTRYPOINT + + + + No documentation. + + + ERROR_IP_ADDRESS_CONFLICT1 + ERROR_IP_ADDRESS_CONFLICT1 + + + + No documentation. + + + ERROR_IP_ADDRESS_CONFLICT2 + ERROR_IP_ADDRESS_CONFLICT2 + + + + No documentation. + + + ERROR_REGISTRY_QUOTA_LIMIT + ERROR_REGISTRY_QUOTA_LIMIT + + + + No documentation. + + + ERROR_NO_CALLBACK_ACTIVE + ERROR_NO_CALLBACK_ACTIVE + + + + No documentation. + + + ERROR_PWD_TOO_SHORT + ERROR_PWD_TOO_SHORT + + + + No documentation. + + + ERROR_PWD_TOO_RECENT + ERROR_PWD_TOO_RECENT + + + + No documentation. + + + ERROR_PWD_HISTORY_CONFLICT + ERROR_PWD_HISTORY_CONFLICT + + + + No documentation. + + + ERROR_UNSUPPORTED_COMPRESSION + ERROR_UNSUPPORTED_COMPRESSION + + + + No documentation. + + + ERROR_INVALID_HW_PROFILE + ERROR_INVALID_HW_PROFILE + + + + No documentation. + + + ERROR_INVALID_PLUGPLAY_DEVICE_PATH + ERROR_INVALID_PLUGPLAY_DEVICE_PATH + + + + No documentation. + + + ERROR_QUOTA_LIST_INCONSISTENT + ERROR_QUOTA_LIST_INCONSISTENT + + + + No documentation. + + + ERROR_EVALUATION_EXPIRATION + ERROR_EVALUATION_EXPIRATION + + + + No documentation. + + + ERROR_ILLEGAL_DLL_RELOCATION + ERROR_ILLEGAL_DLL_RELOCATION + + + + No documentation. + + + ERROR_DLL_INIT_FAILED_LOGOFF + ERROR_DLL_INIT_FAILED_LOGOFF + + + + No documentation. + + + ERROR_VALIDATE_CONTINUE + ERROR_VALIDATE_CONTINUE + + + + No documentation. + + + ERROR_NO_MORE_MATCHES + ERROR_NO_MORE_MATCHES + + + + No documentation. + + + ERROR_RANGE_LIST_CONFLICT + ERROR_RANGE_LIST_CONFLICT + + + + No documentation. + + + ERROR_SERVER_SID_MISMATCH + ERROR_SERVER_SID_MISMATCH + + + + No documentation. + + + ERROR_CANT_ENABLE_DENY_ONLY + ERROR_CANT_ENABLE_DENY_ONLY + + + + No documentation. + + + ERROR_FLOAT_MULTIPLE_FAULTS + ERROR_FLOAT_MULTIPLE_FAULTS + + + + No documentation. + + + ERROR_FLOAT_MULTIPLE_TRAPS + ERROR_FLOAT_MULTIPLE_TRAPS + + + + No documentation. + + + ERROR_NOINTERFACE + ERROR_NOINTERFACE + + + + No documentation. + + + ERROR_DRIVER_FAILED_SLEEP + ERROR_DRIVER_FAILED_SLEEP + + + + No documentation. + + + ERROR_CORRUPT_SYSTEM_FILE + ERROR_CORRUPT_SYSTEM_FILE + + + + No documentation. + + + ERROR_COMMITMENT_MINIMUM + ERROR_COMMITMENT_MINIMUM + + + + No documentation. + + + ERROR_PNP_RESTART_ENUMERATION + ERROR_PNP_RESTART_ENUMERATION + + + + No documentation. + + + ERROR_SYSTEM_IMAGE_BAD_SIGNATURE + ERROR_SYSTEM_IMAGE_BAD_SIGNATURE + + + + No documentation. + + + ERROR_PNP_REBOOT_REQUIRED + ERROR_PNP_REBOOT_REQUIRED + + + + No documentation. + + + ERROR_INSUFFICIENT_POWER + ERROR_INSUFFICIENT_POWER + + + + No documentation. + + + ERROR_MULTIPLE_FAULT_VIOLATION + ERROR_MULTIPLE_FAULT_VIOLATION + + + + No documentation. + + + ERROR_SYSTEM_SHUTDOWN + ERROR_SYSTEM_SHUTDOWN + + + + No documentation. + + + ERROR_PORT_NOT_SET + ERROR_PORT_NOT_SET + + + + No documentation. + + + ERROR_DS_VERSION_CHECK_FAILURE + ERROR_DS_VERSION_CHECK_FAILURE + + + + No documentation. + + + ERROR_RANGE_NOT_FOUND + ERROR_RANGE_NOT_FOUND + + + + No documentation. + + + ERROR_NOT_SAFE_MODE_DRIVER + ERROR_NOT_SAFE_MODE_DRIVER + + + + No documentation. + + + ERROR_FAILED_DRIVER_ENTRY + ERROR_FAILED_DRIVER_ENTRY + + + + No documentation. + + + ERROR_DEVICE_ENUMERATION_ERROR + ERROR_DEVICE_ENUMERATION_ERROR + + + + No documentation. + + + ERROR_MOUNT_POINT_NOT_RESOLVED + ERROR_MOUNT_POINT_NOT_RESOLVED + + + + No documentation. + + + ERROR_INVALID_DEVICE_OBJECT_PARAMETER + ERROR_INVALID_DEVICE_OBJECT_PARAMETER + + + + No documentation. + + + ERROR_MCA_OCCURED + ERROR_MCA_OCCURED + + + + No documentation. + + + ERROR_DRIVER_DATABASE_ERROR + ERROR_DRIVER_DATABASE_ERROR + + + + No documentation. + + + ERROR_SYSTEM_HIVE_TOO_LARGE + ERROR_SYSTEM_HIVE_TOO_LARGE + + + + No documentation. + + + ERROR_DRIVER_FAILED_PRIOR_UNLOAD + ERROR_DRIVER_FAILED_PRIOR_UNLOAD + + + + No documentation. + + + ERROR_VOLSNAP_PREPARE_HIBERNATE + ERROR_VOLSNAP_PREPARE_HIBERNATE + + + + No documentation. + + + ERROR_HIBERNATION_FAILURE + ERROR_HIBERNATION_FAILURE + + + + No documentation. + + + ERROR_FILE_SYSTEM_LIMITATION + ERROR_FILE_SYSTEM_LIMITATION + + + + No documentation. + + + ERROR_ASSERTION_FAILURE + ERROR_ASSERTION_FAILURE + + + + No documentation. + + + ERROR_ACPI_ERROR + ERROR_ACPI_ERROR + + + + No documentation. + + + ERROR_WOW_ASSERTION + ERROR_WOW_ASSERTION + + + + No documentation. + + + ERROR_PNP_BAD_MPS_TABLE + ERROR_PNP_BAD_MPS_TABLE + + + + No documentation. + + + ERROR_PNP_TRANSLATION_FAILED + ERROR_PNP_TRANSLATION_FAILED + + + + No documentation. + + + ERROR_PNP_IRQ_TRANSLATION_FAILED + ERROR_PNP_IRQ_TRANSLATION_FAILED + + + + No documentation. + + + ERROR_PNP_INVALID_ID + ERROR_PNP_INVALID_ID + + + + No documentation. + + + ERROR_WAKE_SYSTEM_DEBUGGER + ERROR_WAKE_SYSTEM_DEBUGGER + + + + No documentation. + + + ERROR_HANDLES_CLOSED + ERROR_HANDLES_CLOSED + + + + No documentation. + + + ERROR_EXTRANEOUS_INFORMATION + ERROR_EXTRANEOUS_INFORMATION + + + + No documentation. + + + ERROR_RXACT_COMMIT_NECESSARY + ERROR_RXACT_COMMIT_NECESSARY + + + + No documentation. + + + ERROR_MEDIA_CHECK + ERROR_MEDIA_CHECK + + + + No documentation. + + + ERROR_GUID_SUBSTITUTION_MADE + ERROR_GUID_SUBSTITUTION_MADE + + + + No documentation. + + + ERROR_STOPPED_ON_SYMLINK + ERROR_STOPPED_ON_SYMLINK + + + + No documentation. + + + ERROR_LONGJUMP + ERROR_LONGJUMP + + + + No documentation. + + + ERROR_PLUGPLAY_QUERY_VETOED + ERROR_PLUGPLAY_QUERY_VETOED + + + + No documentation. + + + ERROR_UNWIND_CONSOLIDATE + ERROR_UNWIND_CONSOLIDATE + + + + No documentation. + + + ERROR_REGISTRY_HIVE_RECOVERED + ERROR_REGISTRY_HIVE_RECOVERED + + + + No documentation. + + + ERROR_DLL_MIGHT_BE_INSECURE + ERROR_DLL_MIGHT_BE_INSECURE + + + + No documentation. + + + ERROR_DLL_MIGHT_BE_INCOMPATIBLE + ERROR_DLL_MIGHT_BE_INCOMPATIBLE + + + + No documentation. + + + ERROR_DBG_EXCEPTION_NOT_HANDLED + ERROR_DBG_EXCEPTION_NOT_HANDLED + + + + No documentation. + + + ERROR_DBG_REPLY_LATER + ERROR_DBG_REPLY_LATER + + + + No documentation. + + + ERROR_DBG_UNABLE_TO_PROVIDE_HANDLE + ERROR_DBG_UNABLE_TO_PROVIDE_HANDLE + + + + No documentation. + + + ERROR_DBG_TERMINATE_THREAD + ERROR_DBG_TERMINATE_THREAD + + + + No documentation. + + + ERROR_DBG_TERMINATE_PROCESS + ERROR_DBG_TERMINATE_PROCESS + + + + No documentation. + + + ERROR_DBG_CONTROL_C + ERROR_DBG_CONTROL_C + + + + No documentation. + + + ERROR_DBG_PRINTEXCEPTION_C + ERROR_DBG_PRINTEXCEPTION_C + + + + No documentation. + + + ERROR_DBG_RIPEXCEPTION + ERROR_DBG_RIPEXCEPTION + + + + No documentation. + + + ERROR_DBG_CONTROL_BREAK + ERROR_DBG_CONTROL_BREAK + + + + No documentation. + + + ERROR_DBG_COMMAND_EXCEPTION + ERROR_DBG_COMMAND_EXCEPTION + + + + No documentation. + + + ERROR_OBJECT_NAME_EXISTS + ERROR_OBJECT_NAME_EXISTS + + + + No documentation. + + + ERROR_THREAD_WAS_SUSPENDED + ERROR_THREAD_WAS_SUSPENDED + + + + No documentation. + + + ERROR_IMAGE_NOT_AT_BASE + ERROR_IMAGE_NOT_AT_BASE + + + + No documentation. + + + ERROR_RXACT_STATE_CREATED + ERROR_RXACT_STATE_CREATED + + + + No documentation. + + + ERROR_SEGMENT_NOTIFICATION + ERROR_SEGMENT_NOTIFICATION + + + + No documentation. + + + ERROR_BAD_CURRENT_DIRECTORY + ERROR_BAD_CURRENT_DIRECTORY + + + + No documentation. + + + ERROR_FT_READ_RECOVERY_FROM_BACKUP + ERROR_FT_READ_RECOVERY_FROM_BACKUP + + + + No documentation. + + + ERROR_FT_WRITE_RECOVERY + ERROR_FT_WRITE_RECOVERY + + + + No documentation. + + + ERROR_IMAGE_MACHINE_TYPE_MISMATCH + ERROR_IMAGE_MACHINE_TYPE_MISMATCH + + + + No documentation. + + + ERROR_RECEIVE_PARTIAL + ERROR_RECEIVE_PARTIAL + + + + No documentation. + + + ERROR_RECEIVE_EXPEDITED + ERROR_RECEIVE_EXPEDITED + + + + No documentation. + + + ERROR_RECEIVE_PARTIAL_EXPEDITED + ERROR_RECEIVE_PARTIAL_EXPEDITED + + + + No documentation. + + + ERROR_EVENT_DONE + ERROR_EVENT_DONE + + + + No documentation. + + + ERROR_EVENT_PENDING + ERROR_EVENT_PENDING + + + + No documentation. + + + ERROR_CHECKING_FILE_SYSTEM + ERROR_CHECKING_FILE_SYSTEM + + + + No documentation. + + + ERROR_FATAL_APP_EXIT + ERROR_FATAL_APP_EXIT + + + + No documentation. + + + ERROR_PREDEFINED_HANDLE + ERROR_PREDEFINED_HANDLE + + + + No documentation. + + + ERROR_WAS_UNLOCKED + ERROR_WAS_UNLOCKED + + + + No documentation. + + + ERROR_SERVICE_NOTIFICATION + ERROR_SERVICE_NOTIFICATION + + + + No documentation. + + + ERROR_WAS_LOCKED + ERROR_WAS_LOCKED + + + + No documentation. + + + ERROR_LOG_HARD_ERROR + ERROR_LOG_HARD_ERROR + + + + No documentation. + + + ERROR_ALREADY_WIN32 + ERROR_ALREADY_WIN32 + + + + No documentation. + + + ERROR_IMAGE_MACHINE_TYPE_MISMATCH_EXE + ERROR_IMAGE_MACHINE_TYPE_MISMATCH_EXE + + + + No documentation. + + + ERROR_NO_YIELD_PERFORMED + ERROR_NO_YIELD_PERFORMED + + + + No documentation. + + + ERROR_TIMER_RESUME_IGNORED + ERROR_TIMER_RESUME_IGNORED + + + + No documentation. + + + ERROR_ARBITRATION_UNHANDLED + ERROR_ARBITRATION_UNHANDLED + + + + No documentation. + + + ERROR_CARDBUS_NOT_SUPPORTED + ERROR_CARDBUS_NOT_SUPPORTED + + + + No documentation. + + + ERROR_MP_PROCESSOR_MISMATCH + ERROR_MP_PROCESSOR_MISMATCH + + + + No documentation. + + + ERROR_HIBERNATED + ERROR_HIBERNATED + + + + No documentation. + + + ERROR_RESUME_HIBERNATION + ERROR_RESUME_HIBERNATION + + + + No documentation. + + + ERROR_FIRMWARE_UPDATED + ERROR_FIRMWARE_UPDATED + + + + No documentation. + + + ERROR_DRIVERS_LEAKING_LOCKED_PAGES + ERROR_DRIVERS_LEAKING_LOCKED_PAGES + + + + No documentation. + + + ERROR_WAKE_SYSTEM + ERROR_WAKE_SYSTEM + + + + No documentation. + + + ERROR_WAIT_1 + ERROR_WAIT_1 + + + + No documentation. + + + ERROR_WAIT_2 + ERROR_WAIT_2 + + + + No documentation. + + + ERROR_WAIT_3 + ERROR_WAIT_3 + + + + No documentation. + + + ERROR_WAIT_63 + ERROR_WAIT_63 + + + + No documentation. + + + ERROR_ABANDONED_WAIT_0 + ERROR_ABANDONED_WAIT_0 + + + + No documentation. + + + ERROR_ABANDONED_WAIT_63 + ERROR_ABANDONED_WAIT_63 + + + + No documentation. + + + ERROR_USER_APC + ERROR_USER_APC + + + + No documentation. + + + ERROR_KERNEL_APC + ERROR_KERNEL_APC + + + + No documentation. + + + ERROR_ALERTED + ERROR_ALERTED + + + + No documentation. + + + ERROR_ELEVATION_REQUIRED + ERROR_ELEVATION_REQUIRED + + + + No documentation. + + + ERROR_REPARSE + ERROR_REPARSE + + + + No documentation. + + + ERROR_OPLOCK_BREAK_IN_PROGRESS + ERROR_OPLOCK_BREAK_IN_PROGRESS + + + + No documentation. + + + ERROR_VOLUME_MOUNTED + ERROR_VOLUME_MOUNTED + + + + No documentation. + + + ERROR_RXACT_COMMITTED + ERROR_RXACT_COMMITTED + + + + No documentation. + + + ERROR_NOTIFY_CLEANUP + ERROR_NOTIFY_CLEANUP + + + + No documentation. + + + ERROR_PRIMARY_TRANSPORT_CONNECT_FAILED + ERROR_PRIMARY_TRANSPORT_CONNECT_FAILED + + + + No documentation. + + + ERROR_PAGE_FAULT_TRANSITION + ERROR_PAGE_FAULT_TRANSITION + + + + No documentation. + + + ERROR_PAGE_FAULT_DEMAND_ZERO + ERROR_PAGE_FAULT_DEMAND_ZERO + + + + No documentation. + + + ERROR_PAGE_FAULT_COPY_ON_WRITE + ERROR_PAGE_FAULT_COPY_ON_WRITE + + + + No documentation. + + + ERROR_PAGE_FAULT_GUARD_PAGE + ERROR_PAGE_FAULT_GUARD_PAGE + + + + No documentation. + + + ERROR_PAGE_FAULT_PAGING_FILE + ERROR_PAGE_FAULT_PAGING_FILE + + + + No documentation. + + + ERROR_CACHE_PAGE_LOCKED + ERROR_CACHE_PAGE_LOCKED + + + + No documentation. + + + ERROR_CRASH_DUMP + ERROR_CRASH_DUMP + + + + No documentation. + + + ERROR_BUFFER_ALL_ZEROS + ERROR_BUFFER_ALL_ZEROS + + + + No documentation. + + + ERROR_REPARSE_OBJECT + ERROR_REPARSE_OBJECT + + + + No documentation. + + + ERROR_RESOURCE_REQUIREMENTS_CHANGED + ERROR_RESOURCE_REQUIREMENTS_CHANGED + + + + No documentation. + + + ERROR_TRANSLATION_COMPLETE + ERROR_TRANSLATION_COMPLETE + + + + No documentation. + + + ERROR_NOTHING_TO_TERMINATE + ERROR_NOTHING_TO_TERMINATE + + + + No documentation. + + + ERROR_PROCESS_NOT_IN_JOB + ERROR_PROCESS_NOT_IN_JOB + + + + No documentation. + + + ERROR_PROCESS_IN_JOB + ERROR_PROCESS_IN_JOB + + + + No documentation. + + + ERROR_VOLSNAP_HIBERNATE_READY + ERROR_VOLSNAP_HIBERNATE_READY + + + + No documentation. + + + ERROR_FSFILTER_OP_COMPLETED_SUCCESSFULLY + ERROR_FSFILTER_OP_COMPLETED_SUCCESSFULLY + + + + No documentation. + + + ERROR_INTERRUPT_VECTOR_ALREADY_CONNECTED + ERROR_INTERRUPT_VECTOR_ALREADY_CONNECTED + + + + No documentation. + + + ERROR_INTERRUPT_STILL_CONNECTED + ERROR_INTERRUPT_STILL_CONNECTED + + + + No documentation. + + + ERROR_WAIT_FOR_OPLOCK + ERROR_WAIT_FOR_OPLOCK + + + + No documentation. + + + ERROR_DBG_EXCEPTION_HANDLED + ERROR_DBG_EXCEPTION_HANDLED + + + + No documentation. + + + ERROR_DBG_CONTINUE + ERROR_DBG_CONTINUE + + + + No documentation. + + + ERROR_CALLBACK_POP_STACK + ERROR_CALLBACK_POP_STACK + + + + No documentation. + + + ERROR_COMPRESSION_DISABLED + ERROR_COMPRESSION_DISABLED + + + + No documentation. + + + ERROR_CANTFETCHBACKWARDS + ERROR_CANTFETCHBACKWARDS + + + + No documentation. + + + ERROR_CANTSCROLLBACKWARDS + ERROR_CANTSCROLLBACKWARDS + + + + No documentation. + + + ERROR_ROWSNOTRELEASED + ERROR_ROWSNOTRELEASED + + + + No documentation. + + + ERROR_BAD_ACCESSOR_FLAGS + ERROR_BAD_ACCESSOR_FLAGS + + + + No documentation. + + + ERROR_ERRORS_ENCOUNTERED + ERROR_ERRORS_ENCOUNTERED + + + + No documentation. + + + ERROR_NOT_CAPABLE + ERROR_NOT_CAPABLE + + + + No documentation. + + + ERROR_REQUEST_OUT_OF_SEQUENCE + ERROR_REQUEST_OUT_OF_SEQUENCE + + + + No documentation. + + + ERROR_VERSION_PARSE_ERROR + ERROR_VERSION_PARSE_ERROR + + + + No documentation. + + + ERROR_BADSTARTPOSITION + ERROR_BADSTARTPOSITION + + + + No documentation. + + + ERROR_MEMORY_HARDWARE + ERROR_MEMORY_HARDWARE + + + + No documentation. + + + ERROR_DISK_REPAIR_DISABLED + ERROR_DISK_REPAIR_DISABLED + + + + No documentation. + + + ERROR_INSUFFICIENT_RESOURCE_FOR_SPECIFIED_SHARED_SECTION_SIZE + ERROR_INSUFFICIENT_RESOURCE_FOR_SPECIFIED_SHARED_SECTION_SIZE + + + + No documentation. + + + ERROR_SYSTEM_POWERSTATE_TRANSITION + ERROR_SYSTEM_POWERSTATE_TRANSITION + + + + No documentation. + + + ERROR_SYSTEM_POWERSTATE_COMPLEX_TRANSITION + ERROR_SYSTEM_POWERSTATE_COMPLEX_TRANSITION + + + + No documentation. + + + ERROR_MCA_EXCEPTION + ERROR_MCA_EXCEPTION + + + + No documentation. + + + ERROR_ACCESS_AUDIT_BY_POLICY + ERROR_ACCESS_AUDIT_BY_POLICY + + + + No documentation. + + + ERROR_ACCESS_DISABLED_NO_SAFER_UI_BY_POLICY + ERROR_ACCESS_DISABLED_NO_SAFER_UI_BY_POLICY + + + + No documentation. + + + ERROR_ABANDON_HIBERFILE + ERROR_ABANDON_HIBERFILE + + + + No documentation. + + + ERROR_LOST_WRITEBEHIND_DATA_NETWORK_DISCONNECTED + ERROR_LOST_WRITEBEHIND_DATA_NETWORK_DISCONNECTED + + + + No documentation. + + + ERROR_LOST_WRITEBEHIND_DATA_NETWORK_SERVER_ERROR + ERROR_LOST_WRITEBEHIND_DATA_NETWORK_SERVER_ERROR + + + + No documentation. + + + ERROR_LOST_WRITEBEHIND_DATA_LOCAL_DISK_ERROR + ERROR_LOST_WRITEBEHIND_DATA_LOCAL_DISK_ERROR + + + + No documentation. + + + ERROR_BAD_MCFG_TABLE + ERROR_BAD_MCFG_TABLE + + + + No documentation. + + + ERROR_OPLOCK_SWITCHED_TO_NEW_HANDLE + ERROR_OPLOCK_SWITCHED_TO_NEW_HANDLE + + + + No documentation. + + + ERROR_CANNOT_GRANT_REQUESTED_OPLOCK + ERROR_CANNOT_GRANT_REQUESTED_OPLOCK + + + + No documentation. + + + ERROR_CANNOT_BREAK_OPLOCK + ERROR_CANNOT_BREAK_OPLOCK + + + + No documentation. + + + ERROR_OPLOCK_HANDLE_CLOSED + ERROR_OPLOCK_HANDLE_CLOSED + + + + No documentation. + + + ERROR_NO_ACE_CONDITION + ERROR_NO_ACE_CONDITION + + + + No documentation. + + + ERROR_INVALID_ACE_CONDITION + ERROR_INVALID_ACE_CONDITION + + + + No documentation. + + + ERROR_EA_ACCESS_DENIED + ERROR_EA_ACCESS_DENIED + + + + No documentation. + + + ERROR_OPERATION_ABORTED + ERROR_OPERATION_ABORTED + + + + No documentation. + + + ERROR_IO_INCOMPLETE + ERROR_IO_INCOMPLETE + + + + No documentation. + + + ERROR_IO_PENDING + ERROR_IO_PENDING + + + + No documentation. + + + ERROR_NOACCESS + ERROR_NOACCESS + + + + No documentation. + + + ERROR_SWAPERROR + ERROR_SWAPERROR + + + + No documentation. + + + ERROR_STACK_OVERFLOW + ERROR_STACK_OVERFLOW + + + + No documentation. + + + ERROR_INVALID_MESSAGE + ERROR_INVALID_MESSAGE + + + + No documentation. + + + ERROR_CAN_NOT_COMPLETE + ERROR_CAN_NOT_COMPLETE + + + + No documentation. + + + ERROR_INVALID_FLAGS + ERROR_INVALID_FLAGS + + + + No documentation. + + + ERROR_UNRECOGNIZED_VOLUME + ERROR_UNRECOGNIZED_VOLUME + + + + No documentation. + + + ERROR_FILE_INVALID + ERROR_FILE_INVALID + + + + No documentation. + + + ERROR_FULLSCREEN_MODE + ERROR_FULLSCREEN_MODE + + + + No documentation. + + + ERROR_NO_TOKEN + ERROR_NO_TOKEN + + + + No documentation. + + + ERROR_BADDB + ERROR_BADDB + + + + No documentation. + + + ERROR_BADKEY + ERROR_BADKEY + + + + No documentation. + + + ERROR_CANTOPEN + ERROR_CANTOPEN + + + + No documentation. + + + ERROR_CANTREAD + ERROR_CANTREAD + + + + No documentation. + + + ERROR_CANTWRITE + ERROR_CANTWRITE + + + + No documentation. + + + ERROR_REGISTRY_RECOVERED + ERROR_REGISTRY_RECOVERED + + + + No documentation. + + + ERROR_REGISTRY_CORRUPT + ERROR_REGISTRY_CORRUPT + + + + No documentation. + + + ERROR_REGISTRY_IO_FAILED + ERROR_REGISTRY_IO_FAILED + + + + No documentation. + + + ERROR_NOT_REGISTRY_FILE + ERROR_NOT_REGISTRY_FILE + + + + No documentation. + + + ERROR_KEY_DELETED + ERROR_KEY_DELETED + + + + No documentation. + + + ERROR_NO_LOG_SPACE + ERROR_NO_LOG_SPACE + + + + No documentation. + + + ERROR_KEY_HAS_CHILDREN + ERROR_KEY_HAS_CHILDREN + + + + No documentation. + + + ERROR_CHILD_MUST_BE_VOLATILE + ERROR_CHILD_MUST_BE_VOLATILE + + + + No documentation. + + + ERROR_NOTIFY_ENUM_DIR + ERROR_NOTIFY_ENUM_DIR + + + + No documentation. + + + ERROR_DEPENDENT_SERVICES_RUNNING + ERROR_DEPENDENT_SERVICES_RUNNING + + + + No documentation. + + + ERROR_INVALID_SERVICE_CONTROL + ERROR_INVALID_SERVICE_CONTROL + + + + No documentation. + + + ERROR_SERVICE_REQUEST_TIMEOUT + ERROR_SERVICE_REQUEST_TIMEOUT + + + + No documentation. + + + ERROR_SERVICE_NO_THREAD + ERROR_SERVICE_NO_THREAD + + + + No documentation. + + + ERROR_SERVICE_DATABASE_LOCKED + ERROR_SERVICE_DATABASE_LOCKED + + + + No documentation. + + + ERROR_SERVICE_ALREADY_RUNNING + ERROR_SERVICE_ALREADY_RUNNING + + + + No documentation. + + + ERROR_INVALID_SERVICE_ACCOUNT + ERROR_INVALID_SERVICE_ACCOUNT + + + + No documentation. + + + ERROR_SERVICE_DISABLED + ERROR_SERVICE_DISABLED + + + + No documentation. + + + ERROR_CIRCULAR_DEPENDENCY + ERROR_CIRCULAR_DEPENDENCY + + + + No documentation. + + + ERROR_SERVICE_DOES_NOT_EXIST + ERROR_SERVICE_DOES_NOT_EXIST + + + + No documentation. + + + ERROR_SERVICE_CANNOT_ACCEPT_CTRL + ERROR_SERVICE_CANNOT_ACCEPT_CTRL + + + + No documentation. + + + ERROR_SERVICE_NOT_ACTIVE + ERROR_SERVICE_NOT_ACTIVE + + + + No documentation. + + + ERROR_FAILED_SERVICE_CONTROLLER_CONNECT + ERROR_FAILED_SERVICE_CONTROLLER_CONNECT + + + + No documentation. + + + ERROR_EXCEPTION_IN_SERVICE + ERROR_EXCEPTION_IN_SERVICE + + + + No documentation. + + + ERROR_DATABASE_DOES_NOT_EXIST + ERROR_DATABASE_DOES_NOT_EXIST + + + + No documentation. + + + ERROR_SERVICE_SPECIFIC_ERROR + ERROR_SERVICE_SPECIFIC_ERROR + + + + No documentation. + + + ERROR_PROCESS_ABORTED + ERROR_PROCESS_ABORTED + + + + No documentation. + + + ERROR_SERVICE_DEPENDENCY_FAIL + ERROR_SERVICE_DEPENDENCY_FAIL + + + + No documentation. + + + ERROR_SERVICE_LOGON_FAILED + ERROR_SERVICE_LOGON_FAILED + + + + No documentation. + + + ERROR_SERVICE_START_HANG + ERROR_SERVICE_START_HANG + + + + No documentation. + + + ERROR_INVALID_SERVICE_LOCK + ERROR_INVALID_SERVICE_LOCK + + + + No documentation. + + + ERROR_SERVICE_MARKED_FOR_DELETE + ERROR_SERVICE_MARKED_FOR_DELETE + + + + No documentation. + + + ERROR_SERVICE_EXISTS + ERROR_SERVICE_EXISTS + + + + No documentation. + + + ERROR_ALREADY_RUNNING_LKG + ERROR_ALREADY_RUNNING_LKG + + + + No documentation. + + + ERROR_SERVICE_DEPENDENCY_DELETED + ERROR_SERVICE_DEPENDENCY_DELETED + + + + No documentation. + + + ERROR_BOOT_ALREADY_ACCEPTED + ERROR_BOOT_ALREADY_ACCEPTED + + + + No documentation. + + + ERROR_SERVICE_NEVER_STARTED + ERROR_SERVICE_NEVER_STARTED + + + + No documentation. + + + ERROR_DUPLICATE_SERVICE_NAME + ERROR_DUPLICATE_SERVICE_NAME + + + + No documentation. + + + ERROR_DIFFERENT_SERVICE_ACCOUNT + ERROR_DIFFERENT_SERVICE_ACCOUNT + + + + No documentation. + + + ERROR_CANNOT_DETECT_DRIVER_FAILURE + ERROR_CANNOT_DETECT_DRIVER_FAILURE + + + + No documentation. + + + ERROR_CANNOT_DETECT_PROCESS_ABORT + ERROR_CANNOT_DETECT_PROCESS_ABORT + + + + No documentation. + + + ERROR_NO_RECOVERY_PROGRAM + ERROR_NO_RECOVERY_PROGRAM + + + + No documentation. + + + ERROR_SERVICE_NOT_IN_EXE + ERROR_SERVICE_NOT_IN_EXE + + + + No documentation. + + + ERROR_NOT_SAFEBOOT_SERVICE + ERROR_NOT_SAFEBOOT_SERVICE + + + + No documentation. + + + ERROR_END_OF_MEDIA + ERROR_END_OF_MEDIA + + + + No documentation. + + + ERROR_FILEMARK_DETECTED + ERROR_FILEMARK_DETECTED + + + + No documentation. + + + ERROR_BEGINNING_OF_MEDIA + ERROR_BEGINNING_OF_MEDIA + + + + No documentation. + + + ERROR_SETMARK_DETECTED + ERROR_SETMARK_DETECTED + + + + No documentation. + + + ERROR_NO_DATA_DETECTED + ERROR_NO_DATA_DETECTED + + + + No documentation. + + + ERROR_PARTITION_FAILURE + ERROR_PARTITION_FAILURE + + + + No documentation. + + + ERROR_INVALID_BLOCK_LENGTH + ERROR_INVALID_BLOCK_LENGTH + + + + No documentation. + + + ERROR_DEVICE_NOT_PARTITIONED + ERROR_DEVICE_NOT_PARTITIONED + + + + No documentation. + + + ERROR_UNABLE_TO_LOCK_MEDIA + ERROR_UNABLE_TO_LOCK_MEDIA + + + + No documentation. + + + ERROR_UNABLE_TO_UNLOAD_MEDIA + ERROR_UNABLE_TO_UNLOAD_MEDIA + + + + No documentation. + + + ERROR_MEDIA_CHANGED + ERROR_MEDIA_CHANGED + + + + No documentation. + + + ERROR_BUS_RESET + ERROR_BUS_RESET + + + + No documentation. + + + ERROR_NO_MEDIA_IN_DRIVE + ERROR_NO_MEDIA_IN_DRIVE + + + + No documentation. + + + ERROR_NO_UNICODE_TRANSLATION + ERROR_NO_UNICODE_TRANSLATION + + + + No documentation. + + + ERROR_DLL_INIT_FAILED + ERROR_DLL_INIT_FAILED + + + + No documentation. + + + ERROR_SHUTDOWN_IN_PROGRESS + ERROR_SHUTDOWN_IN_PROGRESS + + + + No documentation. + + + ERROR_NO_SHUTDOWN_IN_PROGRESS + ERROR_NO_SHUTDOWN_IN_PROGRESS + + + + No documentation. + + + ERROR_IO_DEVICE + ERROR_IO_DEVICE + + + + No documentation. + + + ERROR_SERIAL_NO_DEVICE + ERROR_SERIAL_NO_DEVICE + + + + No documentation. + + + ERROR_IRQ_BUSY + ERROR_IRQ_BUSY + + + + No documentation. + + + ERROR_MORE_WRITES + ERROR_MORE_WRITES + + + + No documentation. + + + ERROR_COUNTER_TIMEOUT + ERROR_COUNTER_TIMEOUT + + + + No documentation. + + + ERROR_FLOPPY_ID_MARK_NOT_FOUND + ERROR_FLOPPY_ID_MARK_NOT_FOUND + + + + No documentation. + + + ERROR_FLOPPY_WRONG_CYLINDER + ERROR_FLOPPY_WRONG_CYLINDER + + + + No documentation. + + + ERROR_FLOPPY_UNKNOWN_ERROR + ERROR_FLOPPY_UNKNOWN_ERROR + + + + No documentation. + + + ERROR_FLOPPY_BAD_REGISTERS + ERROR_FLOPPY_BAD_REGISTERS + + + + No documentation. + + + ERROR_DISK_RECALIBRATE_FAILED + ERROR_DISK_RECALIBRATE_FAILED + + + + No documentation. + + + ERROR_DISK_OPERATION_FAILED + ERROR_DISK_OPERATION_FAILED + + + + No documentation. + + + ERROR_DISK_RESET_FAILED + ERROR_DISK_RESET_FAILED + + + + No documentation. + + + ERROR_EOM_OVERFLOW + ERROR_EOM_OVERFLOW + + + + No documentation. + + + ERROR_NOT_ENOUGH_SERVER_MEMORY + ERROR_NOT_ENOUGH_SERVER_MEMORY + + + + No documentation. + + + ERROR_POSSIBLE_DEADLOCK + ERROR_POSSIBLE_DEADLOCK + + + + No documentation. + + + ERROR_MAPPED_ALIGNMENT + ERROR_MAPPED_ALIGNMENT + + + + No documentation. + + + ERROR_SET_POWER_STATE_VETOED + ERROR_SET_POWER_STATE_VETOED + + + + No documentation. + + + ERROR_SET_POWER_STATE_FAILED + ERROR_SET_POWER_STATE_FAILED + + + + No documentation. + + + ERROR_TOO_MANY_LINKS + ERROR_TOO_MANY_LINKS + + + + No documentation. + + + ERROR_OLD_WIN_VERSION + ERROR_OLD_WIN_VERSION + + + + No documentation. + + + ERROR_APP_WRONG_OS + ERROR_APP_WRONG_OS + + + + No documentation. + + + ERROR_SINGLE_INSTANCE_APP + ERROR_SINGLE_INSTANCE_APP + + + + No documentation. + + + ERROR_RMODE_APP + ERROR_RMODE_APP + + + + No documentation. + + + ERROR_INVALID_DLL + ERROR_INVALID_DLL + + + + No documentation. + + + ERROR_NO_ASSOCIATION + ERROR_NO_ASSOCIATION + + + + No documentation. + + + ERROR_DDE_FAIL + ERROR_DDE_FAIL + + + + No documentation. + + + ERROR_DLL_NOT_FOUND + ERROR_DLL_NOT_FOUND + + + + No documentation. + + + ERROR_NO_MORE_USER_HANDLES + ERROR_NO_MORE_USER_HANDLES + + + + No documentation. + + + ERROR_MESSAGE_SYNC_ONLY + ERROR_MESSAGE_SYNC_ONLY + + + + No documentation. + + + ERROR_SOURCE_ELEMENT_EMPTY + ERROR_SOURCE_ELEMENT_EMPTY + + + + No documentation. + + + ERROR_DESTINATION_ELEMENT_FULL + ERROR_DESTINATION_ELEMENT_FULL + + + + No documentation. + + + ERROR_ILLEGAL_ELEMENT_ADDRESS + ERROR_ILLEGAL_ELEMENT_ADDRESS + + + + No documentation. + + + ERROR_MAGAZINE_NOT_PRESENT + ERROR_MAGAZINE_NOT_PRESENT + + + + No documentation. + + + ERROR_DEVICE_REINITIALIZATION_NEEDED + ERROR_DEVICE_REINITIALIZATION_NEEDED + + + + No documentation. + + + ERROR_DEVICE_REQUIRES_CLEANING + ERROR_DEVICE_REQUIRES_CLEANING + + + + No documentation. + + + ERROR_DEVICE_DOOR_OPEN + ERROR_DEVICE_DOOR_OPEN + + + + No documentation. + + + ERROR_DEVICE_NOT_CONNECTED + ERROR_DEVICE_NOT_CONNECTED + + + + No documentation. + + + ERROR_NOT_FOUND + ERROR_NOT_FOUND + + + + No documentation. + + + ERROR_NO_MATCH + ERROR_NO_MATCH + + + + No documentation. + + + ERROR_SET_NOT_FOUND + ERROR_SET_NOT_FOUND + + + + No documentation. + + + ERROR_POINT_NOT_FOUND + ERROR_POINT_NOT_FOUND + + + + No documentation. + + + ERROR_NO_TRACKING_SERVICE + ERROR_NO_TRACKING_SERVICE + + + + No documentation. + + + ERROR_NO_VOLUME_ID + ERROR_NO_VOLUME_ID + + + + No documentation. + + + ERROR_UNABLE_TO_REMOVE_REPLACED + ERROR_UNABLE_TO_REMOVE_REPLACED + + + + No documentation. + + + ERROR_UNABLE_TO_MOVE_REPLACEMENT + ERROR_UNABLE_TO_MOVE_REPLACEMENT + + + + No documentation. + + + ERROR_UNABLE_TO_MOVE_REPLACEMENT_2 + ERROR_UNABLE_TO_MOVE_REPLACEMENT_2 + + + + No documentation. + + + ERROR_JOURNAL_DELETE_IN_PROGRESS + ERROR_JOURNAL_DELETE_IN_PROGRESS + + + + No documentation. + + + ERROR_JOURNAL_NOT_ACTIVE + ERROR_JOURNAL_NOT_ACTIVE + + + + No documentation. + + + ERROR_POTENTIAL_FILE_FOUND + ERROR_POTENTIAL_FILE_FOUND + + + + No documentation. + + + ERROR_JOURNAL_ENTRY_DELETED + ERROR_JOURNAL_ENTRY_DELETED + + + + No documentation. + + + ERROR_SHUTDOWN_IS_SCHEDULED + ERROR_SHUTDOWN_IS_SCHEDULED + + + + No documentation. + + + ERROR_SHUTDOWN_USERS_LOGGED_ON + ERROR_SHUTDOWN_USERS_LOGGED_ON + + + + No documentation. + + + ERROR_BAD_DEVICE + ERROR_BAD_DEVICE + + + + No documentation. + + + ERROR_CONNECTION_UNAVAIL + ERROR_CONNECTION_UNAVAIL + + + + No documentation. + + + ERROR_DEVICE_ALREADY_REMEMBERED + ERROR_DEVICE_ALREADY_REMEMBERED + + + + No documentation. + + + ERROR_NO_NET_OR_BAD_PATH + ERROR_NO_NET_OR_BAD_PATH + + + + No documentation. + + + ERROR_BAD_PROVIDER + ERROR_BAD_PROVIDER + + + + No documentation. + + + ERROR_CANNOT_OPEN_PROFILE + ERROR_CANNOT_OPEN_PROFILE + + + + No documentation. + + + ERROR_BAD_PROFILE + ERROR_BAD_PROFILE + + + + No documentation. + + + ERROR_NOT_CONTAINER + ERROR_NOT_CONTAINER + + + + No documentation. + + + ERROR_EXTENDED_ERROR + ERROR_EXTENDED_ERROR + + + + No documentation. + + + ERROR_INVALID_GROUPNAME + ERROR_INVALID_GROUPNAME + + + + No documentation. + + + ERROR_INVALID_COMPUTERNAME + ERROR_INVALID_COMPUTERNAME + + + + No documentation. + + + ERROR_INVALID_EVENTNAME + ERROR_INVALID_EVENTNAME + + + + No documentation. + + + ERROR_INVALID_DOMAINNAME + ERROR_INVALID_DOMAINNAME + + + + No documentation. + + + ERROR_INVALID_SERVICENAME + ERROR_INVALID_SERVICENAME + + + + No documentation. + + + ERROR_INVALID_NETNAME + ERROR_INVALID_NETNAME + + + + No documentation. + + + ERROR_INVALID_SHARENAME + ERROR_INVALID_SHARENAME + + + + No documentation. + + + ERROR_INVALID_PASSWORDNAME + ERROR_INVALID_PASSWORDNAME + + + + No documentation. + + + ERROR_INVALID_MESSAGENAME + ERROR_INVALID_MESSAGENAME + + + + No documentation. + + + ERROR_INVALID_MESSAGEDEST + ERROR_INVALID_MESSAGEDEST + + + + No documentation. + + + ERROR_SESSION_CREDENTIAL_CONFLICT + ERROR_SESSION_CREDENTIAL_CONFLICT + + + + No documentation. + + + ERROR_REMOTE_SESSION_LIMIT_EXCEEDED + ERROR_REMOTE_SESSION_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_DUP_DOMAINNAME + ERROR_DUP_DOMAINNAME + + + + No documentation. + + + ERROR_NO_NETWORK + ERROR_NO_NETWORK + + + + No documentation. + + + ERROR_CANCELLED + ERROR_CANCELLED + + + + No documentation. + + + ERROR_USER_MAPPED_FILE + ERROR_USER_MAPPED_FILE + + + + No documentation. + + + ERROR_CONNECTION_REFUSED + ERROR_CONNECTION_REFUSED + + + + No documentation. + + + ERROR_GRACEFUL_DISCONNECT + ERROR_GRACEFUL_DISCONNECT + + + + No documentation. + + + ERROR_ADDRESS_ALREADY_ASSOCIATED + ERROR_ADDRESS_ALREADY_ASSOCIATED + + + + No documentation. + + + ERROR_ADDRESS_NOT_ASSOCIATED + ERROR_ADDRESS_NOT_ASSOCIATED + + + + No documentation. + + + ERROR_CONNECTION_INVALID + ERROR_CONNECTION_INVALID + + + + No documentation. + + + ERROR_CONNECTION_ACTIVE + ERROR_CONNECTION_ACTIVE + + + + No documentation. + + + ERROR_NETWORK_UNREACHABLE + ERROR_NETWORK_UNREACHABLE + + + + No documentation. + + + ERROR_HOST_UNREACHABLE + ERROR_HOST_UNREACHABLE + + + + No documentation. + + + ERROR_PROTOCOL_UNREACHABLE + ERROR_PROTOCOL_UNREACHABLE + + + + No documentation. + + + ERROR_PORT_UNREACHABLE + ERROR_PORT_UNREACHABLE + + + + No documentation. + + + ERROR_REQUEST_ABORTED + ERROR_REQUEST_ABORTED + + + + No documentation. + + + ERROR_CONNECTION_ABORTED + ERROR_CONNECTION_ABORTED + + + + No documentation. + + + ERROR_RETRY + ERROR_RETRY + + + + No documentation. + + + ERROR_CONNECTION_COUNT_LIMIT + ERROR_CONNECTION_COUNT_LIMIT + + + + No documentation. + + + ERROR_LOGIN_TIME_RESTRICTION + ERROR_LOGIN_TIME_RESTRICTION + + + + No documentation. + + + ERROR_LOGIN_WKSTA_RESTRICTION + ERROR_LOGIN_WKSTA_RESTRICTION + + + + No documentation. + + + ERROR_INCORRECT_ADDRESS + ERROR_INCORRECT_ADDRESS + + + + No documentation. + + + ERROR_ALREADY_REGISTERED + ERROR_ALREADY_REGISTERED + + + + No documentation. + + + ERROR_SERVICE_NOT_FOUND + ERROR_SERVICE_NOT_FOUND + + + + No documentation. + + + ERROR_NOT_AUTHENTICATED + ERROR_NOT_AUTHENTICATED + + + + No documentation. + + + ERROR_NOT_LOGGED_ON + ERROR_NOT_LOGGED_ON + + + + No documentation. + + + ERROR_CONTINUE + ERROR_CONTINUE + + + + No documentation. + + + ERROR_ALREADY_INITIALIZED + ERROR_ALREADY_INITIALIZED + + + + No documentation. + + + ERROR_NO_MORE_DEVICES + ERROR_NO_MORE_DEVICES + + + + No documentation. + + + ERROR_NO_SUCH_SITE + ERROR_NO_SUCH_SITE + + + + No documentation. + + + ERROR_DOMAIN_CONTROLLER_EXISTS + ERROR_DOMAIN_CONTROLLER_EXISTS + + + + No documentation. + + + ERROR_ONLY_IF_CONNECTED + ERROR_ONLY_IF_CONNECTED + + + + No documentation. + + + ERROR_OVERRIDE_NOCHANGES + ERROR_OVERRIDE_NOCHANGES + + + + No documentation. + + + ERROR_BAD_USER_PROFILE + ERROR_BAD_USER_PROFILE + + + + No documentation. + + + ERROR_NOT_SUPPORTED_ON_SBS + ERROR_NOT_SUPPORTED_ON_SBS + + + + No documentation. + + + ERROR_SERVER_SHUTDOWN_IN_PROGRESS + ERROR_SERVER_SHUTDOWN_IN_PROGRESS + + + + No documentation. + + + ERROR_HOST_DOWN + ERROR_HOST_DOWN + + + + No documentation. + + + ERROR_NON_ACCOUNT_SID + ERROR_NON_ACCOUNT_SID + + + + No documentation. + + + ERROR_NON_DOMAIN_SID + ERROR_NON_DOMAIN_SID + + + + No documentation. + + + ERROR_APPHELP_BLOCK + ERROR_APPHELP_BLOCK + + + + No documentation. + + + ERROR_ACCESS_DISABLED_BY_POLICY + ERROR_ACCESS_DISABLED_BY_POLICY + + + + No documentation. + + + ERROR_REG_NAT_CONSUMPTION + ERROR_REG_NAT_CONSUMPTION + + + + No documentation. + + + ERROR_CSCSHARE_OFFLINE + ERROR_CSCSHARE_OFFLINE + + + + No documentation. + + + ERROR_PKINIT_FAILURE + ERROR_PKINIT_FAILURE + + + + No documentation. + + + ERROR_SMARTCARD_SUBSYSTEM_FAILURE + ERROR_SMARTCARD_SUBSYSTEM_FAILURE + + + + No documentation. + + + ERROR_DOWNGRADE_DETECTED + ERROR_DOWNGRADE_DETECTED + + + + No documentation. + + + ERROR_MACHINE_LOCKED + ERROR_MACHINE_LOCKED + + + + No documentation. + + + ERROR_CALLBACK_SUPPLIED_INVALID_DATA + ERROR_CALLBACK_SUPPLIED_INVALID_DATA + + + + No documentation. + + + ERROR_SYNC_FOREGROUND_REFRESH_REQUIRED + ERROR_SYNC_FOREGROUND_REFRESH_REQUIRED + + + + No documentation. + + + ERROR_DRIVER_BLOCKED + ERROR_DRIVER_BLOCKED + + + + No documentation. + + + ERROR_INVALID_IMPORT_OF_NON_DLL + ERROR_INVALID_IMPORT_OF_NON_DLL + + + + No documentation. + + + ERROR_ACCESS_DISABLED_WEBBLADE + ERROR_ACCESS_DISABLED_WEBBLADE + + + + No documentation. + + + ERROR_ACCESS_DISABLED_WEBBLADE_TAMPER + ERROR_ACCESS_DISABLED_WEBBLADE_TAMPER + + + + No documentation. + + + ERROR_RECOVERY_FAILURE + ERROR_RECOVERY_FAILURE + + + + No documentation. + + + ERROR_ALREADY_FIBER + ERROR_ALREADY_FIBER + + + + No documentation. + + + ERROR_ALREADY_THREAD + ERROR_ALREADY_THREAD + + + + No documentation. + + + ERROR_STACK_BUFFER_OVERRUN + ERROR_STACK_BUFFER_OVERRUN + + + + No documentation. + + + ERROR_PARAMETER_QUOTA_EXCEEDED + ERROR_PARAMETER_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_DEBUGGER_INACTIVE + ERROR_DEBUGGER_INACTIVE + + + + No documentation. + + + ERROR_DELAY_LOAD_FAILED + ERROR_DELAY_LOAD_FAILED + + + + No documentation. + + + ERROR_VDM_DISALLOWED + ERROR_VDM_DISALLOWED + + + + No documentation. + + + ERROR_UNIDENTIFIED_ERROR + ERROR_UNIDENTIFIED_ERROR + + + + No documentation. + + + ERROR_INVALID_CRUNTIME_PARAMETER + ERROR_INVALID_CRUNTIME_PARAMETER + + + + No documentation. + + + ERROR_BEYOND_VDL + ERROR_BEYOND_VDL + + + + No documentation. + + + ERROR_INCOMPATIBLE_SERVICE_SID_TYPE + ERROR_INCOMPATIBLE_SERVICE_SID_TYPE + + + + No documentation. + + + ERROR_DRIVER_PROCESS_TERMINATED + ERROR_DRIVER_PROCESS_TERMINATED + + + + No documentation. + + + ERROR_IMPLEMENTATION_LIMIT + ERROR_IMPLEMENTATION_LIMIT + + + + No documentation. + + + ERROR_PROCESS_IS_PROTECTED + ERROR_PROCESS_IS_PROTECTED + + + + No documentation. + + + ERROR_SERVICE_NOTIFY_CLIENT_LAGGING + ERROR_SERVICE_NOTIFY_CLIENT_LAGGING + + + + No documentation. + + + ERROR_DISK_QUOTA_EXCEEDED + ERROR_DISK_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_CONTENT_BLOCKED + ERROR_CONTENT_BLOCKED + + + + No documentation. + + + ERROR_INCOMPATIBLE_SERVICE_PRIVILEGE + ERROR_INCOMPATIBLE_SERVICE_PRIVILEGE + + + + No documentation. + + + ERROR_APP_HANG + ERROR_APP_HANG + + + + No documentation. + + + ERROR_INVALID_LABEL + ERROR_INVALID_LABEL + + + + No documentation. + + + ERROR_NOT_ALL_ASSIGNED + ERROR_NOT_ALL_ASSIGNED + + + + No documentation. + + + ERROR_SOME_NOT_MAPPED + ERROR_SOME_NOT_MAPPED + + + + No documentation. + + + ERROR_NO_QUOTAS_FOR_ACCOUNT + ERROR_NO_QUOTAS_FOR_ACCOUNT + + + + No documentation. + + + ERROR_LOCAL_USER_SESSION_KEY + ERROR_LOCAL_USER_SESSION_KEY + + + + No documentation. + + + ERROR_NULL_LM_PASSWORD + ERROR_NULL_LM_PASSWORD + + + + No documentation. + + + ERROR_UNKNOWN_REVISION + ERROR_UNKNOWN_REVISION + + + + No documentation. + + + ERROR_REVISION_MISMATCH + ERROR_REVISION_MISMATCH + + + + No documentation. + + + ERROR_INVALID_OWNER + ERROR_INVALID_OWNER + + + + No documentation. + + + ERROR_INVALID_PRIMARY_GROUP + ERROR_INVALID_PRIMARY_GROUP + + + + No documentation. + + + ERROR_NO_IMPERSONATION_TOKEN + ERROR_NO_IMPERSONATION_TOKEN + + + + No documentation. + + + ERROR_CANT_DISABLE_MANDATORY + ERROR_CANT_DISABLE_MANDATORY + + + + No documentation. + + + ERROR_NO_LOGON_SERVERS + ERROR_NO_LOGON_SERVERS + + + + No documentation. + + + ERROR_NO_SUCH_LOGON_SESSION + ERROR_NO_SUCH_LOGON_SESSION + + + + No documentation. + + + ERROR_NO_SUCH_PRIVILEGE + ERROR_NO_SUCH_PRIVILEGE + + + + No documentation. + + + ERROR_PRIVILEGE_NOT_HELD + ERROR_PRIVILEGE_NOT_HELD + + + + No documentation. + + + ERROR_INVALID_ACCOUNT_NAME + ERROR_INVALID_ACCOUNT_NAME + + + + No documentation. + + + ERROR_USER_EXISTS + ERROR_USER_EXISTS + + + + No documentation. + + + ERROR_NO_SUCH_USER + ERROR_NO_SUCH_USER + + + + No documentation. + + + ERROR_GROUP_EXISTS + ERROR_GROUP_EXISTS + + + + No documentation. + + + ERROR_NO_SUCH_GROUP + ERROR_NO_SUCH_GROUP + + + + No documentation. + + + ERROR_MEMBER_IN_GROUP + ERROR_MEMBER_IN_GROUP + + + + No documentation. + + + ERROR_MEMBER_NOT_IN_GROUP + ERROR_MEMBER_NOT_IN_GROUP + + + + No documentation. + + + ERROR_LAST_ADMIN + ERROR_LAST_ADMIN + + + + No documentation. + + + ERROR_WRONG_PASSWORD + ERROR_WRONG_PASSWORD + + + + No documentation. + + + ERROR_ILL_FORMED_PASSWORD + ERROR_ILL_FORMED_PASSWORD + + + + No documentation. + + + ERROR_PASSWORD_RESTRICTION + ERROR_PASSWORD_RESTRICTION + + + + No documentation. + + + ERROR_LOGON_FAILURE + ERROR_LOGON_FAILURE + + + + No documentation. + + + ERROR_ACCOUNT_RESTRICTION + ERROR_ACCOUNT_RESTRICTION + + + + No documentation. + + + ERROR_INVALID_LOGON_HOURS + ERROR_INVALID_LOGON_HOURS + + + + No documentation. + + + ERROR_INVALID_WORKSTATION + ERROR_INVALID_WORKSTATION + + + + No documentation. + + + ERROR_PASSWORD_EXPIRED + ERROR_PASSWORD_EXPIRED + + + + No documentation. + + + ERROR_ACCOUNT_DISABLED + ERROR_ACCOUNT_DISABLED + + + + No documentation. + + + ERROR_NONE_MAPPED + ERROR_NONE_MAPPED + + + + No documentation. + + + ERROR_TOO_MANY_LUIDS_REQUESTED + ERROR_TOO_MANY_LUIDS_REQUESTED + + + + No documentation. + + + ERROR_LUIDS_EXHAUSTED + ERROR_LUIDS_EXHAUSTED + + + + No documentation. + + + ERROR_INVALID_SUB_AUTHORITY + ERROR_INVALID_SUB_AUTHORITY + + + + No documentation. + + + ERROR_INVALID_ACL + ERROR_INVALID_ACL + + + + No documentation. + + + ERROR_INVALID_SID + ERROR_INVALID_SID + + + + No documentation. + + + ERROR_INVALID_SECURITY_DESCR + ERROR_INVALID_SECURITY_DESCR + + + + No documentation. + + + ERROR_BAD_INHERITANCE_ACL + ERROR_BAD_INHERITANCE_ACL + + + + No documentation. + + + ERROR_SERVER_DISABLED + ERROR_SERVER_DISABLED + + + + No documentation. + + + ERROR_SERVER_NOT_DISABLED + ERROR_SERVER_NOT_DISABLED + + + + No documentation. + + + ERROR_INVALID_ID_AUTHORITY + ERROR_INVALID_ID_AUTHORITY + + + + No documentation. + + + ERROR_ALLOTTED_SPACE_EXCEEDED + ERROR_ALLOTTED_SPACE_EXCEEDED + + + + No documentation. + + + ERROR_INVALID_GROUP_ATTRIBUTES + ERROR_INVALID_GROUP_ATTRIBUTES + + + + No documentation. + + + ERROR_BAD_IMPERSONATION_LEVEL + ERROR_BAD_IMPERSONATION_LEVEL + + + + No documentation. + + + ERROR_CANT_OPEN_ANONYMOUS + ERROR_CANT_OPEN_ANONYMOUS + + + + No documentation. + + + ERROR_BAD_VALIDATION_CLASS + ERROR_BAD_VALIDATION_CLASS + + + + No documentation. + + + ERROR_BAD_TOKEN_TYPE + ERROR_BAD_TOKEN_TYPE + + + + No documentation. + + + ERROR_NO_SECURITY_ON_OBJECT + ERROR_NO_SECURITY_ON_OBJECT + + + + No documentation. + + + ERROR_CANT_ACCESS_DOMAIN_INFO + ERROR_CANT_ACCESS_DOMAIN_INFO + + + + No documentation. + + + ERROR_INVALID_SERVER_STATE + ERROR_INVALID_SERVER_STATE + + + + No documentation. + + + ERROR_INVALID_DOMAIN_STATE + ERROR_INVALID_DOMAIN_STATE + + + + No documentation. + + + ERROR_INVALID_DOMAIN_ROLE + ERROR_INVALID_DOMAIN_ROLE + + + + No documentation. + + + ERROR_NO_SUCH_DOMAIN + ERROR_NO_SUCH_DOMAIN + + + + No documentation. + + + ERROR_DOMAIN_EXISTS + ERROR_DOMAIN_EXISTS + + + + No documentation. + + + ERROR_DOMAIN_LIMIT_EXCEEDED + ERROR_DOMAIN_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_INTERNAL_DB_CORRUPTION + ERROR_INTERNAL_DB_CORRUPTION + + + + No documentation. + + + ERROR_INTERNAL_ERROR + ERROR_INTERNAL_ERROR + + + + No documentation. + + + ERROR_GENERIC_NOT_MAPPED + ERROR_GENERIC_NOT_MAPPED + + + + No documentation. + + + ERROR_BAD_DESCRIPTOR_FORMAT + ERROR_BAD_DESCRIPTOR_FORMAT + + + + No documentation. + + + ERROR_NOT_LOGON_PROCESS + ERROR_NOT_LOGON_PROCESS + + + + No documentation. + + + ERROR_LOGON_SESSION_EXISTS + ERROR_LOGON_SESSION_EXISTS + + + + No documentation. + + + ERROR_NO_SUCH_PACKAGE + ERROR_NO_SUCH_PACKAGE + + + + No documentation. + + + ERROR_BAD_LOGON_SESSION_STATE + ERROR_BAD_LOGON_SESSION_STATE + + + + No documentation. + + + ERROR_LOGON_SESSION_COLLISION + ERROR_LOGON_SESSION_COLLISION + + + + No documentation. + + + ERROR_INVALID_LOGON_TYPE + ERROR_INVALID_LOGON_TYPE + + + + No documentation. + + + ERROR_CANNOT_IMPERSONATE + ERROR_CANNOT_IMPERSONATE + + + + No documentation. + + + ERROR_RXACT_INVALID_STATE + ERROR_RXACT_INVALID_STATE + + + + No documentation. + + + ERROR_RXACT_COMMIT_FAILURE + ERROR_RXACT_COMMIT_FAILURE + + + + No documentation. + + + ERROR_SPECIAL_ACCOUNT + ERROR_SPECIAL_ACCOUNT + + + + No documentation. + + + ERROR_SPECIAL_GROUP + ERROR_SPECIAL_GROUP + + + + No documentation. + + + ERROR_SPECIAL_USER + ERROR_SPECIAL_USER + + + + No documentation. + + + ERROR_MEMBERS_PRIMARY_GROUP + ERROR_MEMBERS_PRIMARY_GROUP + + + + No documentation. + + + ERROR_TOKEN_ALREADY_IN_USE + ERROR_TOKEN_ALREADY_IN_USE + + + + No documentation. + + + ERROR_NO_SUCH_ALIAS + ERROR_NO_SUCH_ALIAS + + + + No documentation. + + + ERROR_MEMBER_NOT_IN_ALIAS + ERROR_MEMBER_NOT_IN_ALIAS + + + + No documentation. + + + ERROR_MEMBER_IN_ALIAS + ERROR_MEMBER_IN_ALIAS + + + + No documentation. + + + ERROR_ALIAS_EXISTS + ERROR_ALIAS_EXISTS + + + + No documentation. + + + ERROR_LOGON_NOT_GRANTED + ERROR_LOGON_NOT_GRANTED + + + + No documentation. + + + ERROR_TOO_MANY_SECRETS + ERROR_TOO_MANY_SECRETS + + + + No documentation. + + + ERROR_SECRET_TOO_LONG + ERROR_SECRET_TOO_LONG + + + + No documentation. + + + ERROR_INTERNAL_DB_ERROR + ERROR_INTERNAL_DB_ERROR + + + + No documentation. + + + ERROR_TOO_MANY_CONTEXT_IDS + ERROR_TOO_MANY_CONTEXT_IDS + + + + No documentation. + + + ERROR_LOGON_TYPE_NOT_GRANTED + ERROR_LOGON_TYPE_NOT_GRANTED + + + + No documentation. + + + ERROR_NT_CROSS_ENCRYPTION_REQUIRED + ERROR_NT_CROSS_ENCRYPTION_REQUIRED + + + + No documentation. + + + ERROR_NO_SUCH_MEMBER + ERROR_NO_SUCH_MEMBER + + + + No documentation. + + + ERROR_INVALID_MEMBER + ERROR_INVALID_MEMBER + + + + No documentation. + + + ERROR_TOO_MANY_SIDS + ERROR_TOO_MANY_SIDS + + + + No documentation. + + + ERROR_LM_CROSS_ENCRYPTION_REQUIRED + ERROR_LM_CROSS_ENCRYPTION_REQUIRED + + + + No documentation. + + + ERROR_NO_INHERITANCE + ERROR_NO_INHERITANCE + + + + No documentation. + + + ERROR_FILE_CORRUPT + ERROR_FILE_CORRUPT + + + + No documentation. + + + ERROR_DISK_CORRUPT + ERROR_DISK_CORRUPT + + + + No documentation. + + + ERROR_NO_USER_SESSION_KEY + ERROR_NO_USER_SESSION_KEY + + + + No documentation. + + + ERROR_LICENSE_QUOTA_EXCEEDED + ERROR_LICENSE_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_WRONG_TARGET_NAME + ERROR_WRONG_TARGET_NAME + + + + No documentation. + + + ERROR_MUTUAL_AUTH_FAILED + ERROR_MUTUAL_AUTH_FAILED + + + + No documentation. + + + ERROR_TIME_SKEW + ERROR_TIME_SKEW + + + + No documentation. + + + ERROR_CURRENT_DOMAIN_NOT_ALLOWED + ERROR_CURRENT_DOMAIN_NOT_ALLOWED + + + + No documentation. + + + ERROR_INVALID_WINDOW_HANDLE + ERROR_INVALID_WINDOW_HANDLE + + + + No documentation. + + + ERROR_INVALID_MENU_HANDLE + ERROR_INVALID_MENU_HANDLE + + + + No documentation. + + + ERROR_INVALID_CURSOR_HANDLE + ERROR_INVALID_CURSOR_HANDLE + + + + No documentation. + + + ERROR_INVALID_ACCEL_HANDLE + ERROR_INVALID_ACCEL_HANDLE + + + + No documentation. + + + ERROR_INVALID_HOOK_HANDLE + ERROR_INVALID_HOOK_HANDLE + + + + No documentation. + + + ERROR_INVALID_DWP_HANDLE + ERROR_INVALID_DWP_HANDLE + + + + No documentation. + + + ERROR_TLW_WITH_WSCHILD + ERROR_TLW_WITH_WSCHILD + + + + No documentation. + + + ERROR_CANNOT_FIND_WND_CLASS + ERROR_CANNOT_FIND_WND_CLASS + + + + No documentation. + + + ERROR_WINDOW_OF_OTHER_THREAD + ERROR_WINDOW_OF_OTHER_THREAD + + + + No documentation. + + + ERROR_HOTKEY_ALREADY_REGISTERED + ERROR_HOTKEY_ALREADY_REGISTERED + + + + No documentation. + + + ERROR_CLASS_ALREADY_EXISTS + ERROR_CLASS_ALREADY_EXISTS + + + + No documentation. + + + ERROR_CLASS_DOES_NOT_EXIST + ERROR_CLASS_DOES_NOT_EXIST + + + + No documentation. + + + ERROR_CLASS_HAS_WINDOWS + ERROR_CLASS_HAS_WINDOWS + + + + No documentation. + + + ERROR_INVALID_INDEX + ERROR_INVALID_INDEX + + + + No documentation. + + + ERROR_INVALID_ICON_HANDLE + ERROR_INVALID_ICON_HANDLE + + + + No documentation. + + + ERROR_PRIVATE_DIALOG_INDEX + ERROR_PRIVATE_DIALOG_INDEX + + + + No documentation. + + + ERROR_LISTBOX_ID_NOT_FOUND + ERROR_LISTBOX_ID_NOT_FOUND + + + + No documentation. + + + ERROR_NO_WILDCARD_CHARACTERS + ERROR_NO_WILDCARD_CHARACTERS + + + + No documentation. + + + ERROR_CLIPBOARD_NOT_OPEN + ERROR_CLIPBOARD_NOT_OPEN + + + + No documentation. + + + ERROR_HOTKEY_NOT_REGISTERED + ERROR_HOTKEY_NOT_REGISTERED + + + + No documentation. + + + ERROR_WINDOW_NOT_DIALOG + ERROR_WINDOW_NOT_DIALOG + + + + No documentation. + + + ERROR_CONTROL_ID_NOT_FOUND + ERROR_CONTROL_ID_NOT_FOUND + + + + No documentation. + + + ERROR_INVALID_COMBOBOX_MESSAGE + ERROR_INVALID_COMBOBOX_MESSAGE + + + + No documentation. + + + ERROR_WINDOW_NOT_COMBOBOX + ERROR_WINDOW_NOT_COMBOBOX + + + + No documentation. + + + ERROR_INVALID_EDIT_HEIGHT + ERROR_INVALID_EDIT_HEIGHT + + + + No documentation. + + + ERROR_DC_NOT_FOUND + ERROR_DC_NOT_FOUND + + + + No documentation. + + + ERROR_INVALID_HOOK_FILTER + ERROR_INVALID_HOOK_FILTER + + + + No documentation. + + + ERROR_INVALID_FILTER_PROC + ERROR_INVALID_FILTER_PROC + + + + No documentation. + + + ERROR_HOOK_NEEDS_HMOD + ERROR_HOOK_NEEDS_HMOD + + + + No documentation. + + + ERROR_GLOBAL_ONLY_HOOK + ERROR_GLOBAL_ONLY_HOOK + + + + No documentation. + + + ERROR_JOURNAL_HOOK_SET + ERROR_JOURNAL_HOOK_SET + + + + No documentation. + + + ERROR_HOOK_NOT_INSTALLED + ERROR_HOOK_NOT_INSTALLED + + + + No documentation. + + + ERROR_INVALID_LB_MESSAGE + ERROR_INVALID_LB_MESSAGE + + + + No documentation. + + + ERROR_SETCOUNT_ON_BAD_LB + ERROR_SETCOUNT_ON_BAD_LB + + + + No documentation. + + + ERROR_LB_WITHOUT_TABSTOPS + ERROR_LB_WITHOUT_TABSTOPS + + + + No documentation. + + + ERROR_DESTROY_OBJECT_OF_OTHER_THREAD + ERROR_DESTROY_OBJECT_OF_OTHER_THREAD + + + + No documentation. + + + ERROR_CHILD_WINDOW_MENU + ERROR_CHILD_WINDOW_MENU + + + + No documentation. + + + ERROR_NO_SYSTEM_MENU + ERROR_NO_SYSTEM_MENU + + + + No documentation. + + + ERROR_INVALID_MSGBOX_STYLE + ERROR_INVALID_MSGBOX_STYLE + + + + No documentation. + + + ERROR_INVALID_SPI_VALUE + ERROR_INVALID_SPI_VALUE + + + + No documentation. + + + ERROR_SCREEN_ALREADY_LOCKED + ERROR_SCREEN_ALREADY_LOCKED + + + + No documentation. + + + ERROR_HWNDS_HAVE_DIFF_PARENT + ERROR_HWNDS_HAVE_DIFF_PARENT + + + + No documentation. + + + ERROR_NOT_CHILD_WINDOW + ERROR_NOT_CHILD_WINDOW + + + + No documentation. + + + ERROR_INVALID_GW_COMMAND + ERROR_INVALID_GW_COMMAND + + + + No documentation. + + + ERROR_INVALID_THREAD_ID + ERROR_INVALID_THREAD_ID + + + + No documentation. + + + ERROR_NON_MDICHILD_WINDOW + ERROR_NON_MDICHILD_WINDOW + + + + No documentation. + + + ERROR_POPUP_ALREADY_ACTIVE + ERROR_POPUP_ALREADY_ACTIVE + + + + No documentation. + + + ERROR_NO_SCROLLBARS + ERROR_NO_SCROLLBARS + + + + No documentation. + + + ERROR_INVALID_SCROLLBAR_RANGE + ERROR_INVALID_SCROLLBAR_RANGE + + + + No documentation. + + + ERROR_INVALID_SHOWWIN_COMMAND + ERROR_INVALID_SHOWWIN_COMMAND + + + + No documentation. + + + ERROR_NO_SYSTEM_RESOURCES + ERROR_NO_SYSTEM_RESOURCES + + + + No documentation. + + + ERROR_NONPAGED_SYSTEM_RESOURCES + ERROR_NONPAGED_SYSTEM_RESOURCES + + + + No documentation. + + + ERROR_PAGED_SYSTEM_RESOURCES + ERROR_PAGED_SYSTEM_RESOURCES + + + + No documentation. + + + ERROR_WORKING_SET_QUOTA + ERROR_WORKING_SET_QUOTA + + + + No documentation. + + + ERROR_PAGEFILE_QUOTA + ERROR_PAGEFILE_QUOTA + + + + No documentation. + + + ERROR_COMMITMENT_LIMIT + ERROR_COMMITMENT_LIMIT + + + + No documentation. + + + ERROR_MENU_ITEM_NOT_FOUND + ERROR_MENU_ITEM_NOT_FOUND + + + + No documentation. + + + ERROR_INVALID_KEYBOARD_HANDLE + ERROR_INVALID_KEYBOARD_HANDLE + + + + No documentation. + + + ERROR_HOOK_TYPE_NOT_ALLOWED + ERROR_HOOK_TYPE_NOT_ALLOWED + + + + No documentation. + + + ERROR_REQUIRES_INTERACTIVE_WINDOWSTATION + ERROR_REQUIRES_INTERACTIVE_WINDOWSTATION + + + + No documentation. + + + ERROR_TIMEOUT + ERROR_TIMEOUT + + + + No documentation. + + + ERROR_INVALID_MONITOR_HANDLE + ERROR_INVALID_MONITOR_HANDLE + + + + No documentation. + + + ERROR_INCORRECT_SIZE + ERROR_INCORRECT_SIZE + + + + No documentation. + + + ERROR_SYMLINK_CLASS_DISABLED + ERROR_SYMLINK_CLASS_DISABLED + + + + No documentation. + + + ERROR_SYMLINK_NOT_SUPPORTED + ERROR_SYMLINK_NOT_SUPPORTED + + + + No documentation. + + + ERROR_XML_PARSE_ERROR + ERROR_XML_PARSE_ERROR + + + + No documentation. + + + ERROR_XMLDSIG_ERROR + ERROR_XMLDSIG_ERROR + + + + No documentation. + + + ERROR_RESTART_APPLICATION + ERROR_RESTART_APPLICATION + + + + No documentation. + + + ERROR_WRONG_COMPARTMENT + ERROR_WRONG_COMPARTMENT + + + + No documentation. + + + ERROR_AUTHIP_FAILURE + ERROR_AUTHIP_FAILURE + + + + No documentation. + + + ERROR_NO_NVRAM_RESOURCES + ERROR_NO_NVRAM_RESOURCES + + + + No documentation. + + + ERROR_EVENTLOG_FILE_CORRUPT + ERROR_EVENTLOG_FILE_CORRUPT + + + + No documentation. + + + ERROR_EVENTLOG_CANT_START + ERROR_EVENTLOG_CANT_START + + + + No documentation. + + + ERROR_LOG_FILE_FULL + ERROR_LOG_FILE_FULL + + + + No documentation. + + + ERROR_EVENTLOG_FILE_CHANGED + ERROR_EVENTLOG_FILE_CHANGED + + + + No documentation. + + + ERROR_INVALID_TASK_NAME + ERROR_INVALID_TASK_NAME + + + + No documentation. + + + ERROR_INVALID_TASK_INDEX + ERROR_INVALID_TASK_INDEX + + + + No documentation. + + + ERROR_THREAD_ALREADY_IN_TASK + ERROR_THREAD_ALREADY_IN_TASK + + + + No documentation. + + + ERROR_INSTALL_SERVICE_FAILURE + ERROR_INSTALL_SERVICE_FAILURE + + + + No documentation. + + + ERROR_INSTALL_USEREXIT + ERROR_INSTALL_USEREXIT + + + + No documentation. + + + ERROR_INSTALL_FAILURE + ERROR_INSTALL_FAILURE + + + + No documentation. + + + ERROR_INSTALL_SUSPEND + ERROR_INSTALL_SUSPEND + + + + No documentation. + + + ERROR_UNKNOWN_PRODUCT + ERROR_UNKNOWN_PRODUCT + + + + No documentation. + + + ERROR_UNKNOWN_FEATURE + ERROR_UNKNOWN_FEATURE + + + + No documentation. + + + ERROR_UNKNOWN_COMPONENT + ERROR_UNKNOWN_COMPONENT + + + + No documentation. + + + ERROR_UNKNOWN_PROPERTY + ERROR_UNKNOWN_PROPERTY + + + + No documentation. + + + ERROR_INVALID_HANDLE_STATE + ERROR_INVALID_HANDLE_STATE + + + + No documentation. + + + ERROR_BAD_CONFIGURATION + ERROR_BAD_CONFIGURATION + + + + No documentation. + + + ERROR_INDEX_ABSENT + ERROR_INDEX_ABSENT + + + + No documentation. + + + ERROR_INSTALL_SOURCE_ABSENT + ERROR_INSTALL_SOURCE_ABSENT + + + + No documentation. + + + ERROR_INSTALL_PACKAGE_VERSION + ERROR_INSTALL_PACKAGE_VERSION + + + + No documentation. + + + ERROR_PRODUCT_UNINSTALLED + ERROR_PRODUCT_UNINSTALLED + + + + No documentation. + + + ERROR_BAD_QUERY_SYNTAX + ERROR_BAD_QUERY_SYNTAX + + + + No documentation. + + + ERROR_INVALID_FIELD + ERROR_INVALID_FIELD + + + + No documentation. + + + ERROR_DEVICE_REMOVED + ERROR_DEVICE_REMOVED + + + + No documentation. + + + ERROR_INSTALL_ALREADY_RUNNING + ERROR_INSTALL_ALREADY_RUNNING + + + + No documentation. + + + ERROR_INSTALL_PACKAGE_OPEN_FAILED + ERROR_INSTALL_PACKAGE_OPEN_FAILED + + + + No documentation. + + + ERROR_INSTALL_PACKAGE_INVALID + ERROR_INSTALL_PACKAGE_INVALID + + + + No documentation. + + + ERROR_INSTALL_UI_FAILURE + ERROR_INSTALL_UI_FAILURE + + + + No documentation. + + + ERROR_INSTALL_LOG_FAILURE + ERROR_INSTALL_LOG_FAILURE + + + + No documentation. + + + ERROR_INSTALL_LANGUAGE_UNSUPPORTED + ERROR_INSTALL_LANGUAGE_UNSUPPORTED + + + + No documentation. + + + ERROR_INSTALL_TRANSFORM_FAILURE + ERROR_INSTALL_TRANSFORM_FAILURE + + + + No documentation. + + + ERROR_INSTALL_PACKAGE_REJECTED + ERROR_INSTALL_PACKAGE_REJECTED + + + + No documentation. + + + ERROR_FUNCTION_NOT_CALLED + ERROR_FUNCTION_NOT_CALLED + + + + No documentation. + + + ERROR_FUNCTION_FAILED + ERROR_FUNCTION_FAILED + + + + No documentation. + + + ERROR_INVALID_TABLE + ERROR_INVALID_TABLE + + + + No documentation. + + + ERROR_DATATYPE_MISMATCH + ERROR_DATATYPE_MISMATCH + + + + No documentation. + + + ERROR_UNSUPPORTED_TYPE + ERROR_UNSUPPORTED_TYPE + + + + No documentation. + + + ERROR_CREATE_FAILED + ERROR_CREATE_FAILED + + + + No documentation. + + + ERROR_INSTALL_TEMP_UNWRITABLE + ERROR_INSTALL_TEMP_UNWRITABLE + + + + No documentation. + + + ERROR_INSTALL_PLATFORM_UNSUPPORTED + ERROR_INSTALL_PLATFORM_UNSUPPORTED + + + + No documentation. + + + ERROR_INSTALL_NOTUSED + ERROR_INSTALL_NOTUSED + + + + No documentation. + + + ERROR_PATCH_PACKAGE_OPEN_FAILED + ERROR_PATCH_PACKAGE_OPEN_FAILED + + + + No documentation. + + + ERROR_PATCH_PACKAGE_INVALID + ERROR_PATCH_PACKAGE_INVALID + + + + No documentation. + + + ERROR_PATCH_PACKAGE_UNSUPPORTED + ERROR_PATCH_PACKAGE_UNSUPPORTED + + + + No documentation. + + + ERROR_PRODUCT_VERSION + ERROR_PRODUCT_VERSION + + + + No documentation. + + + ERROR_INVALID_COMMAND_LINE + ERROR_INVALID_COMMAND_LINE + + + + No documentation. + + + ERROR_INSTALL_REMOTE_DISALLOWED + ERROR_INSTALL_REMOTE_DISALLOWED + + + + No documentation. + + + ERROR_SUCCESS_REBOOT_INITIATED + ERROR_SUCCESS_REBOOT_INITIATED + + + + No documentation. + + + ERROR_PATCH_TARGET_NOT_FOUND + ERROR_PATCH_TARGET_NOT_FOUND + + + + No documentation. + + + ERROR_PATCH_PACKAGE_REJECTED + ERROR_PATCH_PACKAGE_REJECTED + + + + No documentation. + + + ERROR_INSTALL_TRANSFORM_REJECTED + ERROR_INSTALL_TRANSFORM_REJECTED + + + + No documentation. + + + ERROR_INSTALL_REMOTE_PROHIBITED + ERROR_INSTALL_REMOTE_PROHIBITED + + + + No documentation. + + + ERROR_PATCH_REMOVAL_UNSUPPORTED + ERROR_PATCH_REMOVAL_UNSUPPORTED + + + + No documentation. + + + ERROR_UNKNOWN_PATCH + ERROR_UNKNOWN_PATCH + + + + No documentation. + + + ERROR_PATCH_NO_SEQUENCE + ERROR_PATCH_NO_SEQUENCE + + + + No documentation. + + + ERROR_PATCH_REMOVAL_DISALLOWED + ERROR_PATCH_REMOVAL_DISALLOWED + + + + No documentation. + + + ERROR_INVALID_PATCH_XML + ERROR_INVALID_PATCH_XML + + + + No documentation. + + + ERROR_PATCH_MANAGED_ADVERTISED_PRODUCT + ERROR_PATCH_MANAGED_ADVERTISED_PRODUCT + + + + No documentation. + + + ERROR_INSTALL_SERVICE_SAFEBOOT + ERROR_INSTALL_SERVICE_SAFEBOOT + + + + No documentation. + + + ERROR_FAIL_FAST_EXCEPTION + ERROR_FAIL_FAST_EXCEPTION + + + + No documentation. + + + ERROR_INVALID_USER_BUFFER + ERROR_INVALID_USER_BUFFER + + + + No documentation. + + + ERROR_UNRECOGNIZED_MEDIA + ERROR_UNRECOGNIZED_MEDIA + + + + No documentation. + + + ERROR_NO_TRUST_LSA_SECRET + ERROR_NO_TRUST_LSA_SECRET + + + + No documentation. + + + ERROR_NO_TRUST_SAM_ACCOUNT + ERROR_NO_TRUST_SAM_ACCOUNT + + + + No documentation. + + + ERROR_TRUSTED_DOMAIN_FAILURE + ERROR_TRUSTED_DOMAIN_FAILURE + + + + No documentation. + + + ERROR_TRUSTED_RELATIONSHIP_FAILURE + ERROR_TRUSTED_RELATIONSHIP_FAILURE + + + + No documentation. + + + ERROR_TRUST_FAILURE + ERROR_TRUST_FAILURE + + + + No documentation. + + + ERROR_NETLOGON_NOT_STARTED + ERROR_NETLOGON_NOT_STARTED + + + + No documentation. + + + ERROR_ACCOUNT_EXPIRED + ERROR_ACCOUNT_EXPIRED + + + + No documentation. + + + ERROR_REDIRECTOR_HAS_OPEN_HANDLES + ERROR_REDIRECTOR_HAS_OPEN_HANDLES + + + + No documentation. + + + ERROR_PRINTER_DRIVER_ALREADY_INSTALLED + ERROR_PRINTER_DRIVER_ALREADY_INSTALLED + + + + No documentation. + + + ERROR_UNKNOWN_PORT + ERROR_UNKNOWN_PORT + + + + No documentation. + + + ERROR_UNKNOWN_PRINTER_DRIVER + ERROR_UNKNOWN_PRINTER_DRIVER + + + + No documentation. + + + ERROR_UNKNOWN_PRINTPROCESSOR + ERROR_UNKNOWN_PRINTPROCESSOR + + + + No documentation. + + + ERROR_INVALID_SEPARATOR_FILE + ERROR_INVALID_SEPARATOR_FILE + + + + No documentation. + + + ERROR_INVALID_PRIORITY + ERROR_INVALID_PRIORITY + + + + No documentation. + + + ERROR_INVALID_PRINTER_NAME + ERROR_INVALID_PRINTER_NAME + + + + No documentation. + + + ERROR_PRINTER_ALREADY_EXISTS + ERROR_PRINTER_ALREADY_EXISTS + + + + No documentation. + + + ERROR_INVALID_PRINTER_COMMAND + ERROR_INVALID_PRINTER_COMMAND + + + + No documentation. + + + ERROR_INVALID_DATATYPE + ERROR_INVALID_DATATYPE + + + + No documentation. + + + ERROR_INVALID_ENVIRONMENT + ERROR_INVALID_ENVIRONMENT + + + + No documentation. + + + ERROR_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT + ERROR_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT + + + + No documentation. + + + ERROR_NOLOGON_WORKSTATION_TRUST_ACCOUNT + ERROR_NOLOGON_WORKSTATION_TRUST_ACCOUNT + + + + No documentation. + + + ERROR_NOLOGON_SERVER_TRUST_ACCOUNT + ERROR_NOLOGON_SERVER_TRUST_ACCOUNT + + + + No documentation. + + + ERROR_DOMAIN_TRUST_INCONSISTENT + ERROR_DOMAIN_TRUST_INCONSISTENT + + + + No documentation. + + + ERROR_SERVER_HAS_OPEN_HANDLES + ERROR_SERVER_HAS_OPEN_HANDLES + + + + No documentation. + + + ERROR_RESOURCE_DATA_NOT_FOUND + ERROR_RESOURCE_DATA_NOT_FOUND + + + + No documentation. + + + ERROR_RESOURCE_TYPE_NOT_FOUND + ERROR_RESOURCE_TYPE_NOT_FOUND + + + + No documentation. + + + ERROR_RESOURCE_NAME_NOT_FOUND + ERROR_RESOURCE_NAME_NOT_FOUND + + + + No documentation. + + + ERROR_RESOURCE_LANG_NOT_FOUND + ERROR_RESOURCE_LANG_NOT_FOUND + + + + No documentation. + + + ERROR_NOT_ENOUGH_QUOTA + ERROR_NOT_ENOUGH_QUOTA + + + + No documentation. + + + ERROR_INVALID_TIME + ERROR_INVALID_TIME + + + + No documentation. + + + ERROR_INVALID_FORM_NAME + ERROR_INVALID_FORM_NAME + + + + No documentation. + + + ERROR_INVALID_FORM_SIZE + ERROR_INVALID_FORM_SIZE + + + + No documentation. + + + ERROR_ALREADY_WAITING + ERROR_ALREADY_WAITING + + + + No documentation. + + + ERROR_PRINTER_DELETED + ERROR_PRINTER_DELETED + + + + No documentation. + + + ERROR_INVALID_PRINTER_STATE + ERROR_INVALID_PRINTER_STATE + + + + No documentation. + + + ERROR_PASSWORD_MUST_CHANGE + ERROR_PASSWORD_MUST_CHANGE + + + + No documentation. + + + ERROR_DOMAIN_CONTROLLER_NOT_FOUND + ERROR_DOMAIN_CONTROLLER_NOT_FOUND + + + + No documentation. + + + ERROR_ACCOUNT_LOCKED_OUT + ERROR_ACCOUNT_LOCKED_OUT + + + + No documentation. + + + ERROR_NO_SITENAME + ERROR_NO_SITENAME + + + + No documentation. + + + ERROR_CANT_ACCESS_FILE + ERROR_CANT_ACCESS_FILE + + + + No documentation. + + + ERROR_CANT_RESOLVE_FILENAME + ERROR_CANT_RESOLVE_FILENAME + + + + No documentation. + + + ERROR_KM_DRIVER_BLOCKED + ERROR_KM_DRIVER_BLOCKED + + + + No documentation. + + + ERROR_CONTEXT_EXPIRED + ERROR_CONTEXT_EXPIRED + + + + No documentation. + + + ERROR_PER_USER_TRUST_QUOTA_EXCEEDED + ERROR_PER_USER_TRUST_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_ALL_USER_TRUST_QUOTA_EXCEEDED + ERROR_ALL_USER_TRUST_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_USER_DELETE_TRUST_QUOTA_EXCEEDED + ERROR_USER_DELETE_TRUST_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_AUTHENTICATION_FIREWALL_FAILED + ERROR_AUTHENTICATION_FIREWALL_FAILED + + + + No documentation. + + + ERROR_REMOTE_PRINT_CONNECTIONS_BLOCKED + ERROR_REMOTE_PRINT_CONNECTIONS_BLOCKED + + + + No documentation. + + + ERROR_NTLM_BLOCKED + ERROR_NTLM_BLOCKED + + + + No documentation. + + + ERROR_INVALID_PIXEL_FORMAT + ERROR_INVALID_PIXEL_FORMAT + + + + No documentation. + + + ERROR_BAD_DRIVER + ERROR_BAD_DRIVER + + + + No documentation. + + + ERROR_INVALID_WINDOW_STYLE + ERROR_INVALID_WINDOW_STYLE + + + + No documentation. + + + ERROR_METAFILE_NOT_SUPPORTED + ERROR_METAFILE_NOT_SUPPORTED + + + + No documentation. + + + ERROR_TRANSFORM_NOT_SUPPORTED + ERROR_TRANSFORM_NOT_SUPPORTED + + + + No documentation. + + + ERROR_CLIPPING_NOT_SUPPORTED + ERROR_CLIPPING_NOT_SUPPORTED + + + + No documentation. + + + ERROR_INVALID_CMM + ERROR_INVALID_CMM + + + + No documentation. + + + ERROR_INVALID_PROFILE + ERROR_INVALID_PROFILE + + + + No documentation. + + + ERROR_TAG_NOT_FOUND + ERROR_TAG_NOT_FOUND + + + + No documentation. + + + ERROR_TAG_NOT_PRESENT + ERROR_TAG_NOT_PRESENT + + + + No documentation. + + + ERROR_DUPLICATE_TAG + ERROR_DUPLICATE_TAG + + + + No documentation. + + + ERROR_PROFILE_NOT_ASSOCIATED_WITH_DEVICE + ERROR_PROFILE_NOT_ASSOCIATED_WITH_DEVICE + + + + No documentation. + + + ERROR_PROFILE_NOT_FOUND + ERROR_PROFILE_NOT_FOUND + + + + No documentation. + + + ERROR_INVALID_COLORSPACE + ERROR_INVALID_COLORSPACE + + + + No documentation. + + + ERROR_ICM_NOT_ENABLED + ERROR_ICM_NOT_ENABLED + + + + No documentation. + + + ERROR_DELETING_ICM_XFORM + ERROR_DELETING_ICM_XFORM + + + + No documentation. + + + ERROR_INVALID_TRANSFORM + ERROR_INVALID_TRANSFORM + + + + No documentation. + + + ERROR_COLORSPACE_MISMATCH + ERROR_COLORSPACE_MISMATCH + + + + No documentation. + + + ERROR_INVALID_COLORINDEX + ERROR_INVALID_COLORINDEX + + + + No documentation. + + + ERROR_PROFILE_DOES_NOT_MATCH_DEVICE + ERROR_PROFILE_DOES_NOT_MATCH_DEVICE + + + + No documentation. + + + ERROR_CONNECTED_OTHER_PASSWORD + ERROR_CONNECTED_OTHER_PASSWORD + + + + No documentation. + + + ERROR_CONNECTED_OTHER_PASSWORD_DEFAULT + ERROR_CONNECTED_OTHER_PASSWORD_DEFAULT + + + + No documentation. + + + ERROR_BAD_USERNAME + ERROR_BAD_USERNAME + + + + No documentation. + + + ERROR_NOT_CONNECTED + ERROR_NOT_CONNECTED + + + + No documentation. + + + ERROR_OPEN_FILES + ERROR_OPEN_FILES + + + + No documentation. + + + ERROR_ACTIVE_CONNECTIONS + ERROR_ACTIVE_CONNECTIONS + + + + No documentation. + + + ERROR_DEVICE_IN_USE + ERROR_DEVICE_IN_USE + + + + No documentation. + + + ERROR_UNKNOWN_PRINT_MONITOR + ERROR_UNKNOWN_PRINT_MONITOR + + + + No documentation. + + + ERROR_PRINTER_DRIVER_IN_USE + ERROR_PRINTER_DRIVER_IN_USE + + + + No documentation. + + + ERROR_SPOOL_FILE_NOT_FOUND + ERROR_SPOOL_FILE_NOT_FOUND + + + + No documentation. + + + ERROR_SPL_NO_STARTDOC + ERROR_SPL_NO_STARTDOC + + + + No documentation. + + + ERROR_SPL_NO_ADDJOB + ERROR_SPL_NO_ADDJOB + + + + No documentation. + + + ERROR_PRINT_PROCESSOR_ALREADY_INSTALLED + ERROR_PRINT_PROCESSOR_ALREADY_INSTALLED + + + + No documentation. + + + ERROR_PRINT_MONITOR_ALREADY_INSTALLED + ERROR_PRINT_MONITOR_ALREADY_INSTALLED + + + + No documentation. + + + ERROR_INVALID_PRINT_MONITOR + ERROR_INVALID_PRINT_MONITOR + + + + No documentation. + + + ERROR_PRINT_MONITOR_IN_USE + ERROR_PRINT_MONITOR_IN_USE + + + + No documentation. + + + ERROR_PRINTER_HAS_JOBS_QUEUED + ERROR_PRINTER_HAS_JOBS_QUEUED + + + + No documentation. + + + ERROR_SUCCESS_REBOOT_REQUIRED + ERROR_SUCCESS_REBOOT_REQUIRED + + + + No documentation. + + + ERROR_SUCCESS_RESTART_REQUIRED + ERROR_SUCCESS_RESTART_REQUIRED + + + + No documentation. + + + ERROR_PRINTER_NOT_FOUND + ERROR_PRINTER_NOT_FOUND + + + + No documentation. + + + ERROR_PRINTER_DRIVER_WARNED + ERROR_PRINTER_DRIVER_WARNED + + + + No documentation. + + + ERROR_PRINTER_DRIVER_BLOCKED + ERROR_PRINTER_DRIVER_BLOCKED + + + + No documentation. + + + ERROR_PRINTER_DRIVER_PACKAGE_IN_USE + ERROR_PRINTER_DRIVER_PACKAGE_IN_USE + + + + No documentation. + + + ERROR_CORE_DRIVER_PACKAGE_NOT_FOUND + ERROR_CORE_DRIVER_PACKAGE_NOT_FOUND + + + + No documentation. + + + ERROR_FAIL_REBOOT_REQUIRED + ERROR_FAIL_REBOOT_REQUIRED + + + + No documentation. + + + ERROR_FAIL_REBOOT_INITIATED + ERROR_FAIL_REBOOT_INITIATED + + + + No documentation. + + + ERROR_PRINTER_DRIVER_DOWNLOAD_NEEDED + ERROR_PRINTER_DRIVER_DOWNLOAD_NEEDED + + + + No documentation. + + + ERROR_PRINT_JOB_RESTART_REQUIRED + ERROR_PRINT_JOB_RESTART_REQUIRED + + + + No documentation. + + + ERROR_IO_REISSUE_AS_CACHED + ERROR_IO_REISSUE_AS_CACHED + + + + No documentation. + + + ERROR_WINS_INTERNAL + ERROR_WINS_INTERNAL + + + + No documentation. + + + ERROR_CAN_NOT_DEL_LOCAL_WINS + ERROR_CAN_NOT_DEL_LOCAL_WINS + + + + No documentation. + + + ERROR_STATIC_INIT + ERROR_STATIC_INIT + + + + No documentation. + + + ERROR_INC_BACKUP + ERROR_INC_BACKUP + + + + No documentation. + + + ERROR_FULL_BACKUP + ERROR_FULL_BACKUP + + + + No documentation. + + + ERROR_REC_NON_EXISTENT + ERROR_REC_NON_EXISTENT + + + + No documentation. + + + ERROR_RPL_NOT_ALLOWED + ERROR_RPL_NOT_ALLOWED + + + + No documentation. + + + ERROR_DHCP_ADDRESS_CONFLICT + ERROR_DHCP_ADDRESS_CONFLICT + + + + No documentation. + + + ERROR_WMI_GUID_NOT_FOUND + ERROR_WMI_GUID_NOT_FOUND + + + + No documentation. + + + ERROR_WMI_INSTANCE_NOT_FOUND + ERROR_WMI_INSTANCE_NOT_FOUND + + + + No documentation. + + + ERROR_WMI_ITEMID_NOT_FOUND + ERROR_WMI_ITEMID_NOT_FOUND + + + + No documentation. + + + ERROR_WMI_TRY_AGAIN + ERROR_WMI_TRY_AGAIN + + + + No documentation. + + + ERROR_WMI_DP_NOT_FOUND + ERROR_WMI_DP_NOT_FOUND + + + + No documentation. + + + ERROR_WMI_UNRESOLVED_INSTANCE_REF + ERROR_WMI_UNRESOLVED_INSTANCE_REF + + + + No documentation. + + + ERROR_WMI_ALREADY_ENABLED + ERROR_WMI_ALREADY_ENABLED + + + + No documentation. + + + ERROR_WMI_GUID_DISCONNECTED + ERROR_WMI_GUID_DISCONNECTED + + + + No documentation. + + + ERROR_WMI_SERVER_UNAVAILABLE + ERROR_WMI_SERVER_UNAVAILABLE + + + + No documentation. + + + ERROR_WMI_DP_FAILED + ERROR_WMI_DP_FAILED + + + + No documentation. + + + ERROR_WMI_INVALID_MOF + ERROR_WMI_INVALID_MOF + + + + No documentation. + + + ERROR_WMI_INVALID_REGINFO + ERROR_WMI_INVALID_REGINFO + + + + No documentation. + + + ERROR_WMI_ALREADY_DISABLED + ERROR_WMI_ALREADY_DISABLED + + + + No documentation. + + + ERROR_WMI_READ_ONLY + ERROR_WMI_READ_ONLY + + + + No documentation. + + + ERROR_WMI_SET_FAILURE + ERROR_WMI_SET_FAILURE + + + + No documentation. + + + ERROR_INVALID_MEDIA + ERROR_INVALID_MEDIA + + + + No documentation. + + + ERROR_INVALID_LIBRARY + ERROR_INVALID_LIBRARY + + + + No documentation. + + + ERROR_INVALID_MEDIA_POOL + ERROR_INVALID_MEDIA_POOL + + + + No documentation. + + + ERROR_DRIVE_MEDIA_MISMATCH + ERROR_DRIVE_MEDIA_MISMATCH + + + + No documentation. + + + ERROR_MEDIA_OFFLINE + ERROR_MEDIA_OFFLINE + + + + No documentation. + + + ERROR_LIBRARY_OFFLINE + ERROR_LIBRARY_OFFLINE + + + + No documentation. + + + ERROR_EMPTY + ERROR_EMPTY + + + + No documentation. + + + ERROR_NOT_EMPTY + ERROR_NOT_EMPTY + + + + No documentation. + + + ERROR_MEDIA_UNAVAILABLE + ERROR_MEDIA_UNAVAILABLE + + + + No documentation. + + + ERROR_RESOURCE_DISABLED + ERROR_RESOURCE_DISABLED + + + + No documentation. + + + ERROR_INVALID_CLEANER + ERROR_INVALID_CLEANER + + + + No documentation. + + + ERROR_UNABLE_TO_CLEAN + ERROR_UNABLE_TO_CLEAN + + + + No documentation. + + + ERROR_OBJECT_NOT_FOUND + ERROR_OBJECT_NOT_FOUND + + + + No documentation. + + + ERROR_DATABASE_FAILURE + ERROR_DATABASE_FAILURE + + + + No documentation. + + + ERROR_DATABASE_FULL + ERROR_DATABASE_FULL + + + + No documentation. + + + ERROR_MEDIA_INCOMPATIBLE + ERROR_MEDIA_INCOMPATIBLE + + + + No documentation. + + + ERROR_RESOURCE_NOT_PRESENT + ERROR_RESOURCE_NOT_PRESENT + + + + No documentation. + + + ERROR_INVALID_OPERATION + ERROR_INVALID_OPERATION + + + + No documentation. + + + ERROR_MEDIA_NOT_AVAILABLE + ERROR_MEDIA_NOT_AVAILABLE + + + + No documentation. + + + ERROR_DEVICE_NOT_AVAILABLE + ERROR_DEVICE_NOT_AVAILABLE + + + + No documentation. + + + ERROR_REQUEST_REFUSED + ERROR_REQUEST_REFUSED + + + + No documentation. + + + ERROR_INVALID_DRIVE_OBJECT + ERROR_INVALID_DRIVE_OBJECT + + + + No documentation. + + + ERROR_LIBRARY_FULL + ERROR_LIBRARY_FULL + + + + No documentation. + + + ERROR_MEDIUM_NOT_ACCESSIBLE + ERROR_MEDIUM_NOT_ACCESSIBLE + + + + No documentation. + + + ERROR_UNABLE_TO_LOAD_MEDIUM + ERROR_UNABLE_TO_LOAD_MEDIUM + + + + No documentation. + + + ERROR_UNABLE_TO_INVENTORY_DRIVE + ERROR_UNABLE_TO_INVENTORY_DRIVE + + + + No documentation. + + + ERROR_UNABLE_TO_INVENTORY_SLOT + ERROR_UNABLE_TO_INVENTORY_SLOT + + + + No documentation. + + + ERROR_UNABLE_TO_INVENTORY_TRANSPORT + ERROR_UNABLE_TO_INVENTORY_TRANSPORT + + + + No documentation. + + + ERROR_TRANSPORT_FULL + ERROR_TRANSPORT_FULL + + + + No documentation. + + + ERROR_CONTROLLING_IEPORT + ERROR_CONTROLLING_IEPORT + + + + No documentation. + + + ERROR_UNABLE_TO_EJECT_MOUNTED_MEDIA + ERROR_UNABLE_TO_EJECT_MOUNTED_MEDIA + + + + No documentation. + + + ERROR_CLEANER_SLOT_SET + ERROR_CLEANER_SLOT_SET + + + + No documentation. + + + ERROR_CLEANER_SLOT_NOT_SET + ERROR_CLEANER_SLOT_NOT_SET + + + + No documentation. + + + ERROR_CLEANER_CARTRIDGE_SPENT + ERROR_CLEANER_CARTRIDGE_SPENT + + + + No documentation. + + + ERROR_UNEXPECTED_OMID + ERROR_UNEXPECTED_OMID + + + + No documentation. + + + ERROR_CANT_DELETE_LAST_ITEM + ERROR_CANT_DELETE_LAST_ITEM + + + + No documentation. + + + ERROR_MESSAGE_EXCEEDS_MAX_SIZE + ERROR_MESSAGE_EXCEEDS_MAX_SIZE + + + + No documentation. + + + ERROR_VOLUME_CONTAINS_SYS_FILES + ERROR_VOLUME_CONTAINS_SYS_FILES + + + + No documentation. + + + ERROR_INDIGENOUS_TYPE + ERROR_INDIGENOUS_TYPE + + + + No documentation. + + + ERROR_NO_SUPPORTING_DRIVES + ERROR_NO_SUPPORTING_DRIVES + + + + No documentation. + + + ERROR_CLEANER_CARTRIDGE_INSTALLED + ERROR_CLEANER_CARTRIDGE_INSTALLED + + + + No documentation. + + + ERROR_IEPORT_FULL + ERROR_IEPORT_FULL + + + + No documentation. + + + ERROR_FILE_OFFLINE + ERROR_FILE_OFFLINE + + + + No documentation. + + + ERROR_REMOTE_STORAGE_NOT_ACTIVE + ERROR_REMOTE_STORAGE_NOT_ACTIVE + + + + No documentation. + + + ERROR_REMOTE_STORAGE_MEDIA_ERROR + ERROR_REMOTE_STORAGE_MEDIA_ERROR + + + + No documentation. + + + ERROR_NOT_A_REPARSE_POINT + ERROR_NOT_A_REPARSE_POINT + + + + No documentation. + + + ERROR_REPARSE_ATTRIBUTE_CONFLICT + ERROR_REPARSE_ATTRIBUTE_CONFLICT + + + + No documentation. + + + ERROR_INVALID_REPARSE_DATA + ERROR_INVALID_REPARSE_DATA + + + + No documentation. + + + ERROR_REPARSE_TAG_INVALID + ERROR_REPARSE_TAG_INVALID + + + + No documentation. + + + ERROR_REPARSE_TAG_MISMATCH + ERROR_REPARSE_TAG_MISMATCH + + + + No documentation. + + + ERROR_VOLUME_NOT_SIS_ENABLED + ERROR_VOLUME_NOT_SIS_ENABLED + + + + No documentation. + + + ERROR_DEPENDENT_RESOURCE_EXISTS + ERROR_DEPENDENT_RESOURCE_EXISTS + + + + No documentation. + + + ERROR_DEPENDENCY_NOT_FOUND + ERROR_DEPENDENCY_NOT_FOUND + + + + No documentation. + + + ERROR_DEPENDENCY_ALREADY_EXISTS + ERROR_DEPENDENCY_ALREADY_EXISTS + + + + No documentation. + + + ERROR_RESOURCE_NOT_ONLINE + ERROR_RESOURCE_NOT_ONLINE + + + + No documentation. + + + ERROR_HOST_NODE_NOT_AVAILABLE + ERROR_HOST_NODE_NOT_AVAILABLE + + + + No documentation. + + + ERROR_RESOURCE_NOT_AVAILABLE + ERROR_RESOURCE_NOT_AVAILABLE + + + + No documentation. + + + ERROR_RESOURCE_NOT_FOUND + ERROR_RESOURCE_NOT_FOUND + + + + No documentation. + + + ERROR_SHUTDOWN_CLUSTER + ERROR_SHUTDOWN_CLUSTER + + + + No documentation. + + + ERROR_CANT_EVICT_ACTIVE_NODE + ERROR_CANT_EVICT_ACTIVE_NODE + + + + No documentation. + + + ERROR_OBJECT_ALREADY_EXISTS + ERROR_OBJECT_ALREADY_EXISTS + + + + No documentation. + + + ERROR_OBJECT_IN_LIST + ERROR_OBJECT_IN_LIST + + + + No documentation. + + + ERROR_GROUP_NOT_AVAILABLE + ERROR_GROUP_NOT_AVAILABLE + + + + No documentation. + + + ERROR_GROUP_NOT_FOUND + ERROR_GROUP_NOT_FOUND + + + + No documentation. + + + ERROR_GROUP_NOT_ONLINE + ERROR_GROUP_NOT_ONLINE + + + + No documentation. + + + ERROR_HOST_NODE_NOT_RESOURCE_OWNER + ERROR_HOST_NODE_NOT_RESOURCE_OWNER + + + + No documentation. + + + ERROR_HOST_NODE_NOT_GROUP_OWNER + ERROR_HOST_NODE_NOT_GROUP_OWNER + + + + No documentation. + + + ERROR_RESMON_CREATE_FAILED + ERROR_RESMON_CREATE_FAILED + + + + No documentation. + + + ERROR_RESMON_ONLINE_FAILED + ERROR_RESMON_ONLINE_FAILED + + + + No documentation. + + + ERROR_RESOURCE_ONLINE + ERROR_RESOURCE_ONLINE + + + + No documentation. + + + ERROR_QUORUM_RESOURCE + ERROR_QUORUM_RESOURCE + + + + No documentation. + + + ERROR_NOT_QUORUM_CAPABLE + ERROR_NOT_QUORUM_CAPABLE + + + + No documentation. + + + ERROR_CLUSTER_SHUTTING_DOWN + ERROR_CLUSTER_SHUTTING_DOWN + + + + No documentation. + + + ERROR_INVALID_STATE + ERROR_INVALID_STATE + + + + No documentation. + + + ERROR_RESOURCE_PROPERTIES_STORED + ERROR_RESOURCE_PROPERTIES_STORED + + + + No documentation. + + + ERROR_NOT_QUORUM_CLASS + ERROR_NOT_QUORUM_CLASS + + + + No documentation. + + + ERROR_CORE_RESOURCE + ERROR_CORE_RESOURCE + + + + No documentation. + + + ERROR_QUORUM_RESOURCE_ONLINE_FAILED + ERROR_QUORUM_RESOURCE_ONLINE_FAILED + + + + No documentation. + + + ERROR_QUORUMLOG_OPEN_FAILED + ERROR_QUORUMLOG_OPEN_FAILED + + + + No documentation. + + + ERROR_CLUSTERLOG_CORRUPT + ERROR_CLUSTERLOG_CORRUPT + + + + No documentation. + + + ERROR_CLUSTERLOG_RECORD_EXCEEDS_MAXSIZE + ERROR_CLUSTERLOG_RECORD_EXCEEDS_MAXSIZE + + + + No documentation. + + + ERROR_CLUSTERLOG_EXCEEDS_MAXSIZE + ERROR_CLUSTERLOG_EXCEEDS_MAXSIZE + + + + No documentation. + + + ERROR_CLUSTERLOG_CHKPOINT_NOT_FOUND + ERROR_CLUSTERLOG_CHKPOINT_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTERLOG_NOT_ENOUGH_SPACE + ERROR_CLUSTERLOG_NOT_ENOUGH_SPACE + + + + No documentation. + + + ERROR_QUORUM_OWNER_ALIVE + ERROR_QUORUM_OWNER_ALIVE + + + + No documentation. + + + ERROR_NETWORK_NOT_AVAILABLE + ERROR_NETWORK_NOT_AVAILABLE + + + + No documentation. + + + ERROR_NODE_NOT_AVAILABLE + ERROR_NODE_NOT_AVAILABLE + + + + No documentation. + + + ERROR_ALL_NODES_NOT_AVAILABLE + ERROR_ALL_NODES_NOT_AVAILABLE + + + + No documentation. + + + ERROR_RESOURCE_FAILED + ERROR_RESOURCE_FAILED + + + + No documentation. + + + ERROR_CLUSTER_INVALID_NODE + ERROR_CLUSTER_INVALID_NODE + + + + No documentation. + + + ERROR_CLUSTER_NODE_EXISTS + ERROR_CLUSTER_NODE_EXISTS + + + + No documentation. + + + ERROR_CLUSTER_JOIN_IN_PROGRESS + ERROR_CLUSTER_JOIN_IN_PROGRESS + + + + No documentation. + + + ERROR_CLUSTER_NODE_NOT_FOUND + ERROR_CLUSTER_NODE_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTER_LOCAL_NODE_NOT_FOUND + ERROR_CLUSTER_LOCAL_NODE_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTER_NETWORK_EXISTS + ERROR_CLUSTER_NETWORK_EXISTS + + + + No documentation. + + + ERROR_CLUSTER_NETWORK_NOT_FOUND + ERROR_CLUSTER_NETWORK_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTER_NETINTERFACE_EXISTS + ERROR_CLUSTER_NETINTERFACE_EXISTS + + + + No documentation. + + + ERROR_CLUSTER_NETINTERFACE_NOT_FOUND + ERROR_CLUSTER_NETINTERFACE_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTER_INVALID_REQUEST + ERROR_CLUSTER_INVALID_REQUEST + + + + No documentation. + + + ERROR_CLUSTER_INVALID_NETWORK_PROVIDER + ERROR_CLUSTER_INVALID_NETWORK_PROVIDER + + + + No documentation. + + + ERROR_CLUSTER_NODE_DOWN + ERROR_CLUSTER_NODE_DOWN + + + + No documentation. + + + ERROR_CLUSTER_NODE_UNREACHABLE + ERROR_CLUSTER_NODE_UNREACHABLE + + + + No documentation. + + + ERROR_CLUSTER_NODE_NOT_MEMBER + ERROR_CLUSTER_NODE_NOT_MEMBER + + + + No documentation. + + + ERROR_CLUSTER_JOIN_NOT_IN_PROGRESS + ERROR_CLUSTER_JOIN_NOT_IN_PROGRESS + + + + No documentation. + + + ERROR_CLUSTER_INVALID_NETWORK + ERROR_CLUSTER_INVALID_NETWORK + + + + No documentation. + + + ERROR_CLUSTER_NODE_UP + ERROR_CLUSTER_NODE_UP + + + + No documentation. + + + ERROR_CLUSTER_IPADDR_IN_USE + ERROR_CLUSTER_IPADDR_IN_USE + + + + No documentation. + + + ERROR_CLUSTER_NODE_NOT_PAUSED + ERROR_CLUSTER_NODE_NOT_PAUSED + + + + No documentation. + + + ERROR_CLUSTER_NO_SECURITY_CONTEXT + ERROR_CLUSTER_NO_SECURITY_CONTEXT + + + + No documentation. + + + ERROR_CLUSTER_NETWORK_NOT_INTERNAL + ERROR_CLUSTER_NETWORK_NOT_INTERNAL + + + + No documentation. + + + ERROR_CLUSTER_NODE_ALREADY_UP + ERROR_CLUSTER_NODE_ALREADY_UP + + + + No documentation. + + + ERROR_CLUSTER_NODE_ALREADY_DOWN + ERROR_CLUSTER_NODE_ALREADY_DOWN + + + + No documentation. + + + ERROR_CLUSTER_NETWORK_ALREADY_ONLINE + ERROR_CLUSTER_NETWORK_ALREADY_ONLINE + + + + No documentation. + + + ERROR_CLUSTER_NETWORK_ALREADY_OFFLINE + ERROR_CLUSTER_NETWORK_ALREADY_OFFLINE + + + + No documentation. + + + ERROR_CLUSTER_NODE_ALREADY_MEMBER + ERROR_CLUSTER_NODE_ALREADY_MEMBER + + + + No documentation. + + + ERROR_CLUSTER_LAST_INTERNAL_NETWORK + ERROR_CLUSTER_LAST_INTERNAL_NETWORK + + + + No documentation. + + + ERROR_CLUSTER_NETWORK_HAS_DEPENDENTS + ERROR_CLUSTER_NETWORK_HAS_DEPENDENTS + + + + No documentation. + + + ERROR_INVALID_OPERATION_ON_QUORUM + ERROR_INVALID_OPERATION_ON_QUORUM + + + + No documentation. + + + ERROR_DEPENDENCY_NOT_ALLOWED + ERROR_DEPENDENCY_NOT_ALLOWED + + + + No documentation. + + + ERROR_CLUSTER_NODE_PAUSED + ERROR_CLUSTER_NODE_PAUSED + + + + No documentation. + + + ERROR_NODE_CANT_HOST_RESOURCE + ERROR_NODE_CANT_HOST_RESOURCE + + + + No documentation. + + + ERROR_CLUSTER_NODE_NOT_READY + ERROR_CLUSTER_NODE_NOT_READY + + + + No documentation. + + + ERROR_CLUSTER_NODE_SHUTTING_DOWN + ERROR_CLUSTER_NODE_SHUTTING_DOWN + + + + No documentation. + + + ERROR_CLUSTER_JOIN_ABORTED + ERROR_CLUSTER_JOIN_ABORTED + + + + No documentation. + + + ERROR_CLUSTER_INCOMPATIBLE_VERSIONS + ERROR_CLUSTER_INCOMPATIBLE_VERSIONS + + + + No documentation. + + + ERROR_CLUSTER_MAXNUM_OF_RESOURCES_EXCEEDED + ERROR_CLUSTER_MAXNUM_OF_RESOURCES_EXCEEDED + + + + No documentation. + + + ERROR_CLUSTER_SYSTEM_CONFIG_CHANGED + ERROR_CLUSTER_SYSTEM_CONFIG_CHANGED + + + + No documentation. + + + ERROR_CLUSTER_RESOURCE_TYPE_NOT_FOUND + ERROR_CLUSTER_RESOURCE_TYPE_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTER_RESTYPE_NOT_SUPPORTED + ERROR_CLUSTER_RESTYPE_NOT_SUPPORTED + + + + No documentation. + + + ERROR_CLUSTER_RESNAME_NOT_FOUND + ERROR_CLUSTER_RESNAME_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTER_NO_RPC_PACKAGES_REGISTERED + ERROR_CLUSTER_NO_RPC_PACKAGES_REGISTERED + + + + No documentation. + + + ERROR_CLUSTER_OWNER_NOT_IN_PREFLIST + ERROR_CLUSTER_OWNER_NOT_IN_PREFLIST + + + + No documentation. + + + ERROR_CLUSTER_DATABASE_SEQMISMATCH + ERROR_CLUSTER_DATABASE_SEQMISMATCH + + + + No documentation. + + + ERROR_RESMON_INVALID_STATE + ERROR_RESMON_INVALID_STATE + + + + No documentation. + + + ERROR_CLUSTER_GUM_NOT_LOCKER + ERROR_CLUSTER_GUM_NOT_LOCKER + + + + No documentation. + + + ERROR_QUORUM_DISK_NOT_FOUND + ERROR_QUORUM_DISK_NOT_FOUND + + + + No documentation. + + + ERROR_DATABASE_BACKUP_CORRUPT + ERROR_DATABASE_BACKUP_CORRUPT + + + + No documentation. + + + ERROR_CLUSTER_NODE_ALREADY_HAS_DFS_ROOT + ERROR_CLUSTER_NODE_ALREADY_HAS_DFS_ROOT + + + + No documentation. + + + ERROR_RESOURCE_PROPERTY_UNCHANGEABLE + ERROR_RESOURCE_PROPERTY_UNCHANGEABLE + + + + No documentation. + + + ERROR_CLUSTER_MEMBERSHIP_INVALID_STATE + ERROR_CLUSTER_MEMBERSHIP_INVALID_STATE + + + + No documentation. + + + ERROR_CLUSTER_QUORUMLOG_NOT_FOUND + ERROR_CLUSTER_QUORUMLOG_NOT_FOUND + + + + No documentation. + + + ERROR_CLUSTER_MEMBERSHIP_HALT + ERROR_CLUSTER_MEMBERSHIP_HALT + + + + No documentation. + + + ERROR_CLUSTER_INSTANCE_ID_MISMATCH + ERROR_CLUSTER_INSTANCE_ID_MISMATCH + + + + No documentation. + + + ERROR_CLUSTER_NETWORK_NOT_FOUND_FOR_IP + ERROR_CLUSTER_NETWORK_NOT_FOUND_FOR_IP + + + + No documentation. + + + ERROR_CLUSTER_PROPERTY_DATA_TYPE_MISMATCH + ERROR_CLUSTER_PROPERTY_DATA_TYPE_MISMATCH + + + + No documentation. + + + ERROR_CLUSTER_EVICT_WITHOUT_CLEANUP + ERROR_CLUSTER_EVICT_WITHOUT_CLEANUP + + + + No documentation. + + + ERROR_CLUSTER_PARAMETER_MISMATCH + ERROR_CLUSTER_PARAMETER_MISMATCH + + + + No documentation. + + + ERROR_NODE_CANNOT_BE_CLUSTERED + ERROR_NODE_CANNOT_BE_CLUSTERED + + + + No documentation. + + + ERROR_CLUSTER_WRONG_OS_VERSION + ERROR_CLUSTER_WRONG_OS_VERSION + + + + No documentation. + + + ERROR_CLUSTER_CANT_CREATE_DUP_CLUSTER_NAME + ERROR_CLUSTER_CANT_CREATE_DUP_CLUSTER_NAME + + + + No documentation. + + + ERROR_CLUSCFG_ALREADY_COMMITTED + ERROR_CLUSCFG_ALREADY_COMMITTED + + + + No documentation. + + + ERROR_CLUSCFG_ROLLBACK_FAILED + ERROR_CLUSCFG_ROLLBACK_FAILED + + + + No documentation. + + + ERROR_CLUSCFG_SYSTEM_DISK_DRIVE_LETTER_CONFLICT + ERROR_CLUSCFG_SYSTEM_DISK_DRIVE_LETTER_CONFLICT + + + + No documentation. + + + ERROR_CLUSTER_OLD_VERSION + ERROR_CLUSTER_OLD_VERSION + + + + No documentation. + + + ERROR_CLUSTER_MISMATCHED_COMPUTER_ACCT_NAME + ERROR_CLUSTER_MISMATCHED_COMPUTER_ACCT_NAME + + + + No documentation. + + + ERROR_CLUSTER_NO_NET_ADAPTERS + ERROR_CLUSTER_NO_NET_ADAPTERS + + + + No documentation. + + + ERROR_CLUSTER_POISONED + ERROR_CLUSTER_POISONED + + + + No documentation. + + + ERROR_CLUSTER_GROUP_MOVING + ERROR_CLUSTER_GROUP_MOVING + + + + No documentation. + + + ERROR_CLUSTER_RESOURCE_TYPE_BUSY + ERROR_CLUSTER_RESOURCE_TYPE_BUSY + + + + No documentation. + + + ERROR_RESOURCE_CALL_TIMED_OUT + ERROR_RESOURCE_CALL_TIMED_OUT + + + + No documentation. + + + ERROR_INVALID_CLUSTER_IPV6_ADDRESS + ERROR_INVALID_CLUSTER_IPV6_ADDRESS + + + + No documentation. + + + ERROR_CLUSTER_INTERNAL_INVALID_FUNCTION + ERROR_CLUSTER_INTERNAL_INVALID_FUNCTION + + + + No documentation. + + + ERROR_CLUSTER_PARAMETER_OUT_OF_BOUNDS + ERROR_CLUSTER_PARAMETER_OUT_OF_BOUNDS + + + + No documentation. + + + ERROR_CLUSTER_PARTIAL_SEND + ERROR_CLUSTER_PARTIAL_SEND + + + + No documentation. + + + ERROR_CLUSTER_REGISTRY_INVALID_FUNCTION + ERROR_CLUSTER_REGISTRY_INVALID_FUNCTION + + + + No documentation. + + + ERROR_CLUSTER_INVALID_STRING_TERMINATION + ERROR_CLUSTER_INVALID_STRING_TERMINATION + + + + No documentation. + + + ERROR_CLUSTER_INVALID_STRING_FORMAT + ERROR_CLUSTER_INVALID_STRING_FORMAT + + + + No documentation. + + + ERROR_CLUSTER_DATABASE_TRANSACTION_IN_PROGRESS + ERROR_CLUSTER_DATABASE_TRANSACTION_IN_PROGRESS + + + + No documentation. + + + ERROR_CLUSTER_DATABASE_TRANSACTION_NOT_IN_PROGRESS + ERROR_CLUSTER_DATABASE_TRANSACTION_NOT_IN_PROGRESS + + + + No documentation. + + + ERROR_CLUSTER_NULL_DATA + ERROR_CLUSTER_NULL_DATA + + + + No documentation. + + + ERROR_CLUSTER_PARTIAL_READ + ERROR_CLUSTER_PARTIAL_READ + + + + No documentation. + + + ERROR_CLUSTER_PARTIAL_WRITE + ERROR_CLUSTER_PARTIAL_WRITE + + + + No documentation. + + + ERROR_CLUSTER_CANT_DESERIALIZE_DATA + ERROR_CLUSTER_CANT_DESERIALIZE_DATA + + + + No documentation. + + + ERROR_DEPENDENT_RESOURCE_PROPERTY_CONFLICT + ERROR_DEPENDENT_RESOURCE_PROPERTY_CONFLICT + + + + No documentation. + + + ERROR_CLUSTER_NO_QUORUM + ERROR_CLUSTER_NO_QUORUM + + + + No documentation. + + + ERROR_CLUSTER_INVALID_IPV6_NETWORK + ERROR_CLUSTER_INVALID_IPV6_NETWORK + + + + No documentation. + + + ERROR_CLUSTER_INVALID_IPV6_TUNNEL_NETWORK + ERROR_CLUSTER_INVALID_IPV6_TUNNEL_NETWORK + + + + No documentation. + + + ERROR_QUORUM_NOT_ALLOWED_IN_THIS_GROUP + ERROR_QUORUM_NOT_ALLOWED_IN_THIS_GROUP + + + + No documentation. + + + ERROR_DEPENDENCY_TREE_TOO_COMPLEX + ERROR_DEPENDENCY_TREE_TOO_COMPLEX + + + + No documentation. + + + ERROR_EXCEPTION_IN_RESOURCE_CALL + ERROR_EXCEPTION_IN_RESOURCE_CALL + + + + No documentation. + + + ERROR_CLUSTER_RHS_FAILED_INITIALIZATION + ERROR_CLUSTER_RHS_FAILED_INITIALIZATION + + + + No documentation. + + + ERROR_CLUSTER_NOT_INSTALLED + ERROR_CLUSTER_NOT_INSTALLED + + + + No documentation. + + + ERROR_CLUSTER_RESOURCES_MUST_BE_ONLINE_ON_THE_SAME_NODE + ERROR_CLUSTER_RESOURCES_MUST_BE_ONLINE_ON_THE_SAME_NODE + + + + No documentation. + + + ERROR_CLUSTER_MAX_NODES_IN_CLUSTER + ERROR_CLUSTER_MAX_NODES_IN_CLUSTER + + + + No documentation. + + + ERROR_CLUSTER_TOO_MANY_NODES + ERROR_CLUSTER_TOO_MANY_NODES + + + + No documentation. + + + ERROR_CLUSTER_OBJECT_ALREADY_USED + ERROR_CLUSTER_OBJECT_ALREADY_USED + + + + No documentation. + + + ERROR_NONCORE_GROUPS_FOUND + ERROR_NONCORE_GROUPS_FOUND + + + + No documentation. + + + ERROR_FILE_SHARE_RESOURCE_CONFLICT + ERROR_FILE_SHARE_RESOURCE_CONFLICT + + + + No documentation. + + + ERROR_CLUSTER_EVICT_INVALID_REQUEST + ERROR_CLUSTER_EVICT_INVALID_REQUEST + + + + No documentation. + + + ERROR_CLUSTER_SINGLETON_RESOURCE + ERROR_CLUSTER_SINGLETON_RESOURCE + + + + No documentation. + + + ERROR_CLUSTER_GROUP_SINGLETON_RESOURCE + ERROR_CLUSTER_GROUP_SINGLETON_RESOURCE + + + + No documentation. + + + ERROR_CLUSTER_RESOURCE_PROVIDER_FAILED + ERROR_CLUSTER_RESOURCE_PROVIDER_FAILED + + + + No documentation. + + + ERROR_CLUSTER_RESOURCE_CONFIGURATION_ERROR + ERROR_CLUSTER_RESOURCE_CONFIGURATION_ERROR + + + + No documentation. + + + ERROR_CLUSTER_GROUP_BUSY + ERROR_CLUSTER_GROUP_BUSY + + + + No documentation. + + + ERROR_CLUSTER_NOT_SHARED_VOLUME + ERROR_CLUSTER_NOT_SHARED_VOLUME + + + + No documentation. + + + ERROR_CLUSTER_INVALID_SECURITY_DESCRIPTOR + ERROR_CLUSTER_INVALID_SECURITY_DESCRIPTOR + + + + No documentation. + + + ERROR_CLUSTER_SHARED_VOLUMES_IN_USE + ERROR_CLUSTER_SHARED_VOLUMES_IN_USE + + + + No documentation. + + + ERROR_CLUSTER_USE_SHARED_VOLUMES_API + ERROR_CLUSTER_USE_SHARED_VOLUMES_API + + + + No documentation. + + + ERROR_CLUSTER_BACKUP_IN_PROGRESS + ERROR_CLUSTER_BACKUP_IN_PROGRESS + + + + No documentation. + + + ERROR_NON_CSV_PATH + ERROR_NON_CSV_PATH + + + + No documentation. + + + ERROR_CSV_VOLUME_NOT_LOCAL + ERROR_CSV_VOLUME_NOT_LOCAL + + + + No documentation. + + + ERROR_CLUSTER_WATCHDOG_TERMINATING + ERROR_CLUSTER_WATCHDOG_TERMINATING + + + + No documentation. + + + ERROR_ENCRYPTION_FAILED + ERROR_ENCRYPTION_FAILED + + + + No documentation. + + + ERROR_DECRYPTION_FAILED + ERROR_DECRYPTION_FAILED + + + + No documentation. + + + ERROR_FILE_ENCRYPTED + ERROR_FILE_ENCRYPTED + + + + No documentation. + + + ERROR_NO_RECOVERY_POLICY + ERROR_NO_RECOVERY_POLICY + + + + No documentation. + + + ERROR_NO_EFS + ERROR_NO_EFS + + + + No documentation. + + + ERROR_WRONG_EFS + ERROR_WRONG_EFS + + + + No documentation. + + + ERROR_NO_USER_KEYS + ERROR_NO_USER_KEYS + + + + No documentation. + + + ERROR_FILE_NOT_ENCRYPTED + ERROR_FILE_NOT_ENCRYPTED + + + + No documentation. + + + ERROR_NOT_EXPORT_FORMAT + ERROR_NOT_EXPORT_FORMAT + + + + No documentation. + + + ERROR_FILE_READ_ONLY + ERROR_FILE_READ_ONLY + + + + No documentation. + + + ERROR_DIR_EFS_DISALLOWED + ERROR_DIR_EFS_DISALLOWED + + + + No documentation. + + + ERROR_EFS_SERVER_NOT_TRUSTED + ERROR_EFS_SERVER_NOT_TRUSTED + + + + No documentation. + + + ERROR_BAD_RECOVERY_POLICY + ERROR_BAD_RECOVERY_POLICY + + + + No documentation. + + + ERROR_EFS_ALG_BLOB_TOO_BIG + ERROR_EFS_ALG_BLOB_TOO_BIG + + + + No documentation. + + + ERROR_VOLUME_NOT_SUPPORT_EFS + ERROR_VOLUME_NOT_SUPPORT_EFS + + + + No documentation. + + + ERROR_EFS_DISABLED + ERROR_EFS_DISABLED + + + + No documentation. + + + ERROR_EFS_VERSION_NOT_SUPPORT + ERROR_EFS_VERSION_NOT_SUPPORT + + + + No documentation. + + + ERROR_CS_ENCRYPTION_INVALID_SERVER_RESPONSE + ERROR_CS_ENCRYPTION_INVALID_SERVER_RESPONSE + + + + No documentation. + + + ERROR_CS_ENCRYPTION_UNSUPPORTED_SERVER + ERROR_CS_ENCRYPTION_UNSUPPORTED_SERVER + + + + No documentation. + + + ERROR_CS_ENCRYPTION_EXISTING_ENCRYPTED_FILE + ERROR_CS_ENCRYPTION_EXISTING_ENCRYPTED_FILE + + + + No documentation. + + + ERROR_CS_ENCRYPTION_NEW_ENCRYPTED_FILE + ERROR_CS_ENCRYPTION_NEW_ENCRYPTED_FILE + + + + No documentation. + + + ERROR_CS_ENCRYPTION_FILE_NOT_CSE + ERROR_CS_ENCRYPTION_FILE_NOT_CSE + + + + No documentation. + + + ERROR_ENCRYPTION_POLICY_DENIES_OPERATION + ERROR_ENCRYPTION_POLICY_DENIES_OPERATION + + + + No documentation. + + + ERROR_NO_BROWSER_SERVERS_FOUND + ERROR_NO_BROWSER_SERVERS_FOUND + + + + No documentation. + + + ERROR_LOG_SECTOR_INVALID + ERROR_LOG_SECTOR_INVALID + + + + No documentation. + + + ERROR_LOG_SECTOR_PARITY_INVALID + ERROR_LOG_SECTOR_PARITY_INVALID + + + + No documentation. + + + ERROR_LOG_SECTOR_REMAPPED + ERROR_LOG_SECTOR_REMAPPED + + + + No documentation. + + + ERROR_LOG_BLOCK_INCOMPLETE + ERROR_LOG_BLOCK_INCOMPLETE + + + + No documentation. + + + ERROR_LOG_INVALID_RANGE + ERROR_LOG_INVALID_RANGE + + + + No documentation. + + + ERROR_LOG_BLOCKS_EXHAUSTED + ERROR_LOG_BLOCKS_EXHAUSTED + + + + No documentation. + + + ERROR_LOG_READ_CONTEXT_INVALID + ERROR_LOG_READ_CONTEXT_INVALID + + + + No documentation. + + + ERROR_LOG_RESTART_INVALID + ERROR_LOG_RESTART_INVALID + + + + No documentation. + + + ERROR_LOG_BLOCK_VERSION + ERROR_LOG_BLOCK_VERSION + + + + No documentation. + + + ERROR_LOG_BLOCK_INVALID + ERROR_LOG_BLOCK_INVALID + + + + No documentation. + + + ERROR_LOG_READ_MODE_INVALID + ERROR_LOG_READ_MODE_INVALID + + + + No documentation. + + + ERROR_LOG_NO_RESTART + ERROR_LOG_NO_RESTART + + + + No documentation. + + + ERROR_LOG_METADATA_CORRUPT + ERROR_LOG_METADATA_CORRUPT + + + + No documentation. + + + ERROR_LOG_METADATA_INVALID + ERROR_LOG_METADATA_INVALID + + + + No documentation. + + + ERROR_LOG_METADATA_INCONSISTENT + ERROR_LOG_METADATA_INCONSISTENT + + + + No documentation. + + + ERROR_LOG_RESERVATION_INVALID + ERROR_LOG_RESERVATION_INVALID + + + + No documentation. + + + ERROR_LOG_CANT_DELETE + ERROR_LOG_CANT_DELETE + + + + No documentation. + + + ERROR_LOG_CONTAINER_LIMIT_EXCEEDED + ERROR_LOG_CONTAINER_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_LOG_START_OF_LOG + ERROR_LOG_START_OF_LOG + + + + No documentation. + + + ERROR_LOG_POLICY_ALREADY_INSTALLED + ERROR_LOG_POLICY_ALREADY_INSTALLED + + + + No documentation. + + + ERROR_LOG_POLICY_NOT_INSTALLED + ERROR_LOG_POLICY_NOT_INSTALLED + + + + No documentation. + + + ERROR_LOG_POLICY_INVALID + ERROR_LOG_POLICY_INVALID + + + + No documentation. + + + ERROR_LOG_POLICY_CONFLICT + ERROR_LOG_POLICY_CONFLICT + + + + No documentation. + + + ERROR_LOG_PINNED_ARCHIVE_TAIL + ERROR_LOG_PINNED_ARCHIVE_TAIL + + + + No documentation. + + + ERROR_LOG_RECORD_NONEXISTENT + ERROR_LOG_RECORD_NONEXISTENT + + + + No documentation. + + + ERROR_LOG_RECORDS_RESERVED_INVALID + ERROR_LOG_RECORDS_RESERVED_INVALID + + + + No documentation. + + + ERROR_LOG_SPACE_RESERVED_INVALID + ERROR_LOG_SPACE_RESERVED_INVALID + + + + No documentation. + + + ERROR_LOG_TAIL_INVALID + ERROR_LOG_TAIL_INVALID + + + + No documentation. + + + ERROR_LOG_FULL + ERROR_LOG_FULL + + + + No documentation. + + + ERROR_COULD_NOT_RESIZE_LOG + ERROR_COULD_NOT_RESIZE_LOG + + + + No documentation. + + + ERROR_LOG_MULTIPLEXED + ERROR_LOG_MULTIPLEXED + + + + No documentation. + + + ERROR_LOG_DEDICATED + ERROR_LOG_DEDICATED + + + + No documentation. + + + ERROR_LOG_ARCHIVE_NOT_IN_PROGRESS + ERROR_LOG_ARCHIVE_NOT_IN_PROGRESS + + + + No documentation. + + + ERROR_LOG_ARCHIVE_IN_PROGRESS + ERROR_LOG_ARCHIVE_IN_PROGRESS + + + + No documentation. + + + ERROR_LOG_EPHEMERAL + ERROR_LOG_EPHEMERAL + + + + No documentation. + + + ERROR_LOG_NOT_ENOUGH_CONTAINERS + ERROR_LOG_NOT_ENOUGH_CONTAINERS + + + + No documentation. + + + ERROR_LOG_CLIENT_ALREADY_REGISTERED + ERROR_LOG_CLIENT_ALREADY_REGISTERED + + + + No documentation. + + + ERROR_LOG_CLIENT_NOT_REGISTERED + ERROR_LOG_CLIENT_NOT_REGISTERED + + + + No documentation. + + + ERROR_LOG_FULL_HANDLER_IN_PROGRESS + ERROR_LOG_FULL_HANDLER_IN_PROGRESS + + + + No documentation. + + + ERROR_LOG_CONTAINER_READ_FAILED + ERROR_LOG_CONTAINER_READ_FAILED + + + + No documentation. + + + ERROR_LOG_CONTAINER_WRITE_FAILED + ERROR_LOG_CONTAINER_WRITE_FAILED + + + + No documentation. + + + ERROR_LOG_CONTAINER_OPEN_FAILED + ERROR_LOG_CONTAINER_OPEN_FAILED + + + + No documentation. + + + ERROR_LOG_CONTAINER_STATE_INVALID + ERROR_LOG_CONTAINER_STATE_INVALID + + + + No documentation. + + + ERROR_LOG_STATE_INVALID + ERROR_LOG_STATE_INVALID + + + + No documentation. + + + ERROR_LOG_PINNED + ERROR_LOG_PINNED + + + + No documentation. + + + ERROR_LOG_METADATA_FLUSH_FAILED + ERROR_LOG_METADATA_FLUSH_FAILED + + + + No documentation. + + + ERROR_LOG_INCONSISTENT_SECURITY + ERROR_LOG_INCONSISTENT_SECURITY + + + + No documentation. + + + ERROR_LOG_APPENDED_FLUSH_FAILED + ERROR_LOG_APPENDED_FLUSH_FAILED + + + + No documentation. + + + ERROR_LOG_PINNED_RESERVATION + ERROR_LOG_PINNED_RESERVATION + + + + No documentation. + + + ERROR_INVALID_TRANSACTION + ERROR_INVALID_TRANSACTION + + + + No documentation. + + + ERROR_TRANSACTION_NOT_ACTIVE + ERROR_TRANSACTION_NOT_ACTIVE + + + + No documentation. + + + ERROR_TRANSACTION_REQUEST_NOT_VALID + ERROR_TRANSACTION_REQUEST_NOT_VALID + + + + No documentation. + + + ERROR_TRANSACTION_NOT_REQUESTED + ERROR_TRANSACTION_NOT_REQUESTED + + + + No documentation. + + + ERROR_TRANSACTION_ALREADY_ABORTED + ERROR_TRANSACTION_ALREADY_ABORTED + + + + No documentation. + + + ERROR_TRANSACTION_ALREADY_COMMITTED + ERROR_TRANSACTION_ALREADY_COMMITTED + + + + No documentation. + + + ERROR_TM_INITIALIZATION_FAILED + ERROR_TM_INITIALIZATION_FAILED + + + + No documentation. + + + ERROR_RESOURCEMANAGER_READ_ONLY + ERROR_RESOURCEMANAGER_READ_ONLY + + + + No documentation. + + + ERROR_TRANSACTION_NOT_JOINED + ERROR_TRANSACTION_NOT_JOINED + + + + No documentation. + + + ERROR_TRANSACTION_SUPERIOR_EXISTS + ERROR_TRANSACTION_SUPERIOR_EXISTS + + + + No documentation. + + + ERROR_CRM_PROTOCOL_ALREADY_EXISTS + ERROR_CRM_PROTOCOL_ALREADY_EXISTS + + + + No documentation. + + + ERROR_TRANSACTION_PROPAGATION_FAILED + ERROR_TRANSACTION_PROPAGATION_FAILED + + + + No documentation. + + + ERROR_CRM_PROTOCOL_NOT_FOUND + ERROR_CRM_PROTOCOL_NOT_FOUND + + + + No documentation. + + + ERROR_TRANSACTION_INVALID_MARSHALL_BUFFER + ERROR_TRANSACTION_INVALID_MARSHALL_BUFFER + + + + No documentation. + + + ERROR_CURRENT_TRANSACTION_NOT_VALID + ERROR_CURRENT_TRANSACTION_NOT_VALID + + + + No documentation. + + + ERROR_TRANSACTION_NOT_FOUND + ERROR_TRANSACTION_NOT_FOUND + + + + No documentation. + + + ERROR_RESOURCEMANAGER_NOT_FOUND + ERROR_RESOURCEMANAGER_NOT_FOUND + + + + No documentation. + + + ERROR_ENLISTMENT_NOT_FOUND + ERROR_ENLISTMENT_NOT_FOUND + + + + No documentation. + + + ERROR_TRANSACTIONMANAGER_NOT_FOUND + ERROR_TRANSACTIONMANAGER_NOT_FOUND + + + + No documentation. + + + ERROR_TRANSACTIONMANAGER_NOT_ONLINE + ERROR_TRANSACTIONMANAGER_NOT_ONLINE + + + + No documentation. + + + ERROR_TRANSACTIONMANAGER_RECOVERY_NAME_COLLISION + ERROR_TRANSACTIONMANAGER_RECOVERY_NAME_COLLISION + + + + No documentation. + + + ERROR_TRANSACTION_NOT_ROOT + ERROR_TRANSACTION_NOT_ROOT + + + + No documentation. + + + ERROR_TRANSACTION_OBJECT_EXPIRED + ERROR_TRANSACTION_OBJECT_EXPIRED + + + + No documentation. + + + ERROR_TRANSACTION_RESPONSE_NOT_ENLISTED + ERROR_TRANSACTION_RESPONSE_NOT_ENLISTED + + + + No documentation. + + + ERROR_TRANSACTION_RECORD_TOO_LONG + ERROR_TRANSACTION_RECORD_TOO_LONG + + + + No documentation. + + + ERROR_IMPLICIT_TRANSACTION_NOT_SUPPORTED + ERROR_IMPLICIT_TRANSACTION_NOT_SUPPORTED + + + + No documentation. + + + ERROR_TRANSACTION_INTEGRITY_VIOLATED + ERROR_TRANSACTION_INTEGRITY_VIOLATED + + + + No documentation. + + + ERROR_TRANSACTIONMANAGER_IDENTITY_MISMATCH + ERROR_TRANSACTIONMANAGER_IDENTITY_MISMATCH + + + + No documentation. + + + ERROR_RM_CANNOT_BE_FROZEN_FOR_SNAPSHOT + ERROR_RM_CANNOT_BE_FROZEN_FOR_SNAPSHOT + + + + No documentation. + + + ERROR_TRANSACTION_MUST_WRITETHROUGH + ERROR_TRANSACTION_MUST_WRITETHROUGH + + + + No documentation. + + + ERROR_TRANSACTION_NO_SUPERIOR + ERROR_TRANSACTION_NO_SUPERIOR + + + + No documentation. + + + ERROR_HEURISTIC_DAMAGE_POSSIBLE + ERROR_HEURISTIC_DAMAGE_POSSIBLE + + + + No documentation. + + + ERROR_TRANSACTIONAL_CONFLICT + ERROR_TRANSACTIONAL_CONFLICT + + + + No documentation. + + + ERROR_RM_NOT_ACTIVE + ERROR_RM_NOT_ACTIVE + + + + No documentation. + + + ERROR_RM_METADATA_CORRUPT + ERROR_RM_METADATA_CORRUPT + + + + No documentation. + + + ERROR_DIRECTORY_NOT_RM + ERROR_DIRECTORY_NOT_RM + + + + No documentation. + + + ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE + ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE + + + + No documentation. + + + ERROR_LOG_RESIZE_INVALID_SIZE + ERROR_LOG_RESIZE_INVALID_SIZE + + + + No documentation. + + + ERROR_OBJECT_NO_LONGER_EXISTS + ERROR_OBJECT_NO_LONGER_EXISTS + + + + No documentation. + + + ERROR_STREAM_MINIVERSION_NOT_FOUND + ERROR_STREAM_MINIVERSION_NOT_FOUND + + + + No documentation. + + + ERROR_STREAM_MINIVERSION_NOT_VALID + ERROR_STREAM_MINIVERSION_NOT_VALID + + + + No documentation. + + + ERROR_MINIVERSION_INACCESSIBLE_FROM_SPECIFIED_TRANSACTION + ERROR_MINIVERSION_INACCESSIBLE_FROM_SPECIFIED_TRANSACTION + + + + No documentation. + + + ERROR_CANT_OPEN_MINIVERSION_WITH_MODIFY_INTENT + ERROR_CANT_OPEN_MINIVERSION_WITH_MODIFY_INTENT + + + + No documentation. + + + ERROR_CANT_CREATE_MORE_STREAM_MINIVERSIONS + ERROR_CANT_CREATE_MORE_STREAM_MINIVERSIONS + + + + No documentation. + + + ERROR_REMOTE_FILE_VERSION_MISMATCH + ERROR_REMOTE_FILE_VERSION_MISMATCH + + + + No documentation. + + + ERROR_HANDLE_NO_LONGER_VALID + ERROR_HANDLE_NO_LONGER_VALID + + + + No documentation. + + + ERROR_NO_TXF_METADATA + ERROR_NO_TXF_METADATA + + + + No documentation. + + + ERROR_LOG_CORRUPTION_DETECTED + ERROR_LOG_CORRUPTION_DETECTED + + + + No documentation. + + + ERROR_CANT_RECOVER_WITH_HANDLE_OPEN + ERROR_CANT_RECOVER_WITH_HANDLE_OPEN + + + + No documentation. + + + ERROR_RM_DISCONNECTED + ERROR_RM_DISCONNECTED + + + + No documentation. + + + ERROR_ENLISTMENT_NOT_SUPERIOR + ERROR_ENLISTMENT_NOT_SUPERIOR + + + + No documentation. + + + ERROR_RECOVERY_NOT_NEEDED + ERROR_RECOVERY_NOT_NEEDED + + + + No documentation. + + + ERROR_RM_ALREADY_STARTED + ERROR_RM_ALREADY_STARTED + + + + No documentation. + + + ERROR_FILE_IDENTITY_NOT_PERSISTENT + ERROR_FILE_IDENTITY_NOT_PERSISTENT + + + + No documentation. + + + ERROR_CANT_BREAK_TRANSACTIONAL_DEPENDENCY + ERROR_CANT_BREAK_TRANSACTIONAL_DEPENDENCY + + + + No documentation. + + + ERROR_CANT_CROSS_RM_BOUNDARY + ERROR_CANT_CROSS_RM_BOUNDARY + + + + No documentation. + + + ERROR_TXF_DIR_NOT_EMPTY + ERROR_TXF_DIR_NOT_EMPTY + + + + No documentation. + + + ERROR_INDOUBT_TRANSACTIONS_EXIST + ERROR_INDOUBT_TRANSACTIONS_EXIST + + + + No documentation. + + + ERROR_TM_VOLATILE + ERROR_TM_VOLATILE + + + + No documentation. + + + ERROR_ROLLBACK_TIMER_EXPIRED + ERROR_ROLLBACK_TIMER_EXPIRED + + + + No documentation. + + + ERROR_TXF_ATTRIBUTE_CORRUPT + ERROR_TXF_ATTRIBUTE_CORRUPT + + + + No documentation. + + + ERROR_EFS_NOT_ALLOWED_IN_TRANSACTION + ERROR_EFS_NOT_ALLOWED_IN_TRANSACTION + + + + No documentation. + + + ERROR_TRANSACTIONAL_OPEN_NOT_ALLOWED + ERROR_TRANSACTIONAL_OPEN_NOT_ALLOWED + + + + No documentation. + + + ERROR_LOG_GROWTH_FAILED + ERROR_LOG_GROWTH_FAILED + + + + No documentation. + + + ERROR_TRANSACTED_MAPPING_UNSUPPORTED_REMOTE + ERROR_TRANSACTED_MAPPING_UNSUPPORTED_REMOTE + + + + No documentation. + + + ERROR_TXF_METADATA_ALREADY_PRESENT + ERROR_TXF_METADATA_ALREADY_PRESENT + + + + No documentation. + + + ERROR_TRANSACTION_SCOPE_CALLBACKS_NOT_SET + ERROR_TRANSACTION_SCOPE_CALLBACKS_NOT_SET + + + + No documentation. + + + ERROR_TRANSACTION_REQUIRED_PROMOTION + ERROR_TRANSACTION_REQUIRED_PROMOTION + + + + No documentation. + + + ERROR_CANNOT_EXECUTE_FILE_IN_TRANSACTION + ERROR_CANNOT_EXECUTE_FILE_IN_TRANSACTION + + + + No documentation. + + + ERROR_TRANSACTIONS_NOT_FROZEN + ERROR_TRANSACTIONS_NOT_FROZEN + + + + No documentation. + + + ERROR_TRANSACTION_FREEZE_IN_PROGRESS + ERROR_TRANSACTION_FREEZE_IN_PROGRESS + + + + No documentation. + + + ERROR_NOT_SNAPSHOT_VOLUME + ERROR_NOT_SNAPSHOT_VOLUME + + + + No documentation. + + + ERROR_NO_SAVEPOINT_WITH_OPEN_FILES + ERROR_NO_SAVEPOINT_WITH_OPEN_FILES + + + + No documentation. + + + ERROR_DATA_LOST_REPAIR + ERROR_DATA_LOST_REPAIR + + + + No documentation. + + + ERROR_SPARSE_NOT_ALLOWED_IN_TRANSACTION + ERROR_SPARSE_NOT_ALLOWED_IN_TRANSACTION + + + + No documentation. + + + ERROR_TM_IDENTITY_MISMATCH + ERROR_TM_IDENTITY_MISMATCH + + + + No documentation. + + + ERROR_FLOATED_SECTION + ERROR_FLOATED_SECTION + + + + No documentation. + + + ERROR_CANNOT_ACCEPT_TRANSACTED_WORK + ERROR_CANNOT_ACCEPT_TRANSACTED_WORK + + + + No documentation. + + + ERROR_CANNOT_ABORT_TRANSACTIONS + ERROR_CANNOT_ABORT_TRANSACTIONS + + + + No documentation. + + + ERROR_BAD_CLUSTERS + ERROR_BAD_CLUSTERS + + + + No documentation. + + + ERROR_COMPRESSION_NOT_ALLOWED_IN_TRANSACTION + ERROR_COMPRESSION_NOT_ALLOWED_IN_TRANSACTION + + + + No documentation. + + + ERROR_VOLUME_DIRTY + ERROR_VOLUME_DIRTY + + + + No documentation. + + + ERROR_NO_LINK_TRACKING_IN_TRANSACTION + ERROR_NO_LINK_TRACKING_IN_TRANSACTION + + + + No documentation. + + + ERROR_OPERATION_NOT_SUPPORTED_IN_TRANSACTION + ERROR_OPERATION_NOT_SUPPORTED_IN_TRANSACTION + + + + No documentation. + + + ERROR_EXPIRED_HANDLE + ERROR_EXPIRED_HANDLE + + + + No documentation. + + + ERROR_TRANSACTION_NOT_ENLISTED + ERROR_TRANSACTION_NOT_ENLISTED + + + + No documentation. + + + ERROR_CTX_WINSTATION_NAME_INVALID + ERROR_CTX_WINSTATION_NAME_INVALID + + + + No documentation. + + + ERROR_CTX_INVALID_PD + ERROR_CTX_INVALID_PD + + + + No documentation. + + + ERROR_CTX_PD_NOT_FOUND + ERROR_CTX_PD_NOT_FOUND + + + + No documentation. + + + ERROR_CTX_WD_NOT_FOUND + ERROR_CTX_WD_NOT_FOUND + + + + No documentation. + + + ERROR_CTX_CANNOT_MAKE_EVENTLOG_ENTRY + ERROR_CTX_CANNOT_MAKE_EVENTLOG_ENTRY + + + + No documentation. + + + ERROR_CTX_SERVICE_NAME_COLLISION + ERROR_CTX_SERVICE_NAME_COLLISION + + + + No documentation. + + + ERROR_CTX_CLOSE_PENDING + ERROR_CTX_CLOSE_PENDING + + + + No documentation. + + + ERROR_CTX_NO_OUTBUF + ERROR_CTX_NO_OUTBUF + + + + No documentation. + + + ERROR_CTX_MODEM_INF_NOT_FOUND + ERROR_CTX_MODEM_INF_NOT_FOUND + + + + No documentation. + + + ERROR_CTX_INVALID_MODEMNAME + ERROR_CTX_INVALID_MODEMNAME + + + + No documentation. + + + ERROR_CTX_MODEM_RESPONSE_ERROR + ERROR_CTX_MODEM_RESPONSE_ERROR + + + + No documentation. + + + ERROR_CTX_MODEM_RESPONSE_TIMEOUT + ERROR_CTX_MODEM_RESPONSE_TIMEOUT + + + + No documentation. + + + ERROR_CTX_MODEM_RESPONSE_NO_CARRIER + ERROR_CTX_MODEM_RESPONSE_NO_CARRIER + + + + No documentation. + + + ERROR_CTX_MODEM_RESPONSE_NO_DIALTONE + ERROR_CTX_MODEM_RESPONSE_NO_DIALTONE + + + + No documentation. + + + ERROR_CTX_MODEM_RESPONSE_BUSY + ERROR_CTX_MODEM_RESPONSE_BUSY + + + + No documentation. + + + ERROR_CTX_MODEM_RESPONSE_VOICE + ERROR_CTX_MODEM_RESPONSE_VOICE + + + + No documentation. + + + ERROR_CTX_TD_ERROR + ERROR_CTX_TD_ERROR + + + + No documentation. + + + ERROR_CTX_WINSTATION_NOT_FOUND + ERROR_CTX_WINSTATION_NOT_FOUND + + + + No documentation. + + + ERROR_CTX_WINSTATION_ALREADY_EXISTS + ERROR_CTX_WINSTATION_ALREADY_EXISTS + + + + No documentation. + + + ERROR_CTX_WINSTATION_BUSY + ERROR_CTX_WINSTATION_BUSY + + + + No documentation. + + + ERROR_CTX_BAD_VIDEO_MODE + ERROR_CTX_BAD_VIDEO_MODE + + + + No documentation. + + + ERROR_CTX_GRAPHICS_INVALID + ERROR_CTX_GRAPHICS_INVALID + + + + No documentation. + + + ERROR_CTX_LOGON_DISABLED + ERROR_CTX_LOGON_DISABLED + + + + No documentation. + + + ERROR_CTX_NOT_CONSOLE + ERROR_CTX_NOT_CONSOLE + + + + No documentation. + + + ERROR_CTX_CLIENT_QUERY_TIMEOUT + ERROR_CTX_CLIENT_QUERY_TIMEOUT + + + + No documentation. + + + ERROR_CTX_CONSOLE_DISCONNECT + ERROR_CTX_CONSOLE_DISCONNECT + + + + No documentation. + + + ERROR_CTX_CONSOLE_CONNECT + ERROR_CTX_CONSOLE_CONNECT + + + + No documentation. + + + ERROR_CTX_SHADOW_DENIED + ERROR_CTX_SHADOW_DENIED + + + + No documentation. + + + ERROR_CTX_WINSTATION_ACCESS_DENIED + ERROR_CTX_WINSTATION_ACCESS_DENIED + + + + No documentation. + + + ERROR_CTX_INVALID_WD + ERROR_CTX_INVALID_WD + + + + No documentation. + + + ERROR_CTX_SHADOW_INVALID + ERROR_CTX_SHADOW_INVALID + + + + No documentation. + + + ERROR_CTX_SHADOW_DISABLED + ERROR_CTX_SHADOW_DISABLED + + + + No documentation. + + + ERROR_CTX_CLIENT_LICENSE_IN_USE + ERROR_CTX_CLIENT_LICENSE_IN_USE + + + + No documentation. + + + ERROR_CTX_CLIENT_LICENSE_NOT_SET + ERROR_CTX_CLIENT_LICENSE_NOT_SET + + + + No documentation. + + + ERROR_CTX_LICENSE_NOT_AVAILABLE + ERROR_CTX_LICENSE_NOT_AVAILABLE + + + + No documentation. + + + ERROR_CTX_LICENSE_CLIENT_INVALID + ERROR_CTX_LICENSE_CLIENT_INVALID + + + + No documentation. + + + ERROR_CTX_LICENSE_EXPIRED + ERROR_CTX_LICENSE_EXPIRED + + + + No documentation. + + + ERROR_CTX_SHADOW_NOT_RUNNING + ERROR_CTX_SHADOW_NOT_RUNNING + + + + No documentation. + + + ERROR_CTX_SHADOW_ENDED_BY_MODE_CHANGE + ERROR_CTX_SHADOW_ENDED_BY_MODE_CHANGE + + + + No documentation. + + + ERROR_ACTIVATION_COUNT_EXCEEDED + ERROR_ACTIVATION_COUNT_EXCEEDED + + + + No documentation. + + + ERROR_CTX_WINSTATIONS_DISABLED + ERROR_CTX_WINSTATIONS_DISABLED + + + + No documentation. + + + ERROR_CTX_ENCRYPTION_LEVEL_REQUIRED + ERROR_CTX_ENCRYPTION_LEVEL_REQUIRED + + + + No documentation. + + + ERROR_CTX_SESSION_IN_USE + ERROR_CTX_SESSION_IN_USE + + + + No documentation. + + + ERROR_CTX_NO_FORCE_LOGOFF + ERROR_CTX_NO_FORCE_LOGOFF + + + + No documentation. + + + ERROR_CTX_ACCOUNT_RESTRICTION + ERROR_CTX_ACCOUNT_RESTRICTION + + + + No documentation. + + + ERROR_RDP_PROTOCOL_ERROR + ERROR_RDP_PROTOCOL_ERROR + + + + No documentation. + + + ERROR_CTX_CDM_CONNECT + ERROR_CTX_CDM_CONNECT + + + + No documentation. + + + ERROR_CTX_CDM_DISCONNECT + ERROR_CTX_CDM_DISCONNECT + + + + No documentation. + + + ERROR_CTX_SECURITY_LAYER_ERROR + ERROR_CTX_SECURITY_LAYER_ERROR + + + + No documentation. + + + ERROR_TS_INCOMPATIBLE_SESSIONS + ERROR_TS_INCOMPATIBLE_SESSIONS + + + + No documentation. + + + ERROR_TS_VIDEO_SUBSYSTEM_ERROR + ERROR_TS_VIDEO_SUBSYSTEM_ERROR + + + + No documentation. + + + ERROR_DS_NOT_INSTALLED + ERROR_DS_NOT_INSTALLED + + + + No documentation. + + + ERROR_DS_MEMBERSHIP_EVALUATED_LOCALLY + ERROR_DS_MEMBERSHIP_EVALUATED_LOCALLY + + + + No documentation. + + + ERROR_DS_NO_ATTRIBUTE_OR_VALUE + ERROR_DS_NO_ATTRIBUTE_OR_VALUE + + + + No documentation. + + + ERROR_DS_INVALID_ATTRIBUTE_SYNTAX + ERROR_DS_INVALID_ATTRIBUTE_SYNTAX + + + + No documentation. + + + ERROR_DS_ATTRIBUTE_TYPE_UNDEFINED + ERROR_DS_ATTRIBUTE_TYPE_UNDEFINED + + + + No documentation. + + + ERROR_DS_ATTRIBUTE_OR_VALUE_EXISTS + ERROR_DS_ATTRIBUTE_OR_VALUE_EXISTS + + + + No documentation. + + + ERROR_DS_BUSY + ERROR_DS_BUSY + + + + No documentation. + + + ERROR_DS_UNAVAILABLE + ERROR_DS_UNAVAILABLE + + + + No documentation. + + + ERROR_DS_NO_RIDS_ALLOCATED + ERROR_DS_NO_RIDS_ALLOCATED + + + + No documentation. + + + ERROR_DS_NO_MORE_RIDS + ERROR_DS_NO_MORE_RIDS + + + + No documentation. + + + ERROR_DS_INCORRECT_ROLE_OWNER + ERROR_DS_INCORRECT_ROLE_OWNER + + + + No documentation. + + + ERROR_DS_RIDMGR_INIT_ERROR + ERROR_DS_RIDMGR_INIT_ERROR + + + + No documentation. + + + ERROR_DS_OBJ_CLASS_VIOLATION + ERROR_DS_OBJ_CLASS_VIOLATION + + + + No documentation. + + + ERROR_DS_CANT_ON_NON_LEAF + ERROR_DS_CANT_ON_NON_LEAF + + + + No documentation. + + + ERROR_DS_CANT_ON_RDN + ERROR_DS_CANT_ON_RDN + + + + No documentation. + + + ERROR_DS_CANT_MOD_OBJ_CLASS + ERROR_DS_CANT_MOD_OBJ_CLASS + + + + No documentation. + + + ERROR_DS_CROSS_DOM_MOVE_ERROR + ERROR_DS_CROSS_DOM_MOVE_ERROR + + + + No documentation. + + + ERROR_DS_GC_NOT_AVAILABLE + ERROR_DS_GC_NOT_AVAILABLE + + + + No documentation. + + + ERROR_SHARED_POLICY + ERROR_SHARED_POLICY + + + + No documentation. + + + ERROR_POLICY_OBJECT_NOT_FOUND + ERROR_POLICY_OBJECT_NOT_FOUND + + + + No documentation. + + + ERROR_POLICY_ONLY_IN_DS + ERROR_POLICY_ONLY_IN_DS + + + + No documentation. + + + ERROR_PROMOTION_ACTIVE + ERROR_PROMOTION_ACTIVE + + + + No documentation. + + + ERROR_NO_PROMOTION_ACTIVE + ERROR_NO_PROMOTION_ACTIVE + + + + No documentation. + + + ERROR_DS_OPERATIONS_ERROR + ERROR_DS_OPERATIONS_ERROR + + + + No documentation. + + + ERROR_DS_PROTOCOL_ERROR + ERROR_DS_PROTOCOL_ERROR + + + + No documentation. + + + ERROR_DS_TIMELIMIT_EXCEEDED + ERROR_DS_TIMELIMIT_EXCEEDED + + + + No documentation. + + + ERROR_DS_SIZELIMIT_EXCEEDED + ERROR_DS_SIZELIMIT_EXCEEDED + + + + No documentation. + + + ERROR_DS_ADMIN_LIMIT_EXCEEDED + ERROR_DS_ADMIN_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_DS_COMPARE_FALSE + ERROR_DS_COMPARE_FALSE + + + + No documentation. + + + ERROR_DS_COMPARE_TRUE + ERROR_DS_COMPARE_TRUE + + + + No documentation. + + + ERROR_DS_AUTH_METHOD_NOT_SUPPORTED + ERROR_DS_AUTH_METHOD_NOT_SUPPORTED + + + + No documentation. + + + ERROR_DS_STRONG_AUTH_REQUIRED + ERROR_DS_STRONG_AUTH_REQUIRED + + + + No documentation. + + + ERROR_DS_INAPPROPRIATE_AUTH + ERROR_DS_INAPPROPRIATE_AUTH + + + + No documentation. + + + ERROR_DS_AUTH_UNKNOWN + ERROR_DS_AUTH_UNKNOWN + + + + No documentation. + + + ERROR_DS_REFERRAL + ERROR_DS_REFERRAL + + + + No documentation. + + + ERROR_DS_UNAVAILABLE_CRIT_EXTENSION + ERROR_DS_UNAVAILABLE_CRIT_EXTENSION + + + + No documentation. + + + ERROR_DS_CONFIDENTIALITY_REQUIRED + ERROR_DS_CONFIDENTIALITY_REQUIRED + + + + No documentation. + + + ERROR_DS_INAPPROPRIATE_MATCHING + ERROR_DS_INAPPROPRIATE_MATCHING + + + + No documentation. + + + ERROR_DS_CONSTRAINT_VIOLATION + ERROR_DS_CONSTRAINT_VIOLATION + + + + No documentation. + + + ERROR_DS_NO_SUCH_OBJECT + ERROR_DS_NO_SUCH_OBJECT + + + + No documentation. + + + ERROR_DS_ALIAS_PROBLEM + ERROR_DS_ALIAS_PROBLEM + + + + No documentation. + + + ERROR_DS_INVALID_DN_SYNTAX + ERROR_DS_INVALID_DN_SYNTAX + + + + No documentation. + + + ERROR_DS_IS_LEAF + ERROR_DS_IS_LEAF + + + + No documentation. + + + ERROR_DS_ALIAS_DEREF_PROBLEM + ERROR_DS_ALIAS_DEREF_PROBLEM + + + + No documentation. + + + ERROR_DS_UNWILLING_TO_PERFORM + ERROR_DS_UNWILLING_TO_PERFORM + + + + No documentation. + + + ERROR_DS_LOOP_DETECT + ERROR_DS_LOOP_DETECT + + + + No documentation. + + + ERROR_DS_NAMING_VIOLATION + ERROR_DS_NAMING_VIOLATION + + + + No documentation. + + + ERROR_DS_OBJECT_RESULTS_TOO_LARGE + ERROR_DS_OBJECT_RESULTS_TOO_LARGE + + + + No documentation. + + + ERROR_DS_AFFECTS_MULTIPLE_DSAS + ERROR_DS_AFFECTS_MULTIPLE_DSAS + + + + No documentation. + + + ERROR_DS_SERVER_DOWN + ERROR_DS_SERVER_DOWN + + + + No documentation. + + + ERROR_DS_LOCAL_ERROR + ERROR_DS_LOCAL_ERROR + + + + No documentation. + + + ERROR_DS_ENCODING_ERROR + ERROR_DS_ENCODING_ERROR + + + + No documentation. + + + ERROR_DS_DECODING_ERROR + ERROR_DS_DECODING_ERROR + + + + No documentation. + + + ERROR_DS_FILTER_UNKNOWN + ERROR_DS_FILTER_UNKNOWN + + + + No documentation. + + + ERROR_DS_PARAM_ERROR + ERROR_DS_PARAM_ERROR + + + + No documentation. + + + ERROR_DS_NOT_SUPPORTED + ERROR_DS_NOT_SUPPORTED + + + + No documentation. + + + ERROR_DS_NO_RESULTS_RETURNED + ERROR_DS_NO_RESULTS_RETURNED + + + + No documentation. + + + ERROR_DS_CONTROL_NOT_FOUND + ERROR_DS_CONTROL_NOT_FOUND + + + + No documentation. + + + ERROR_DS_CLIENT_LOOP + ERROR_DS_CLIENT_LOOP + + + + No documentation. + + + ERROR_DS_REFERRAL_LIMIT_EXCEEDED + ERROR_DS_REFERRAL_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_DS_SORT_CONTROL_MISSING + ERROR_DS_SORT_CONTROL_MISSING + + + + No documentation. + + + ERROR_DS_OFFSET_RANGE_ERROR + ERROR_DS_OFFSET_RANGE_ERROR + + + + No documentation. + + + ERROR_DS_ROOT_MUST_BE_NC + ERROR_DS_ROOT_MUST_BE_NC + + + + No documentation. + + + ERROR_DS_ADD_REPLICA_INHIBITED + ERROR_DS_ADD_REPLICA_INHIBITED + + + + No documentation. + + + ERROR_DS_ATT_NOT_DEF_IN_SCHEMA + ERROR_DS_ATT_NOT_DEF_IN_SCHEMA + + + + No documentation. + + + ERROR_DS_MAX_OBJ_SIZE_EXCEEDED + ERROR_DS_MAX_OBJ_SIZE_EXCEEDED + + + + No documentation. + + + ERROR_DS_OBJ_STRING_NAME_EXISTS + ERROR_DS_OBJ_STRING_NAME_EXISTS + + + + No documentation. + + + ERROR_DS_NO_RDN_DEFINED_IN_SCHEMA + ERROR_DS_NO_RDN_DEFINED_IN_SCHEMA + + + + No documentation. + + + ERROR_DS_RDN_DOESNT_MATCH_SCHEMA + ERROR_DS_RDN_DOESNT_MATCH_SCHEMA + + + + No documentation. + + + ERROR_DS_NO_REQUESTED_ATTS_FOUND + ERROR_DS_NO_REQUESTED_ATTS_FOUND + + + + No documentation. + + + ERROR_DS_USER_BUFFER_TO_SMALL + ERROR_DS_USER_BUFFER_TO_SMALL + + + + No documentation. + + + ERROR_DS_ATT_IS_NOT_ON_OBJ + ERROR_DS_ATT_IS_NOT_ON_OBJ + + + + No documentation. + + + ERROR_DS_ILLEGAL_MOD_OPERATION + ERROR_DS_ILLEGAL_MOD_OPERATION + + + + No documentation. + + + ERROR_DS_OBJ_TOO_LARGE + ERROR_DS_OBJ_TOO_LARGE + + + + No documentation. + + + ERROR_DS_BAD_INSTANCE_TYPE + ERROR_DS_BAD_INSTANCE_TYPE + + + + No documentation. + + + ERROR_DS_MASTERDSA_REQUIRED + ERROR_DS_MASTERDSA_REQUIRED + + + + No documentation. + + + ERROR_DS_OBJECT_CLASS_REQUIRED + ERROR_DS_OBJECT_CLASS_REQUIRED + + + + No documentation. + + + ERROR_DS_MISSING_REQUIRED_ATT + ERROR_DS_MISSING_REQUIRED_ATT + + + + No documentation. + + + ERROR_DS_ATT_NOT_DEF_FOR_CLASS + ERROR_DS_ATT_NOT_DEF_FOR_CLASS + + + + No documentation. + + + ERROR_DS_ATT_ALREADY_EXISTS + ERROR_DS_ATT_ALREADY_EXISTS + + + + No documentation. + + + ERROR_DS_CANT_ADD_ATT_VALUES + ERROR_DS_CANT_ADD_ATT_VALUES + + + + No documentation. + + + ERROR_DS_SINGLE_VALUE_CONSTRAINT + ERROR_DS_SINGLE_VALUE_CONSTRAINT + + + + No documentation. + + + ERROR_DS_RANGE_CONSTRAINT + ERROR_DS_RANGE_CONSTRAINT + + + + No documentation. + + + ERROR_DS_ATT_VAL_ALREADY_EXISTS + ERROR_DS_ATT_VAL_ALREADY_EXISTS + + + + No documentation. + + + ERROR_DS_CANT_REM_MISSING_ATT + ERROR_DS_CANT_REM_MISSING_ATT + + + + No documentation. + + + ERROR_DS_CANT_REM_MISSING_ATT_VAL + ERROR_DS_CANT_REM_MISSING_ATT_VAL + + + + No documentation. + + + ERROR_DS_ROOT_CANT_BE_SUBREF + ERROR_DS_ROOT_CANT_BE_SUBREF + + + + No documentation. + + + ERROR_DS_NO_CHAINING + ERROR_DS_NO_CHAINING + + + + No documentation. + + + ERROR_DS_NO_CHAINED_EVAL + ERROR_DS_NO_CHAINED_EVAL + + + + No documentation. + + + ERROR_DS_NO_PARENT_OBJECT + ERROR_DS_NO_PARENT_OBJECT + + + + No documentation. + + + ERROR_DS_PARENT_IS_AN_ALIAS + ERROR_DS_PARENT_IS_AN_ALIAS + + + + No documentation. + + + ERROR_DS_CANT_MIX_MASTER_AND_REPS + ERROR_DS_CANT_MIX_MASTER_AND_REPS + + + + No documentation. + + + ERROR_DS_CHILDREN_EXIST + ERROR_DS_CHILDREN_EXIST + + + + No documentation. + + + ERROR_DS_OBJ_NOT_FOUND + ERROR_DS_OBJ_NOT_FOUND + + + + No documentation. + + + ERROR_DS_ALIASED_OBJ_MISSING + ERROR_DS_ALIASED_OBJ_MISSING + + + + No documentation. + + + ERROR_DS_BAD_NAME_SYNTAX + ERROR_DS_BAD_NAME_SYNTAX + + + + No documentation. + + + ERROR_DS_ALIAS_POINTS_TO_ALIAS + ERROR_DS_ALIAS_POINTS_TO_ALIAS + + + + No documentation. + + + ERROR_DS_CANT_DEREF_ALIAS + ERROR_DS_CANT_DEREF_ALIAS + + + + No documentation. + + + ERROR_DS_OUT_OF_SCOPE + ERROR_DS_OUT_OF_SCOPE + + + + No documentation. + + + ERROR_DS_OBJECT_BEING_REMOVED + ERROR_DS_OBJECT_BEING_REMOVED + + + + No documentation. + + + ERROR_DS_CANT_DELETE_DSA_OBJ + ERROR_DS_CANT_DELETE_DSA_OBJ + + + + No documentation. + + + ERROR_DS_GENERIC_ERROR + ERROR_DS_GENERIC_ERROR + + + + No documentation. + + + ERROR_DS_DSA_MUST_BE_INT_MASTER + ERROR_DS_DSA_MUST_BE_INT_MASTER + + + + No documentation. + + + ERROR_DS_CLASS_NOT_DSA + ERROR_DS_CLASS_NOT_DSA + + + + No documentation. + + + ERROR_DS_INSUFF_ACCESS_RIGHTS + ERROR_DS_INSUFF_ACCESS_RIGHTS + + + + No documentation. + + + ERROR_DS_ILLEGAL_SUPERIOR + ERROR_DS_ILLEGAL_SUPERIOR + + + + No documentation. + + + ERROR_DS_ATTRIBUTE_OWNED_BY_SAM + ERROR_DS_ATTRIBUTE_OWNED_BY_SAM + + + + No documentation. + + + ERROR_DS_NAME_TOO_MANY_PARTS + ERROR_DS_NAME_TOO_MANY_PARTS + + + + No documentation. + + + ERROR_DS_NAME_TOO_LONG + ERROR_DS_NAME_TOO_LONG + + + + No documentation. + + + ERROR_DS_NAME_VALUE_TOO_LONG + ERROR_DS_NAME_VALUE_TOO_LONG + + + + No documentation. + + + ERROR_DS_NAME_UNPARSEABLE + ERROR_DS_NAME_UNPARSEABLE + + + + No documentation. + + + ERROR_DS_NAME_TYPE_UNKNOWN + ERROR_DS_NAME_TYPE_UNKNOWN + + + + No documentation. + + + ERROR_DS_NOT_AN_OBJECT + ERROR_DS_NOT_AN_OBJECT + + + + No documentation. + + + ERROR_DS_SEC_DESC_TOO_SHORT + ERROR_DS_SEC_DESC_TOO_SHORT + + + + No documentation. + + + ERROR_DS_SEC_DESC_INVALID + ERROR_DS_SEC_DESC_INVALID + + + + No documentation. + + + ERROR_DS_NO_DELETED_NAME + ERROR_DS_NO_DELETED_NAME + + + + No documentation. + + + ERROR_DS_SUBREF_MUST_HAVE_PARENT + ERROR_DS_SUBREF_MUST_HAVE_PARENT + + + + No documentation. + + + ERROR_DS_NCNAME_MUST_BE_NC + ERROR_DS_NCNAME_MUST_BE_NC + + + + No documentation. + + + ERROR_DS_CANT_ADD_SYSTEM_ONLY + ERROR_DS_CANT_ADD_SYSTEM_ONLY + + + + No documentation. + + + ERROR_DS_CLASS_MUST_BE_CONCRETE + ERROR_DS_CLASS_MUST_BE_CONCRETE + + + + No documentation. + + + ERROR_DS_INVALID_DMD + ERROR_DS_INVALID_DMD + + + + No documentation. + + + ERROR_DS_OBJ_GUID_EXISTS + ERROR_DS_OBJ_GUID_EXISTS + + + + No documentation. + + + ERROR_DS_NOT_ON_BACKLINK + ERROR_DS_NOT_ON_BACKLINK + + + + No documentation. + + + ERROR_DS_NO_CROSSREF_FOR_NC + ERROR_DS_NO_CROSSREF_FOR_NC + + + + No documentation. + + + ERROR_DS_SHUTTING_DOWN + ERROR_DS_SHUTTING_DOWN + + + + No documentation. + + + ERROR_DS_UNKNOWN_OPERATION + ERROR_DS_UNKNOWN_OPERATION + + + + No documentation. + + + ERROR_DS_INVALID_ROLE_OWNER + ERROR_DS_INVALID_ROLE_OWNER + + + + No documentation. + + + ERROR_DS_COULDNT_CONTACT_FSMO + ERROR_DS_COULDNT_CONTACT_FSMO + + + + No documentation. + + + ERROR_DS_CROSS_NC_DN_RENAME + ERROR_DS_CROSS_NC_DN_RENAME + + + + No documentation. + + + ERROR_DS_CANT_MOD_SYSTEM_ONLY + ERROR_DS_CANT_MOD_SYSTEM_ONLY + + + + No documentation. + + + ERROR_DS_REPLICATOR_ONLY + ERROR_DS_REPLICATOR_ONLY + + + + No documentation. + + + ERROR_DS_OBJ_CLASS_NOT_DEFINED + ERROR_DS_OBJ_CLASS_NOT_DEFINED + + + + No documentation. + + + ERROR_DS_OBJ_CLASS_NOT_SUBCLASS + ERROR_DS_OBJ_CLASS_NOT_SUBCLASS + + + + No documentation. + + + ERROR_DS_NAME_REFERENCE_INVALID + ERROR_DS_NAME_REFERENCE_INVALID + + + + No documentation. + + + ERROR_DS_CROSS_REF_EXISTS + ERROR_DS_CROSS_REF_EXISTS + + + + No documentation. + + + ERROR_DS_CANT_DEL_MASTER_CROSSREF + ERROR_DS_CANT_DEL_MASTER_CROSSREF + + + + No documentation. + + + ERROR_DS_SUBTREE_NOTIFY_NOT_NC_HEAD + ERROR_DS_SUBTREE_NOTIFY_NOT_NC_HEAD + + + + No documentation. + + + ERROR_DS_NOTIFY_FILTER_TOO_COMPLEX + ERROR_DS_NOTIFY_FILTER_TOO_COMPLEX + + + + No documentation. + + + ERROR_DS_DUP_RDN + ERROR_DS_DUP_RDN + + + + No documentation. + + + ERROR_DS_DUP_OID + ERROR_DS_DUP_OID + + + + No documentation. + + + ERROR_DS_DUP_MAPI_ID + ERROR_DS_DUP_MAPI_ID + + + + No documentation. + + + ERROR_DS_DUP_SCHEMA_ID_GUID + ERROR_DS_DUP_SCHEMA_ID_GUID + + + + No documentation. + + + ERROR_DS_DUP_LDAP_DISPLAY_NAME + ERROR_DS_DUP_LDAP_DISPLAY_NAME + + + + No documentation. + + + ERROR_DS_SEMANTIC_ATT_TEST + ERROR_DS_SEMANTIC_ATT_TEST + + + + No documentation. + + + ERROR_DS_SYNTAX_MISMATCH + ERROR_DS_SYNTAX_MISMATCH + + + + No documentation. + + + ERROR_DS_EXISTS_IN_MUST_HAVE + ERROR_DS_EXISTS_IN_MUST_HAVE + + + + No documentation. + + + ERROR_DS_EXISTS_IN_MAY_HAVE + ERROR_DS_EXISTS_IN_MAY_HAVE + + + + No documentation. + + + ERROR_DS_NONEXISTENT_MAY_HAVE + ERROR_DS_NONEXISTENT_MAY_HAVE + + + + No documentation. + + + ERROR_DS_NONEXISTENT_MUST_HAVE + ERROR_DS_NONEXISTENT_MUST_HAVE + + + + No documentation. + + + ERROR_DS_AUX_CLS_TEST_FAIL + ERROR_DS_AUX_CLS_TEST_FAIL + + + + No documentation. + + + ERROR_DS_NONEXISTENT_POSS_SUP + ERROR_DS_NONEXISTENT_POSS_SUP + + + + No documentation. + + + ERROR_DS_SUB_CLS_TEST_FAIL + ERROR_DS_SUB_CLS_TEST_FAIL + + + + No documentation. + + + ERROR_DS_BAD_RDN_ATT_ID_SYNTAX + ERROR_DS_BAD_RDN_ATT_ID_SYNTAX + + + + No documentation. + + + ERROR_DS_EXISTS_IN_AUX_CLS + ERROR_DS_EXISTS_IN_AUX_CLS + + + + No documentation. + + + ERROR_DS_EXISTS_IN_SUB_CLS + ERROR_DS_EXISTS_IN_SUB_CLS + + + + No documentation. + + + ERROR_DS_EXISTS_IN_POSS_SUP + ERROR_DS_EXISTS_IN_POSS_SUP + + + + No documentation. + + + ERROR_DS_RECALCSCHEMA_FAILED + ERROR_DS_RECALCSCHEMA_FAILED + + + + No documentation. + + + ERROR_DS_TREE_DELETE_NOT_FINISHED + ERROR_DS_TREE_DELETE_NOT_FINISHED + + + + No documentation. + + + ERROR_DS_CANT_DELETE + ERROR_DS_CANT_DELETE + + + + No documentation. + + + ERROR_DS_ATT_SCHEMA_REQ_ID + ERROR_DS_ATT_SCHEMA_REQ_ID + + + + No documentation. + + + ERROR_DS_BAD_ATT_SCHEMA_SYNTAX + ERROR_DS_BAD_ATT_SCHEMA_SYNTAX + + + + No documentation. + + + ERROR_DS_CANT_CACHE_ATT + ERROR_DS_CANT_CACHE_ATT + + + + No documentation. + + + ERROR_DS_CANT_CACHE_CLASS + ERROR_DS_CANT_CACHE_CLASS + + + + No documentation. + + + ERROR_DS_CANT_REMOVE_ATT_CACHE + ERROR_DS_CANT_REMOVE_ATT_CACHE + + + + No documentation. + + + ERROR_DS_CANT_REMOVE_CLASS_CACHE + ERROR_DS_CANT_REMOVE_CLASS_CACHE + + + + No documentation. + + + ERROR_DS_CANT_RETRIEVE_DN + ERROR_DS_CANT_RETRIEVE_DN + + + + No documentation. + + + ERROR_DS_MISSING_SUPREF + ERROR_DS_MISSING_SUPREF + + + + No documentation. + + + ERROR_DS_CANT_RETRIEVE_INSTANCE + ERROR_DS_CANT_RETRIEVE_INSTANCE + + + + No documentation. + + + ERROR_DS_CODE_INCONSISTENCY + ERROR_DS_CODE_INCONSISTENCY + + + + No documentation. + + + ERROR_DS_DATABASE_ERROR + ERROR_DS_DATABASE_ERROR + + + + No documentation. + + + ERROR_DS_GOVERNSID_MISSING + ERROR_DS_GOVERNSID_MISSING + + + + No documentation. + + + ERROR_DS_MISSING_EXPECTED_ATT + ERROR_DS_MISSING_EXPECTED_ATT + + + + No documentation. + + + ERROR_DS_NCNAME_MISSING_CR_REF + ERROR_DS_NCNAME_MISSING_CR_REF + + + + No documentation. + + + ERROR_DS_SECURITY_CHECKING_ERROR + ERROR_DS_SECURITY_CHECKING_ERROR + + + + No documentation. + + + ERROR_DS_SCHEMA_NOT_LOADED + ERROR_DS_SCHEMA_NOT_LOADED + + + + No documentation. + + + ERROR_DS_SCHEMA_ALLOC_FAILED + ERROR_DS_SCHEMA_ALLOC_FAILED + + + + No documentation. + + + ERROR_DS_ATT_SCHEMA_REQ_SYNTAX + ERROR_DS_ATT_SCHEMA_REQ_SYNTAX + + + + No documentation. + + + ERROR_DS_GCVERIFY_ERROR + ERROR_DS_GCVERIFY_ERROR + + + + No documentation. + + + ERROR_DS_DRA_SCHEMA_MISMATCH + ERROR_DS_DRA_SCHEMA_MISMATCH + + + + No documentation. + + + ERROR_DS_CANT_FIND_DSA_OBJ + ERROR_DS_CANT_FIND_DSA_OBJ + + + + No documentation. + + + ERROR_DS_CANT_FIND_EXPECTED_NC + ERROR_DS_CANT_FIND_EXPECTED_NC + + + + No documentation. + + + ERROR_DS_CANT_FIND_NC_IN_CACHE + ERROR_DS_CANT_FIND_NC_IN_CACHE + + + + No documentation. + + + ERROR_DS_CANT_RETRIEVE_CHILD + ERROR_DS_CANT_RETRIEVE_CHILD + + + + No documentation. + + + ERROR_DS_SECURITY_ILLEGAL_MODIFY + ERROR_DS_SECURITY_ILLEGAL_MODIFY + + + + No documentation. + + + ERROR_DS_CANT_REPLACE_HIDDEN_REC + ERROR_DS_CANT_REPLACE_HIDDEN_REC + + + + No documentation. + + + ERROR_DS_BAD_HIERARCHY_FILE + ERROR_DS_BAD_HIERARCHY_FILE + + + + No documentation. + + + ERROR_DS_BUILD_HIERARCHY_TABLE_FAILED + ERROR_DS_BUILD_HIERARCHY_TABLE_FAILED + + + + No documentation. + + + ERROR_DS_CONFIG_PARAM_MISSING + ERROR_DS_CONFIG_PARAM_MISSING + + + + No documentation. + + + ERROR_DS_COUNTING_AB_INDICES_FAILED + ERROR_DS_COUNTING_AB_INDICES_FAILED + + + + No documentation. + + + ERROR_DS_HIERARCHY_TABLE_MALLOC_FAILED + ERROR_DS_HIERARCHY_TABLE_MALLOC_FAILED + + + + No documentation. + + + ERROR_DS_INTERNAL_FAILURE + ERROR_DS_INTERNAL_FAILURE + + + + No documentation. + + + ERROR_DS_UNKNOWN_ERROR + ERROR_DS_UNKNOWN_ERROR + + + + No documentation. + + + ERROR_DS_ROOT_REQUIRES_CLASS_TOP + ERROR_DS_ROOT_REQUIRES_CLASS_TOP + + + + No documentation. + + + ERROR_DS_REFUSING_FSMO_ROLES + ERROR_DS_REFUSING_FSMO_ROLES + + + + No documentation. + + + ERROR_DS_MISSING_FSMO_SETTINGS + ERROR_DS_MISSING_FSMO_SETTINGS + + + + No documentation. + + + ERROR_DS_UNABLE_TO_SURRENDER_ROLES + ERROR_DS_UNABLE_TO_SURRENDER_ROLES + + + + No documentation. + + + ERROR_DS_DRA_GENERIC + ERROR_DS_DRA_GENERIC + + + + No documentation. + + + ERROR_DS_DRA_INVALID_PARAMETER + ERROR_DS_DRA_INVALID_PARAMETER + + + + No documentation. + + + ERROR_DS_DRA_BUSY + ERROR_DS_DRA_BUSY + + + + No documentation. + + + ERROR_DS_DRA_BAD_DN + ERROR_DS_DRA_BAD_DN + + + + No documentation. + + + ERROR_DS_DRA_BAD_NC + ERROR_DS_DRA_BAD_NC + + + + No documentation. + + + ERROR_DS_DRA_DN_EXISTS + ERROR_DS_DRA_DN_EXISTS + + + + No documentation. + + + ERROR_DS_DRA_INTERNAL_ERROR + ERROR_DS_DRA_INTERNAL_ERROR + + + + No documentation. + + + ERROR_DS_DRA_INCONSISTENT_DIT + ERROR_DS_DRA_INCONSISTENT_DIT + + + + No documentation. + + + ERROR_DS_DRA_CONNECTION_FAILED + ERROR_DS_DRA_CONNECTION_FAILED + + + + No documentation. + + + ERROR_DS_DRA_BAD_INSTANCE_TYPE + ERROR_DS_DRA_BAD_INSTANCE_TYPE + + + + No documentation. + + + ERROR_DS_DRA_OUT_OF_MEM + ERROR_DS_DRA_OUT_OF_MEM + + + + No documentation. + + + ERROR_DS_DRA_MAIL_PROBLEM + ERROR_DS_DRA_MAIL_PROBLEM + + + + No documentation. + + + ERROR_DS_DRA_REF_ALREADY_EXISTS + ERROR_DS_DRA_REF_ALREADY_EXISTS + + + + No documentation. + + + ERROR_DS_DRA_REF_NOT_FOUND + ERROR_DS_DRA_REF_NOT_FOUND + + + + No documentation. + + + ERROR_DS_DRA_OBJ_IS_REP_SOURCE + ERROR_DS_DRA_OBJ_IS_REP_SOURCE + + + + No documentation. + + + ERROR_DS_DRA_DB_ERROR + ERROR_DS_DRA_DB_ERROR + + + + No documentation. + + + ERROR_DS_DRA_NO_REPLICA + ERROR_DS_DRA_NO_REPLICA + + + + No documentation. + + + ERROR_DS_DRA_ACCESS_DENIED + ERROR_DS_DRA_ACCESS_DENIED + + + + No documentation. + + + ERROR_DS_DRA_NOT_SUPPORTED + ERROR_DS_DRA_NOT_SUPPORTED + + + + No documentation. + + + ERROR_DS_DRA_RPC_CANCELLED + ERROR_DS_DRA_RPC_CANCELLED + + + + No documentation. + + + ERROR_DS_DRA_SOURCE_DISABLED + ERROR_DS_DRA_SOURCE_DISABLED + + + + No documentation. + + + ERROR_DS_DRA_SINK_DISABLED + ERROR_DS_DRA_SINK_DISABLED + + + + No documentation. + + + ERROR_DS_DRA_NAME_COLLISION + ERROR_DS_DRA_NAME_COLLISION + + + + No documentation. + + + ERROR_DS_DRA_SOURCE_REINSTALLED + ERROR_DS_DRA_SOURCE_REINSTALLED + + + + No documentation. + + + ERROR_DS_DRA_MISSING_PARENT + ERROR_DS_DRA_MISSING_PARENT + + + + No documentation. + + + ERROR_DS_DRA_PREEMPTED + ERROR_DS_DRA_PREEMPTED + + + + No documentation. + + + ERROR_DS_DRA_ABANDON_SYNC + ERROR_DS_DRA_ABANDON_SYNC + + + + No documentation. + + + ERROR_DS_DRA_SHUTDOWN + ERROR_DS_DRA_SHUTDOWN + + + + No documentation. + + + ERROR_DS_DRA_INCOMPATIBLE_PARTIAL_SET + ERROR_DS_DRA_INCOMPATIBLE_PARTIAL_SET + + + + No documentation. + + + ERROR_DS_DRA_SOURCE_IS_PARTIAL_REPLICA + ERROR_DS_DRA_SOURCE_IS_PARTIAL_REPLICA + + + + No documentation. + + + ERROR_DS_DRA_EXTN_CONNECTION_FAILED + ERROR_DS_DRA_EXTN_CONNECTION_FAILED + + + + No documentation. + + + ERROR_DS_INSTALL_SCHEMA_MISMATCH + ERROR_DS_INSTALL_SCHEMA_MISMATCH + + + + No documentation. + + + ERROR_DS_DUP_LINK_ID + ERROR_DS_DUP_LINK_ID + + + + No documentation. + + + ERROR_DS_NAME_ERROR_RESOLVING + ERROR_DS_NAME_ERROR_RESOLVING + + + + No documentation. + + + ERROR_DS_NAME_ERROR_NOT_FOUND + ERROR_DS_NAME_ERROR_NOT_FOUND + + + + No documentation. + + + ERROR_DS_NAME_ERROR_NOT_UNIQUE + ERROR_DS_NAME_ERROR_NOT_UNIQUE + + + + No documentation. + + + ERROR_DS_NAME_ERROR_NO_MAPPING + ERROR_DS_NAME_ERROR_NO_MAPPING + + + + No documentation. + + + ERROR_DS_NAME_ERROR_DOMAIN_ONLY + ERROR_DS_NAME_ERROR_DOMAIN_ONLY + + + + No documentation. + + + ERROR_DS_NAME_ERROR_NO_SYNTACTICAL_MAPPING + ERROR_DS_NAME_ERROR_NO_SYNTACTICAL_MAPPING + + + + No documentation. + + + ERROR_DS_CONSTRUCTED_ATT_MOD + ERROR_DS_CONSTRUCTED_ATT_MOD + + + + No documentation. + + + ERROR_DS_WRONG_OM_OBJ_CLASS + ERROR_DS_WRONG_OM_OBJ_CLASS + + + + No documentation. + + + ERROR_DS_DRA_REPL_PENDING + ERROR_DS_DRA_REPL_PENDING + + + + No documentation. + + + ERROR_DS_DS_REQUIRED + ERROR_DS_DS_REQUIRED + + + + No documentation. + + + ERROR_DS_INVALID_LDAP_DISPLAY_NAME + ERROR_DS_INVALID_LDAP_DISPLAY_NAME + + + + No documentation. + + + ERROR_DS_NON_BASE_SEARCH + ERROR_DS_NON_BASE_SEARCH + + + + No documentation. + + + ERROR_DS_CANT_RETRIEVE_ATTS + ERROR_DS_CANT_RETRIEVE_ATTS + + + + No documentation. + + + ERROR_DS_BACKLINK_WITHOUT_LINK + ERROR_DS_BACKLINK_WITHOUT_LINK + + + + No documentation. + + + ERROR_DS_EPOCH_MISMATCH + ERROR_DS_EPOCH_MISMATCH + + + + No documentation. + + + ERROR_DS_SRC_NAME_MISMATCH + ERROR_DS_SRC_NAME_MISMATCH + + + + No documentation. + + + ERROR_DS_SRC_AND_DST_NC_IDENTICAL + ERROR_DS_SRC_AND_DST_NC_IDENTICAL + + + + No documentation. + + + ERROR_DS_DST_NC_MISMATCH + ERROR_DS_DST_NC_MISMATCH + + + + No documentation. + + + ERROR_DS_NOT_AUTHORITIVE_FOR_DST_NC + ERROR_DS_NOT_AUTHORITIVE_FOR_DST_NC + + + + No documentation. + + + ERROR_DS_SRC_GUID_MISMATCH + ERROR_DS_SRC_GUID_MISMATCH + + + + No documentation. + + + ERROR_DS_CANT_MOVE_DELETED_OBJECT + ERROR_DS_CANT_MOVE_DELETED_OBJECT + + + + No documentation. + + + ERROR_DS_PDC_OPERATION_IN_PROGRESS + ERROR_DS_PDC_OPERATION_IN_PROGRESS + + + + No documentation. + + + ERROR_DS_CROSS_DOMAIN_CLEANUP_REQD + ERROR_DS_CROSS_DOMAIN_CLEANUP_REQD + + + + No documentation. + + + ERROR_DS_ILLEGAL_XDOM_MOVE_OPERATION + ERROR_DS_ILLEGAL_XDOM_MOVE_OPERATION + + + + No documentation. + + + ERROR_DS_CANT_WITH_ACCT_GROUP_MEMBERSHPS + ERROR_DS_CANT_WITH_ACCT_GROUP_MEMBERSHPS + + + + No documentation. + + + ERROR_DS_NC_MUST_HAVE_NC_PARENT + ERROR_DS_NC_MUST_HAVE_NC_PARENT + + + + No documentation. + + + ERROR_DS_CR_IMPOSSIBLE_TO_VALIDATE + ERROR_DS_CR_IMPOSSIBLE_TO_VALIDATE + + + + No documentation. + + + ERROR_DS_DST_DOMAIN_NOT_NATIVE + ERROR_DS_DST_DOMAIN_NOT_NATIVE + + + + No documentation. + + + ERROR_DS_MISSING_INFRASTRUCTURE_CONTAINER + ERROR_DS_MISSING_INFRASTRUCTURE_CONTAINER + + + + No documentation. + + + ERROR_DS_CANT_MOVE_ACCOUNT_GROUP + ERROR_DS_CANT_MOVE_ACCOUNT_GROUP + + + + No documentation. + + + ERROR_DS_CANT_MOVE_RESOURCE_GROUP + ERROR_DS_CANT_MOVE_RESOURCE_GROUP + + + + No documentation. + + + ERROR_DS_INVALID_SEARCH_FLAG + ERROR_DS_INVALID_SEARCH_FLAG + + + + No documentation. + + + ERROR_DS_NO_TREE_DELETE_ABOVE_NC + ERROR_DS_NO_TREE_DELETE_ABOVE_NC + + + + No documentation. + + + ERROR_DS_COULDNT_LOCK_TREE_FOR_DELETE + ERROR_DS_COULDNT_LOCK_TREE_FOR_DELETE + + + + No documentation. + + + ERROR_DS_COULDNT_IDENTIFY_OBJECTS_FOR_TREE_DELETE + ERROR_DS_COULDNT_IDENTIFY_OBJECTS_FOR_TREE_DELETE + + + + No documentation. + + + ERROR_DS_SAM_INIT_FAILURE + ERROR_DS_SAM_INIT_FAILURE + + + + No documentation. + + + ERROR_DS_SENSITIVE_GROUP_VIOLATION + ERROR_DS_SENSITIVE_GROUP_VIOLATION + + + + No documentation. + + + ERROR_DS_CANT_MOD_PRIMARYGROUPID + ERROR_DS_CANT_MOD_PRIMARYGROUPID + + + + No documentation. + + + ERROR_DS_ILLEGAL_BASE_SCHEMA_MOD + ERROR_DS_ILLEGAL_BASE_SCHEMA_MOD + + + + No documentation. + + + ERROR_DS_NONSAFE_SCHEMA_CHANGE + ERROR_DS_NONSAFE_SCHEMA_CHANGE + + + + No documentation. + + + ERROR_DS_SCHEMA_UPDATE_DISALLOWED + ERROR_DS_SCHEMA_UPDATE_DISALLOWED + + + + No documentation. + + + ERROR_DS_CANT_CREATE_UNDER_SCHEMA + ERROR_DS_CANT_CREATE_UNDER_SCHEMA + + + + No documentation. + + + ERROR_DS_INSTALL_NO_SRC_SCH_VERSION + ERROR_DS_INSTALL_NO_SRC_SCH_VERSION + + + + No documentation. + + + ERROR_DS_INSTALL_NO_SCH_VERSION_IN_INIFILE + ERROR_DS_INSTALL_NO_SCH_VERSION_IN_INIFILE + + + + No documentation. + + + ERROR_DS_INVALID_GROUP_TYPE + ERROR_DS_INVALID_GROUP_TYPE + + + + No documentation. + + + ERROR_DS_NO_NEST_GLOBALGROUP_IN_MIXEDDOMAIN + ERROR_DS_NO_NEST_GLOBALGROUP_IN_MIXEDDOMAIN + + + + No documentation. + + + ERROR_DS_NO_NEST_LOCALGROUP_IN_MIXEDDOMAIN + ERROR_DS_NO_NEST_LOCALGROUP_IN_MIXEDDOMAIN + + + + No documentation. + + + ERROR_DS_GLOBAL_CANT_HAVE_LOCAL_MEMBER + ERROR_DS_GLOBAL_CANT_HAVE_LOCAL_MEMBER + + + + No documentation. + + + ERROR_DS_GLOBAL_CANT_HAVE_UNIVERSAL_MEMBER + ERROR_DS_GLOBAL_CANT_HAVE_UNIVERSAL_MEMBER + + + + No documentation. + + + ERROR_DS_UNIVERSAL_CANT_HAVE_LOCAL_MEMBER + ERROR_DS_UNIVERSAL_CANT_HAVE_LOCAL_MEMBER + + + + No documentation. + + + ERROR_DS_GLOBAL_CANT_HAVE_CROSSDOMAIN_MEMBER + ERROR_DS_GLOBAL_CANT_HAVE_CROSSDOMAIN_MEMBER + + + + No documentation. + + + ERROR_DS_LOCAL_CANT_HAVE_CROSSDOMAIN_LOCAL_MEMBER + ERROR_DS_LOCAL_CANT_HAVE_CROSSDOMAIN_LOCAL_MEMBER + + + + No documentation. + + + ERROR_DS_HAVE_PRIMARY_MEMBERS + ERROR_DS_HAVE_PRIMARY_MEMBERS + + + + No documentation. + + + ERROR_DS_STRING_SD_CONVERSION_FAILED + ERROR_DS_STRING_SD_CONVERSION_FAILED + + + + No documentation. + + + ERROR_DS_NAMING_MASTER_GC + ERROR_DS_NAMING_MASTER_GC + + + + No documentation. + + + ERROR_DS_DNS_LOOKUP_FAILURE + ERROR_DS_DNS_LOOKUP_FAILURE + + + + No documentation. + + + ERROR_DS_COULDNT_UPDATE_SPNS + ERROR_DS_COULDNT_UPDATE_SPNS + + + + No documentation. + + + ERROR_DS_CANT_RETRIEVE_SD + ERROR_DS_CANT_RETRIEVE_SD + + + + No documentation. + + + ERROR_DS_KEY_NOT_UNIQUE + ERROR_DS_KEY_NOT_UNIQUE + + + + No documentation. + + + ERROR_DS_WRONG_LINKED_ATT_SYNTAX + ERROR_DS_WRONG_LINKED_ATT_SYNTAX + + + + No documentation. + + + ERROR_DS_SAM_NEED_BOOTKEY_PASSWORD + ERROR_DS_SAM_NEED_BOOTKEY_PASSWORD + + + + No documentation. + + + ERROR_DS_SAM_NEED_BOOTKEY_FLOPPY + ERROR_DS_SAM_NEED_BOOTKEY_FLOPPY + + + + No documentation. + + + ERROR_DS_CANT_START + ERROR_DS_CANT_START + + + + No documentation. + + + ERROR_DS_INIT_FAILURE + ERROR_DS_INIT_FAILURE + + + + No documentation. + + + ERROR_DS_NO_PKT_PRIVACY_ON_CONNECTION + ERROR_DS_NO_PKT_PRIVACY_ON_CONNECTION + + + + No documentation. + + + ERROR_DS_SOURCE_DOMAIN_IN_FOREST + ERROR_DS_SOURCE_DOMAIN_IN_FOREST + + + + No documentation. + + + ERROR_DS_DESTINATION_DOMAIN_NOT_IN_FOREST + ERROR_DS_DESTINATION_DOMAIN_NOT_IN_FOREST + + + + No documentation. + + + ERROR_DS_DESTINATION_AUDITING_NOT_ENABLED + ERROR_DS_DESTINATION_AUDITING_NOT_ENABLED + + + + No documentation. + + + ERROR_DS_CANT_FIND_DC_FOR_SRC_DOMAIN + ERROR_DS_CANT_FIND_DC_FOR_SRC_DOMAIN + + + + No documentation. + + + ERROR_DS_SRC_OBJ_NOT_GROUP_OR_USER + ERROR_DS_SRC_OBJ_NOT_GROUP_OR_USER + + + + No documentation. + + + ERROR_DS_SRC_SID_EXISTS_IN_FOREST + ERROR_DS_SRC_SID_EXISTS_IN_FOREST + + + + No documentation. + + + ERROR_DS_SRC_AND_DST_OBJECT_CLASS_MISMATCH + ERROR_DS_SRC_AND_DST_OBJECT_CLASS_MISMATCH + + + + No documentation. + + + ERROR_SAM_INIT_FAILURE + ERROR_SAM_INIT_FAILURE + + + + No documentation. + + + ERROR_DS_DRA_SCHEMA_INFO_SHIP + ERROR_DS_DRA_SCHEMA_INFO_SHIP + + + + No documentation. + + + ERROR_DS_DRA_SCHEMA_CONFLICT + ERROR_DS_DRA_SCHEMA_CONFLICT + + + + No documentation. + + + ERROR_DS_DRA_EARLIER_SCHEMA_CONFLICT + ERROR_DS_DRA_EARLIER_SCHEMA_CONFLICT + + + + No documentation. + + + ERROR_DS_DRA_OBJ_NC_MISMATCH + ERROR_DS_DRA_OBJ_NC_MISMATCH + + + + No documentation. + + + ERROR_DS_NC_STILL_HAS_DSAS + ERROR_DS_NC_STILL_HAS_DSAS + + + + No documentation. + + + ERROR_DS_GC_REQUIRED + ERROR_DS_GC_REQUIRED + + + + No documentation. + + + ERROR_DS_LOCAL_MEMBER_OF_LOCAL_ONLY + ERROR_DS_LOCAL_MEMBER_OF_LOCAL_ONLY + + + + No documentation. + + + ERROR_DS_NO_FPO_IN_UNIVERSAL_GROUPS + ERROR_DS_NO_FPO_IN_UNIVERSAL_GROUPS + + + + No documentation. + + + ERROR_DS_CANT_ADD_TO_GC + ERROR_DS_CANT_ADD_TO_GC + + + + No documentation. + + + ERROR_DS_NO_CHECKPOINT_WITH_PDC + ERROR_DS_NO_CHECKPOINT_WITH_PDC + + + + No documentation. + + + ERROR_DS_SOURCE_AUDITING_NOT_ENABLED + ERROR_DS_SOURCE_AUDITING_NOT_ENABLED + + + + No documentation. + + + ERROR_DS_CANT_CREATE_IN_NONDOMAIN_NC + ERROR_DS_CANT_CREATE_IN_NONDOMAIN_NC + + + + No documentation. + + + ERROR_DS_INVALID_NAME_FOR_SPN + ERROR_DS_INVALID_NAME_FOR_SPN + + + + No documentation. + + + ERROR_DS_FILTER_USES_CONTRUCTED_ATTRS + ERROR_DS_FILTER_USES_CONTRUCTED_ATTRS + + + + No documentation. + + + ERROR_DS_UNICODEPWD_NOT_IN_QUOTES + ERROR_DS_UNICODEPWD_NOT_IN_QUOTES + + + + No documentation. + + + ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED + ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED + + + + No documentation. + + + ERROR_DS_MUST_BE_RUN_ON_DST_DC + ERROR_DS_MUST_BE_RUN_ON_DST_DC + + + + No documentation. + + + ERROR_DS_SRC_DC_MUST_BE_SP4_OR_GREATER + ERROR_DS_SRC_DC_MUST_BE_SP4_OR_GREATER + + + + No documentation. + + + ERROR_DS_CANT_TREE_DELETE_CRITICAL_OBJ + ERROR_DS_CANT_TREE_DELETE_CRITICAL_OBJ + + + + No documentation. + + + ERROR_DS_INIT_FAILURE_CONSOLE + ERROR_DS_INIT_FAILURE_CONSOLE + + + + No documentation. + + + ERROR_DS_SAM_INIT_FAILURE_CONSOLE + ERROR_DS_SAM_INIT_FAILURE_CONSOLE + + + + No documentation. + + + ERROR_DS_FOREST_VERSION_TOO_HIGH + ERROR_DS_FOREST_VERSION_TOO_HIGH + + + + No documentation. + + + ERROR_DS_DOMAIN_VERSION_TOO_HIGH + ERROR_DS_DOMAIN_VERSION_TOO_HIGH + + + + No documentation. + + + ERROR_DS_FOREST_VERSION_TOO_LOW + ERROR_DS_FOREST_VERSION_TOO_LOW + + + + No documentation. + + + ERROR_DS_DOMAIN_VERSION_TOO_LOW + ERROR_DS_DOMAIN_VERSION_TOO_LOW + + + + No documentation. + + + ERROR_DS_INCOMPATIBLE_VERSION + ERROR_DS_INCOMPATIBLE_VERSION + + + + No documentation. + + + ERROR_DS_LOW_DSA_VERSION + ERROR_DS_LOW_DSA_VERSION + + + + No documentation. + + + ERROR_DS_NO_BEHAVIOR_VERSION_IN_MIXEDDOMAIN + ERROR_DS_NO_BEHAVIOR_VERSION_IN_MIXEDDOMAIN + + + + No documentation. + + + ERROR_DS_NOT_SUPPORTED_SORT_ORDER + ERROR_DS_NOT_SUPPORTED_SORT_ORDER + + + + No documentation. + + + ERROR_DS_NAME_NOT_UNIQUE + ERROR_DS_NAME_NOT_UNIQUE + + + + No documentation. + + + ERROR_DS_MACHINE_ACCOUNT_CREATED_PRENT4 + ERROR_DS_MACHINE_ACCOUNT_CREATED_PRENT4 + + + + No documentation. + + + ERROR_DS_OUT_OF_VERSION_STORE + ERROR_DS_OUT_OF_VERSION_STORE + + + + No documentation. + + + ERROR_DS_INCOMPATIBLE_CONTROLS_USED + ERROR_DS_INCOMPATIBLE_CONTROLS_USED + + + + No documentation. + + + ERROR_DS_NO_REF_DOMAIN + ERROR_DS_NO_REF_DOMAIN + + + + No documentation. + + + ERROR_DS_RESERVED_LINK_ID + ERROR_DS_RESERVED_LINK_ID + + + + No documentation. + + + ERROR_DS_LINK_ID_NOT_AVAILABLE + ERROR_DS_LINK_ID_NOT_AVAILABLE + + + + No documentation. + + + ERROR_DS_AG_CANT_HAVE_UNIVERSAL_MEMBER + ERROR_DS_AG_CANT_HAVE_UNIVERSAL_MEMBER + + + + No documentation. + + + ERROR_DS_MODIFYDN_DISALLOWED_BY_INSTANCE_TYPE + ERROR_DS_MODIFYDN_DISALLOWED_BY_INSTANCE_TYPE + + + + No documentation. + + + ERROR_DS_NO_OBJECT_MOVE_IN_SCHEMA_NC + ERROR_DS_NO_OBJECT_MOVE_IN_SCHEMA_NC + + + + No documentation. + + + ERROR_DS_MODIFYDN_DISALLOWED_BY_FLAG + ERROR_DS_MODIFYDN_DISALLOWED_BY_FLAG + + + + No documentation. + + + ERROR_DS_MODIFYDN_WRONG_GRANDPARENT + ERROR_DS_MODIFYDN_WRONG_GRANDPARENT + + + + No documentation. + + + ERROR_DS_NAME_ERROR_TRUST_REFERRAL + ERROR_DS_NAME_ERROR_TRUST_REFERRAL + + + + No documentation. + + + ERROR_NOT_SUPPORTED_ON_STANDARD_SERVER + ERROR_NOT_SUPPORTED_ON_STANDARD_SERVER + + + + No documentation. + + + ERROR_DS_CANT_ACCESS_REMOTE_PART_OF_AD + ERROR_DS_CANT_ACCESS_REMOTE_PART_OF_AD + + + + No documentation. + + + ERROR_DS_CR_IMPOSSIBLE_TO_VALIDATE_V2 + ERROR_DS_CR_IMPOSSIBLE_TO_VALIDATE_V2 + + + + No documentation. + + + ERROR_DS_THREAD_LIMIT_EXCEEDED + ERROR_DS_THREAD_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_DS_NOT_CLOSEST + ERROR_DS_NOT_CLOSEST + + + + No documentation. + + + ERROR_DS_CANT_DERIVE_SPN_WITHOUT_SERVER_REF + ERROR_DS_CANT_DERIVE_SPN_WITHOUT_SERVER_REF + + + + No documentation. + + + ERROR_DS_SINGLE_USER_MODE_FAILED + ERROR_DS_SINGLE_USER_MODE_FAILED + + + + No documentation. + + + ERROR_DS_NTDSCRIPT_SYNTAX_ERROR + ERROR_DS_NTDSCRIPT_SYNTAX_ERROR + + + + No documentation. + + + ERROR_DS_NTDSCRIPT_PROCESS_ERROR + ERROR_DS_NTDSCRIPT_PROCESS_ERROR + + + + No documentation. + + + ERROR_DS_DIFFERENT_REPL_EPOCHS + ERROR_DS_DIFFERENT_REPL_EPOCHS + + + + No documentation. + + + ERROR_DS_DRS_EXTENSIONS_CHANGED + ERROR_DS_DRS_EXTENSIONS_CHANGED + + + + No documentation. + + + ERROR_DS_REPLICA_SET_CHANGE_NOT_ALLOWED_ON_DISABLED_CR + ERROR_DS_REPLICA_SET_CHANGE_NOT_ALLOWED_ON_DISABLED_CR + + + + No documentation. + + + ERROR_DS_NO_MSDS_INTID + ERROR_DS_NO_MSDS_INTID + + + + No documentation. + + + ERROR_DS_DUP_MSDS_INTID + ERROR_DS_DUP_MSDS_INTID + + + + No documentation. + + + ERROR_DS_EXISTS_IN_RDNATTID + ERROR_DS_EXISTS_IN_RDNATTID + + + + No documentation. + + + ERROR_DS_AUTHORIZATION_FAILED + ERROR_DS_AUTHORIZATION_FAILED + + + + No documentation. + + + ERROR_DS_INVALID_SCRIPT + ERROR_DS_INVALID_SCRIPT + + + + No documentation. + + + ERROR_DS_REMOTE_CROSSREF_OP_FAILED + ERROR_DS_REMOTE_CROSSREF_OP_FAILED + + + + No documentation. + + + ERROR_DS_CROSS_REF_BUSY + ERROR_DS_CROSS_REF_BUSY + + + + No documentation. + + + ERROR_DS_CANT_DERIVE_SPN_FOR_DELETED_DOMAIN + ERROR_DS_CANT_DERIVE_SPN_FOR_DELETED_DOMAIN + + + + No documentation. + + + ERROR_DS_CANT_DEMOTE_WITH_WRITEABLE_NC + ERROR_DS_CANT_DEMOTE_WITH_WRITEABLE_NC + + + + No documentation. + + + ERROR_DS_DUPLICATE_ID_FOUND + ERROR_DS_DUPLICATE_ID_FOUND + + + + No documentation. + + + ERROR_DS_INSUFFICIENT_ATTR_TO_CREATE_OBJECT + ERROR_DS_INSUFFICIENT_ATTR_TO_CREATE_OBJECT + + + + No documentation. + + + ERROR_DS_GROUP_CONVERSION_ERROR + ERROR_DS_GROUP_CONVERSION_ERROR + + + + No documentation. + + + ERROR_DS_CANT_MOVE_APP_BASIC_GROUP + ERROR_DS_CANT_MOVE_APP_BASIC_GROUP + + + + No documentation. + + + ERROR_DS_CANT_MOVE_APP_QUERY_GROUP + ERROR_DS_CANT_MOVE_APP_QUERY_GROUP + + + + No documentation. + + + ERROR_DS_ROLE_NOT_VERIFIED + ERROR_DS_ROLE_NOT_VERIFIED + + + + No documentation. + + + ERROR_DS_WKO_CONTAINER_CANNOT_BE_SPECIAL + ERROR_DS_WKO_CONTAINER_CANNOT_BE_SPECIAL + + + + No documentation. + + + ERROR_DS_DOMAIN_RENAME_IN_PROGRESS + ERROR_DS_DOMAIN_RENAME_IN_PROGRESS + + + + No documentation. + + + ERROR_DS_EXISTING_AD_CHILD_NC + ERROR_DS_EXISTING_AD_CHILD_NC + + + + No documentation. + + + ERROR_DS_REPL_LIFETIME_EXCEEDED + ERROR_DS_REPL_LIFETIME_EXCEEDED + + + + No documentation. + + + ERROR_DS_DISALLOWED_IN_SYSTEM_CONTAINER + ERROR_DS_DISALLOWED_IN_SYSTEM_CONTAINER + + + + No documentation. + + + ERROR_DS_LDAP_SEND_QUEUE_FULL + ERROR_DS_LDAP_SEND_QUEUE_FULL + + + + No documentation. + + + ERROR_DS_DRA_OUT_SCHEDULE_WINDOW + ERROR_DS_DRA_OUT_SCHEDULE_WINDOW + + + + No documentation. + + + ERROR_DS_POLICY_NOT_KNOWN + ERROR_DS_POLICY_NOT_KNOWN + + + + No documentation. + + + ERROR_NO_SITE_SETTINGS_OBJECT + ERROR_NO_SITE_SETTINGS_OBJECT + + + + No documentation. + + + ERROR_NO_SECRETS + ERROR_NO_SECRETS + + + + No documentation. + + + ERROR_NO_WRITABLE_DC_FOUND + ERROR_NO_WRITABLE_DC_FOUND + + + + No documentation. + + + ERROR_DS_NO_SERVER_OBJECT + ERROR_DS_NO_SERVER_OBJECT + + + + No documentation. + + + ERROR_DS_NO_NTDSA_OBJECT + ERROR_DS_NO_NTDSA_OBJECT + + + + No documentation. + + + ERROR_DS_NON_ASQ_SEARCH + ERROR_DS_NON_ASQ_SEARCH + + + + No documentation. + + + ERROR_DS_AUDIT_FAILURE + ERROR_DS_AUDIT_FAILURE + + + + No documentation. + + + ERROR_DS_INVALID_SEARCH_FLAG_SUBTREE + ERROR_DS_INVALID_SEARCH_FLAG_SUBTREE + + + + No documentation. + + + ERROR_DS_INVALID_SEARCH_FLAG_TUPLE + ERROR_DS_INVALID_SEARCH_FLAG_TUPLE + + + + No documentation. + + + ERROR_DS_HIERARCHY_TABLE_TOO_DEEP + ERROR_DS_HIERARCHY_TABLE_TOO_DEEP + + + + No documentation. + + + ERROR_DS_DRA_CORRUPT_UTD_VECTOR + ERROR_DS_DRA_CORRUPT_UTD_VECTOR + + + + No documentation. + + + ERROR_DS_DRA_SECRETS_DENIED + ERROR_DS_DRA_SECRETS_DENIED + + + + No documentation. + + + ERROR_DS_RESERVED_MAPI_ID + ERROR_DS_RESERVED_MAPI_ID + + + + No documentation. + + + ERROR_DS_MAPI_ID_NOT_AVAILABLE + ERROR_DS_MAPI_ID_NOT_AVAILABLE + + + + No documentation. + + + ERROR_DS_DRA_MISSING_KRBTGT_SECRET + ERROR_DS_DRA_MISSING_KRBTGT_SECRET + + + + No documentation. + + + ERROR_DS_DOMAIN_NAME_EXISTS_IN_FOREST + ERROR_DS_DOMAIN_NAME_EXISTS_IN_FOREST + + + + No documentation. + + + ERROR_DS_FLAT_NAME_EXISTS_IN_FOREST + ERROR_DS_FLAT_NAME_EXISTS_IN_FOREST + + + + No documentation. + + + ERROR_INVALID_USER_PRINCIPAL_NAME + ERROR_INVALID_USER_PRINCIPAL_NAME + + + + No documentation. + + + ERROR_DS_OID_MAPPED_GROUP_CANT_HAVE_MEMBERS + ERROR_DS_OID_MAPPED_GROUP_CANT_HAVE_MEMBERS + + + + No documentation. + + + ERROR_DS_OID_NOT_FOUND + ERROR_DS_OID_NOT_FOUND + + + + No documentation. + + + ERROR_DS_DRA_RECYCLED_TARGET + ERROR_DS_DRA_RECYCLED_TARGET + + + + No documentation. + + + ERROR_IPSEC_QM_POLICY_EXISTS + ERROR_IPSEC_QM_POLICY_EXISTS + + + + No documentation. + + + ERROR_IPSEC_QM_POLICY_NOT_FOUND + ERROR_IPSEC_QM_POLICY_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_QM_POLICY_IN_USE + ERROR_IPSEC_QM_POLICY_IN_USE + + + + No documentation. + + + ERROR_IPSEC_MM_POLICY_EXISTS + ERROR_IPSEC_MM_POLICY_EXISTS + + + + No documentation. + + + ERROR_IPSEC_MM_POLICY_NOT_FOUND + ERROR_IPSEC_MM_POLICY_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_MM_POLICY_IN_USE + ERROR_IPSEC_MM_POLICY_IN_USE + + + + No documentation. + + + ERROR_IPSEC_MM_FILTER_EXISTS + ERROR_IPSEC_MM_FILTER_EXISTS + + + + No documentation. + + + ERROR_IPSEC_MM_FILTER_NOT_FOUND + ERROR_IPSEC_MM_FILTER_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_TRANSPORT_FILTER_EXISTS + ERROR_IPSEC_TRANSPORT_FILTER_EXISTS + + + + No documentation. + + + ERROR_IPSEC_TRANSPORT_FILTER_NOT_FOUND + ERROR_IPSEC_TRANSPORT_FILTER_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_MM_AUTH_EXISTS + ERROR_IPSEC_MM_AUTH_EXISTS + + + + No documentation. + + + ERROR_IPSEC_MM_AUTH_NOT_FOUND + ERROR_IPSEC_MM_AUTH_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_MM_AUTH_IN_USE + ERROR_IPSEC_MM_AUTH_IN_USE + + + + No documentation. + + + ERROR_IPSEC_DEFAULT_MM_POLICY_NOT_FOUND + ERROR_IPSEC_DEFAULT_MM_POLICY_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_DEFAULT_MM_AUTH_NOT_FOUND + ERROR_IPSEC_DEFAULT_MM_AUTH_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_DEFAULT_QM_POLICY_NOT_FOUND + ERROR_IPSEC_DEFAULT_QM_POLICY_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_TUNNEL_FILTER_EXISTS + ERROR_IPSEC_TUNNEL_FILTER_EXISTS + + + + No documentation. + + + ERROR_IPSEC_TUNNEL_FILTER_NOT_FOUND + ERROR_IPSEC_TUNNEL_FILTER_NOT_FOUND + + + + No documentation. + + + ERROR_IPSEC_MM_FILTER_PENDING_DELETION + ERROR_IPSEC_MM_FILTER_PENDING_DELETION + + + + No documentation. + + + ERROR_IPSEC_TRANSPORT_FILTER_PENDING_DELETION + ERROR_IPSEC_TRANSPORT_FILTER_PENDING_DELETION + + + + No documentation. + + + ERROR_IPSEC_TUNNEL_FILTER_PENDING_DELETION + ERROR_IPSEC_TUNNEL_FILTER_PENDING_DELETION + + + + No documentation. + + + ERROR_IPSEC_MM_POLICY_PENDING_DELETION + ERROR_IPSEC_MM_POLICY_PENDING_DELETION + + + + No documentation. + + + ERROR_IPSEC_MM_AUTH_PENDING_DELETION + ERROR_IPSEC_MM_AUTH_PENDING_DELETION + + + + No documentation. + + + ERROR_IPSEC_QM_POLICY_PENDING_DELETION + ERROR_IPSEC_QM_POLICY_PENDING_DELETION + + + + No documentation. + + + ERROR_IPSEC_IKE_NEG_STATUS_BEGIN + ERROR_IPSEC_IKE_NEG_STATUS_BEGIN + + + + No documentation. + + + ERROR_IPSEC_IKE_AUTH_FAIL + ERROR_IPSEC_IKE_AUTH_FAIL + + + + No documentation. + + + ERROR_IPSEC_IKE_ATTRIB_FAIL + ERROR_IPSEC_IKE_ATTRIB_FAIL + + + + No documentation. + + + ERROR_IPSEC_IKE_NEGOTIATION_PENDING + ERROR_IPSEC_IKE_NEGOTIATION_PENDING + + + + No documentation. + + + ERROR_IPSEC_IKE_GENERAL_PROCESSING_ERROR + ERROR_IPSEC_IKE_GENERAL_PROCESSING_ERROR + + + + No documentation. + + + ERROR_IPSEC_IKE_TIMED_OUT + ERROR_IPSEC_IKE_TIMED_OUT + + + + No documentation. + + + ERROR_IPSEC_IKE_NO_CERT + ERROR_IPSEC_IKE_NO_CERT + + + + No documentation. + + + ERROR_IPSEC_IKE_SA_DELETED + ERROR_IPSEC_IKE_SA_DELETED + + + + No documentation. + + + ERROR_IPSEC_IKE_SA_REAPED + ERROR_IPSEC_IKE_SA_REAPED + + + + No documentation. + + + ERROR_IPSEC_IKE_MM_ACQUIRE_DROP + ERROR_IPSEC_IKE_MM_ACQUIRE_DROP + + + + No documentation. + + + ERROR_IPSEC_IKE_QM_ACQUIRE_DROP + ERROR_IPSEC_IKE_QM_ACQUIRE_DROP + + + + No documentation. + + + ERROR_IPSEC_IKE_QUEUE_DROP_MM + ERROR_IPSEC_IKE_QUEUE_DROP_MM + + + + No documentation. + + + ERROR_IPSEC_IKE_QUEUE_DROP_NO_MM + ERROR_IPSEC_IKE_QUEUE_DROP_NO_MM + + + + No documentation. + + + ERROR_IPSEC_IKE_DROP_NO_RESPONSE + ERROR_IPSEC_IKE_DROP_NO_RESPONSE + + + + No documentation. + + + ERROR_IPSEC_IKE_MM_DELAY_DROP + ERROR_IPSEC_IKE_MM_DELAY_DROP + + + + No documentation. + + + ERROR_IPSEC_IKE_QM_DELAY_DROP + ERROR_IPSEC_IKE_QM_DELAY_DROP + + + + No documentation. + + + ERROR_IPSEC_IKE_ERROR + ERROR_IPSEC_IKE_ERROR + + + + No documentation. + + + ERROR_IPSEC_IKE_CRL_FAILED + ERROR_IPSEC_IKE_CRL_FAILED + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_KEY_USAGE + ERROR_IPSEC_IKE_INVALID_KEY_USAGE + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_CERT_TYPE + ERROR_IPSEC_IKE_INVALID_CERT_TYPE + + + + No documentation. + + + ERROR_IPSEC_IKE_NO_PRIVATE_KEY + ERROR_IPSEC_IKE_NO_PRIVATE_KEY + + + + No documentation. + + + ERROR_IPSEC_IKE_SIMULTANEOUS_REKEY + ERROR_IPSEC_IKE_SIMULTANEOUS_REKEY + + + + No documentation. + + + ERROR_IPSEC_IKE_DH_FAIL + ERROR_IPSEC_IKE_DH_FAIL + + + + No documentation. + + + ERROR_IPSEC_IKE_CRITICAL_PAYLOAD_NOT_RECOGNIZED + ERROR_IPSEC_IKE_CRITICAL_PAYLOAD_NOT_RECOGNIZED + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_HEADER + ERROR_IPSEC_IKE_INVALID_HEADER + + + + No documentation. + + + ERROR_IPSEC_IKE_NO_POLICY + ERROR_IPSEC_IKE_NO_POLICY + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_SIGNATURE + ERROR_IPSEC_IKE_INVALID_SIGNATURE + + + + No documentation. + + + ERROR_IPSEC_IKE_KERBEROS_ERROR + ERROR_IPSEC_IKE_KERBEROS_ERROR + + + + No documentation. + + + ERROR_IPSEC_IKE_NO_PUBLIC_KEY + ERROR_IPSEC_IKE_NO_PUBLIC_KEY + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR + ERROR_IPSEC_IKE_PROCESS_ERR + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_SA + ERROR_IPSEC_IKE_PROCESS_ERR_SA + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_PROP + ERROR_IPSEC_IKE_PROCESS_ERR_PROP + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_TRANS + ERROR_IPSEC_IKE_PROCESS_ERR_TRANS + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_KE + ERROR_IPSEC_IKE_PROCESS_ERR_KE + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_ID + ERROR_IPSEC_IKE_PROCESS_ERR_ID + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_CERT + ERROR_IPSEC_IKE_PROCESS_ERR_CERT + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_CERT_REQ + ERROR_IPSEC_IKE_PROCESS_ERR_CERT_REQ + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_HASH + ERROR_IPSEC_IKE_PROCESS_ERR_HASH + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_SIG + ERROR_IPSEC_IKE_PROCESS_ERR_SIG + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_NONCE + ERROR_IPSEC_IKE_PROCESS_ERR_NONCE + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_NOTIFY + ERROR_IPSEC_IKE_PROCESS_ERR_NOTIFY + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_DELETE + ERROR_IPSEC_IKE_PROCESS_ERR_DELETE + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_VENDOR + ERROR_IPSEC_IKE_PROCESS_ERR_VENDOR + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_PAYLOAD + ERROR_IPSEC_IKE_INVALID_PAYLOAD + + + + No documentation. + + + ERROR_IPSEC_IKE_LOAD_SOFT_SA + ERROR_IPSEC_IKE_LOAD_SOFT_SA + + + + No documentation. + + + ERROR_IPSEC_IKE_SOFT_SA_TORN_DOWN + ERROR_IPSEC_IKE_SOFT_SA_TORN_DOWN + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_COOKIE + ERROR_IPSEC_IKE_INVALID_COOKIE + + + + No documentation. + + + ERROR_IPSEC_IKE_NO_PEER_CERT + ERROR_IPSEC_IKE_NO_PEER_CERT + + + + No documentation. + + + ERROR_IPSEC_IKE_PEER_CRL_FAILED + ERROR_IPSEC_IKE_PEER_CRL_FAILED + + + + No documentation. + + + ERROR_IPSEC_IKE_POLICY_CHANGE + ERROR_IPSEC_IKE_POLICY_CHANGE + + + + No documentation. + + + ERROR_IPSEC_IKE_NO_MM_POLICY + ERROR_IPSEC_IKE_NO_MM_POLICY + + + + No documentation. + + + ERROR_IPSEC_IKE_NOTCBPRIV + ERROR_IPSEC_IKE_NOTCBPRIV + + + + No documentation. + + + ERROR_IPSEC_IKE_SECLOADFAIL + ERROR_IPSEC_IKE_SECLOADFAIL + + + + No documentation. + + + ERROR_IPSEC_IKE_FAILSSPINIT + ERROR_IPSEC_IKE_FAILSSPINIT + + + + No documentation. + + + ERROR_IPSEC_IKE_FAILQUERYSSP + ERROR_IPSEC_IKE_FAILQUERYSSP + + + + No documentation. + + + ERROR_IPSEC_IKE_SRVACQFAIL + ERROR_IPSEC_IKE_SRVACQFAIL + + + + No documentation. + + + ERROR_IPSEC_IKE_SRVQUERYCRED + ERROR_IPSEC_IKE_SRVQUERYCRED + + + + No documentation. + + + ERROR_IPSEC_IKE_GETSPIFAIL + ERROR_IPSEC_IKE_GETSPIFAIL + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_FILTER + ERROR_IPSEC_IKE_INVALID_FILTER + + + + No documentation. + + + ERROR_IPSEC_IKE_OUT_OF_MEMORY + ERROR_IPSEC_IKE_OUT_OF_MEMORY + + + + No documentation. + + + ERROR_IPSEC_IKE_ADD_UPDATE_KEY_FAILED + ERROR_IPSEC_IKE_ADD_UPDATE_KEY_FAILED + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_POLICY + ERROR_IPSEC_IKE_INVALID_POLICY + + + + No documentation. + + + ERROR_IPSEC_IKE_UNKNOWN_DOI + ERROR_IPSEC_IKE_UNKNOWN_DOI + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_SITUATION + ERROR_IPSEC_IKE_INVALID_SITUATION + + + + No documentation. + + + ERROR_IPSEC_IKE_DH_FAILURE + ERROR_IPSEC_IKE_DH_FAILURE + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_GROUP + ERROR_IPSEC_IKE_INVALID_GROUP + + + + No documentation. + + + ERROR_IPSEC_IKE_ENCRYPT + ERROR_IPSEC_IKE_ENCRYPT + + + + No documentation. + + + ERROR_IPSEC_IKE_DECRYPT + ERROR_IPSEC_IKE_DECRYPT + + + + No documentation. + + + ERROR_IPSEC_IKE_POLICY_MATCH + ERROR_IPSEC_IKE_POLICY_MATCH + + + + No documentation. + + + ERROR_IPSEC_IKE_UNSUPPORTED_ID + ERROR_IPSEC_IKE_UNSUPPORTED_ID + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_HASH + ERROR_IPSEC_IKE_INVALID_HASH + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_HASH_ALG + ERROR_IPSEC_IKE_INVALID_HASH_ALG + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_HASH_SIZE + ERROR_IPSEC_IKE_INVALID_HASH_SIZE + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_ENCRYPT_ALG + ERROR_IPSEC_IKE_INVALID_ENCRYPT_ALG + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_AUTH_ALG + ERROR_IPSEC_IKE_INVALID_AUTH_ALG + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_SIG + ERROR_IPSEC_IKE_INVALID_SIG + + + + No documentation. + + + ERROR_IPSEC_IKE_LOAD_FAILED + ERROR_IPSEC_IKE_LOAD_FAILED + + + + No documentation. + + + ERROR_IPSEC_IKE_RPC_DELETE + ERROR_IPSEC_IKE_RPC_DELETE + + + + No documentation. + + + ERROR_IPSEC_IKE_BENIGN_REINIT + ERROR_IPSEC_IKE_BENIGN_REINIT + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_RESPONDER_LIFETIME_NOTIFY + ERROR_IPSEC_IKE_INVALID_RESPONDER_LIFETIME_NOTIFY + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_MAJOR_VERSION + ERROR_IPSEC_IKE_INVALID_MAJOR_VERSION + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_CERT_KEYLEN + ERROR_IPSEC_IKE_INVALID_CERT_KEYLEN + + + + No documentation. + + + ERROR_IPSEC_IKE_MM_LIMIT + ERROR_IPSEC_IKE_MM_LIMIT + + + + No documentation. + + + ERROR_IPSEC_IKE_NEGOTIATION_DISABLED + ERROR_IPSEC_IKE_NEGOTIATION_DISABLED + + + + No documentation. + + + ERROR_IPSEC_IKE_QM_LIMIT + ERROR_IPSEC_IKE_QM_LIMIT + + + + No documentation. + + + ERROR_IPSEC_IKE_MM_EXPIRED + ERROR_IPSEC_IKE_MM_EXPIRED + + + + No documentation. + + + ERROR_IPSEC_IKE_PEER_MM_ASSUMED_INVALID + ERROR_IPSEC_IKE_PEER_MM_ASSUMED_INVALID + + + + No documentation. + + + ERROR_IPSEC_IKE_CERT_CHAIN_POLICY_MISMATCH + ERROR_IPSEC_IKE_CERT_CHAIN_POLICY_MISMATCH + + + + No documentation. + + + ERROR_IPSEC_IKE_UNEXPECTED_MESSAGE_ID + ERROR_IPSEC_IKE_UNEXPECTED_MESSAGE_ID + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_AUTH_PAYLOAD + ERROR_IPSEC_IKE_INVALID_AUTH_PAYLOAD + + + + No documentation. + + + ERROR_IPSEC_IKE_DOS_COOKIE_SENT + ERROR_IPSEC_IKE_DOS_COOKIE_SENT + + + + No documentation. + + + ERROR_IPSEC_IKE_SHUTTING_DOWN + ERROR_IPSEC_IKE_SHUTTING_DOWN + + + + No documentation. + + + ERROR_IPSEC_IKE_CGA_AUTH_FAILED + ERROR_IPSEC_IKE_CGA_AUTH_FAILED + + + + No documentation. + + + ERROR_IPSEC_IKE_PROCESS_ERR_NATOA + ERROR_IPSEC_IKE_PROCESS_ERR_NATOA + + + + No documentation. + + + ERROR_IPSEC_IKE_INVALID_MM_FOR_QM + ERROR_IPSEC_IKE_INVALID_MM_FOR_QM + + + + No documentation. + + + ERROR_IPSEC_IKE_QM_EXPIRED + ERROR_IPSEC_IKE_QM_EXPIRED + + + + No documentation. + + + ERROR_IPSEC_IKE_TOO_MANY_FILTERS + ERROR_IPSEC_IKE_TOO_MANY_FILTERS + + + + No documentation. + + + ERROR_IPSEC_IKE_NEG_STATUS_END + ERROR_IPSEC_IKE_NEG_STATUS_END + + + + No documentation. + + + ERROR_IPSEC_IKE_KILL_DUMMY_NAP_TUNNEL + ERROR_IPSEC_IKE_KILL_DUMMY_NAP_TUNNEL + + + + No documentation. + + + ERROR_IPSEC_IKE_INNER_IP_ASSIGNMENT_FAILURE + ERROR_IPSEC_IKE_INNER_IP_ASSIGNMENT_FAILURE + + + + No documentation. + + + ERROR_IPSEC_IKE_REQUIRE_CP_PAYLOAD_MISSING + ERROR_IPSEC_IKE_REQUIRE_CP_PAYLOAD_MISSING + + + + No documentation. + + + ERROR_IPSEC_KEY_MODULE_IMPERSONATION_NEGOTIATION_PENDING + ERROR_IPSEC_KEY_MODULE_IMPERSONATION_NEGOTIATION_PENDING + + + + No documentation. + + + ERROR_IPSEC_IKE_COEXISTENCE_SUPPRESS + ERROR_IPSEC_IKE_COEXISTENCE_SUPPRESS + + + + No documentation. + + + ERROR_IPSEC_IKE_RATELIMIT_DROP + ERROR_IPSEC_IKE_RATELIMIT_DROP + + + + No documentation. + + + ERROR_IPSEC_IKE_PEER_DOESNT_SUPPORT_MOBIKE + ERROR_IPSEC_IKE_PEER_DOESNT_SUPPORT_MOBIKE + + + + No documentation. + + + ERROR_IPSEC_IKE_AUTHORIZATION_FAILURE + ERROR_IPSEC_IKE_AUTHORIZATION_FAILURE + + + + No documentation. + + + ERROR_IPSEC_IKE_STRONG_CRED_AUTHORIZATION_FAILURE + ERROR_IPSEC_IKE_STRONG_CRED_AUTHORIZATION_FAILURE + + + + No documentation. + + + ERROR_IPSEC_IKE_AUTHORIZATION_FAILURE_WITH_OPTIONAL_RETRY + ERROR_IPSEC_IKE_AUTHORIZATION_FAILURE_WITH_OPTIONAL_RETRY + + + + No documentation. + + + ERROR_IPSEC_IKE_STRONG_CRED_AUTHORIZATION_AND_CERTMAP_FAILURE + ERROR_IPSEC_IKE_STRONG_CRED_AUTHORIZATION_AND_CERTMAP_FAILURE + + + + No documentation. + + + ERROR_IPSEC_IKE_NEG_STATUS_EXTENDED_END + ERROR_IPSEC_IKE_NEG_STATUS_EXTENDED_END + + + + No documentation. + + + ERROR_IPSEC_BAD_SPI + ERROR_IPSEC_BAD_SPI + + + + No documentation. + + + ERROR_IPSEC_SA_LIFETIME_EXPIRED + ERROR_IPSEC_SA_LIFETIME_EXPIRED + + + + No documentation. + + + ERROR_IPSEC_WRONG_SA + ERROR_IPSEC_WRONG_SA + + + + No documentation. + + + ERROR_IPSEC_REPLAY_CHECK_FAILED + ERROR_IPSEC_REPLAY_CHECK_FAILED + + + + No documentation. + + + ERROR_IPSEC_INVALID_PACKET + ERROR_IPSEC_INVALID_PACKET + + + + No documentation. + + + ERROR_IPSEC_INTEGRITY_CHECK_FAILED + ERROR_IPSEC_INTEGRITY_CHECK_FAILED + + + + No documentation. + + + ERROR_IPSEC_CLEAR_TEXT_DROP + ERROR_IPSEC_CLEAR_TEXT_DROP + + + + No documentation. + + + ERROR_IPSEC_AUTH_FIREWALL_DROP + ERROR_IPSEC_AUTH_FIREWALL_DROP + + + + No documentation. + + + ERROR_IPSEC_THROTTLE_DROP + ERROR_IPSEC_THROTTLE_DROP + + + + No documentation. + + + ERROR_IPSEC_DOSP_BLOCK + ERROR_IPSEC_DOSP_BLOCK + + + + No documentation. + + + ERROR_IPSEC_DOSP_RECEIVED_MULTICAST + ERROR_IPSEC_DOSP_RECEIVED_MULTICAST + + + + No documentation. + + + ERROR_IPSEC_DOSP_INVALID_PACKET + ERROR_IPSEC_DOSP_INVALID_PACKET + + + + No documentation. + + + ERROR_IPSEC_DOSP_STATE_LOOKUP_FAILED + ERROR_IPSEC_DOSP_STATE_LOOKUP_FAILED + + + + No documentation. + + + ERROR_IPSEC_DOSP_MAX_ENTRIES + ERROR_IPSEC_DOSP_MAX_ENTRIES + + + + No documentation. + + + ERROR_IPSEC_DOSP_KEYMOD_NOT_ALLOWED + ERROR_IPSEC_DOSP_KEYMOD_NOT_ALLOWED + + + + No documentation. + + + ERROR_IPSEC_DOSP_NOT_INSTALLED + ERROR_IPSEC_DOSP_NOT_INSTALLED + + + + No documentation. + + + ERROR_IPSEC_DOSP_MAX_PER_IP_RATELIMIT_QUEUES + ERROR_IPSEC_DOSP_MAX_PER_IP_RATELIMIT_QUEUES + + + + No documentation. + + + ERROR_SXS_SECTION_NOT_FOUND + ERROR_SXS_SECTION_NOT_FOUND + + + + No documentation. + + + ERROR_SXS_CANT_GEN_ACTCTX + ERROR_SXS_CANT_GEN_ACTCTX + + + + No documentation. + + + ERROR_SXS_INVALID_ACTCTXDATA_FORMAT + ERROR_SXS_INVALID_ACTCTXDATA_FORMAT + + + + No documentation. + + + ERROR_SXS_ASSEMBLY_NOT_FOUND + ERROR_SXS_ASSEMBLY_NOT_FOUND + + + + No documentation. + + + ERROR_SXS_MANIFEST_FORMAT_ERROR + ERROR_SXS_MANIFEST_FORMAT_ERROR + + + + No documentation. + + + ERROR_SXS_MANIFEST_PARSE_ERROR + ERROR_SXS_MANIFEST_PARSE_ERROR + + + + No documentation. + + + ERROR_SXS_ACTIVATION_CONTEXT_DISABLED + ERROR_SXS_ACTIVATION_CONTEXT_DISABLED + + + + No documentation. + + + ERROR_SXS_KEY_NOT_FOUND + ERROR_SXS_KEY_NOT_FOUND + + + + No documentation. + + + ERROR_SXS_VERSION_CONFLICT + ERROR_SXS_VERSION_CONFLICT + + + + No documentation. + + + ERROR_SXS_WRONG_SECTION_TYPE + ERROR_SXS_WRONG_SECTION_TYPE + + + + No documentation. + + + ERROR_SXS_THREAD_QUERIES_DISABLED + ERROR_SXS_THREAD_QUERIES_DISABLED + + + + No documentation. + + + ERROR_SXS_PROCESS_DEFAULT_ALREADY_SET + ERROR_SXS_PROCESS_DEFAULT_ALREADY_SET + + + + No documentation. + + + ERROR_SXS_UNKNOWN_ENCODING_GROUP + ERROR_SXS_UNKNOWN_ENCODING_GROUP + + + + No documentation. + + + ERROR_SXS_UNKNOWN_ENCODING + ERROR_SXS_UNKNOWN_ENCODING + + + + No documentation. + + + ERROR_SXS_INVALID_XML_NAMESPACE_URI + ERROR_SXS_INVALID_XML_NAMESPACE_URI + + + + No documentation. + + + ERROR_SXS_ROOT_MANIFEST_DEPENDENCY_NOT_INSTALLED + ERROR_SXS_ROOT_MANIFEST_DEPENDENCY_NOT_INSTALLED + + + + No documentation. + + + ERROR_SXS_LEAF_MANIFEST_DEPENDENCY_NOT_INSTALLED + ERROR_SXS_LEAF_MANIFEST_DEPENDENCY_NOT_INSTALLED + + + + No documentation. + + + ERROR_SXS_INVALID_ASSEMBLY_IDENTITY_ATTRIBUTE + ERROR_SXS_INVALID_ASSEMBLY_IDENTITY_ATTRIBUTE + + + + No documentation. + + + ERROR_SXS_MANIFEST_MISSING_REQUIRED_DEFAULT_NAMESPACE + ERROR_SXS_MANIFEST_MISSING_REQUIRED_DEFAULT_NAMESPACE + + + + No documentation. + + + ERROR_SXS_MANIFEST_INVALID_REQUIRED_DEFAULT_NAMESPACE + ERROR_SXS_MANIFEST_INVALID_REQUIRED_DEFAULT_NAMESPACE + + + + No documentation. + + + ERROR_SXS_PRIVATE_MANIFEST_CROSS_PATH_WITH_REPARSE_POINT + ERROR_SXS_PRIVATE_MANIFEST_CROSS_PATH_WITH_REPARSE_POINT + + + + No documentation. + + + ERROR_SXS_DUPLICATE_DLL_NAME + ERROR_SXS_DUPLICATE_DLL_NAME + + + + No documentation. + + + ERROR_SXS_DUPLICATE_WINDOWCLASS_NAME + ERROR_SXS_DUPLICATE_WINDOWCLASS_NAME + + + + No documentation. + + + ERROR_SXS_DUPLICATE_CLSID + ERROR_SXS_DUPLICATE_CLSID + + + + No documentation. + + + ERROR_SXS_DUPLICATE_IID + ERROR_SXS_DUPLICATE_IID + + + + No documentation. + + + ERROR_SXS_DUPLICATE_TLBID + ERROR_SXS_DUPLICATE_TLBID + + + + No documentation. + + + ERROR_SXS_DUPLICATE_PROGID + ERROR_SXS_DUPLICATE_PROGID + + + + No documentation. + + + ERROR_SXS_DUPLICATE_ASSEMBLY_NAME + ERROR_SXS_DUPLICATE_ASSEMBLY_NAME + + + + No documentation. + + + ERROR_SXS_FILE_HASH_MISMATCH + ERROR_SXS_FILE_HASH_MISMATCH + + + + No documentation. + + + ERROR_SXS_POLICY_PARSE_ERROR + ERROR_SXS_POLICY_PARSE_ERROR + + + + No documentation. + + + ERROR_SXS_XML_E_MISSINGQUOTE + ERROR_SXS_XML_E_MISSINGQUOTE + + + + No documentation. + + + ERROR_SXS_XML_E_COMMENTSYNTAX + ERROR_SXS_XML_E_COMMENTSYNTAX + + + + No documentation. + + + ERROR_SXS_XML_E_BADSTARTNAMECHAR + ERROR_SXS_XML_E_BADSTARTNAMECHAR + + + + No documentation. + + + ERROR_SXS_XML_E_BADNAMECHAR + ERROR_SXS_XML_E_BADNAMECHAR + + + + No documentation. + + + ERROR_SXS_XML_E_BADCHARINSTRING + ERROR_SXS_XML_E_BADCHARINSTRING + + + + No documentation. + + + ERROR_SXS_XML_E_XMLDECLSYNTAX + ERROR_SXS_XML_E_XMLDECLSYNTAX + + + + No documentation. + + + ERROR_SXS_XML_E_BADCHARDATA + ERROR_SXS_XML_E_BADCHARDATA + + + + No documentation. + + + ERROR_SXS_XML_E_MISSINGWHITESPACE + ERROR_SXS_XML_E_MISSINGWHITESPACE + + + + No documentation. + + + ERROR_SXS_XML_E_EXPECTINGTAGEND + ERROR_SXS_XML_E_EXPECTINGTAGEND + + + + No documentation. + + + ERROR_SXS_XML_E_MISSINGSEMICOLON + ERROR_SXS_XML_E_MISSINGSEMICOLON + + + + No documentation. + + + ERROR_SXS_XML_E_UNBALANCEDPAREN + ERROR_SXS_XML_E_UNBALANCEDPAREN + + + + No documentation. + + + ERROR_SXS_XML_E_INTERNALERROR + ERROR_SXS_XML_E_INTERNALERROR + + + + No documentation. + + + ERROR_SXS_XML_E_UNEXPECTED_WHITESPACE + ERROR_SXS_XML_E_UNEXPECTED_WHITESPACE + + + + No documentation. + + + ERROR_SXS_XML_E_INCOMPLETE_ENCODING + ERROR_SXS_XML_E_INCOMPLETE_ENCODING + + + + No documentation. + + + ERROR_SXS_XML_E_MISSING_PAREN + ERROR_SXS_XML_E_MISSING_PAREN + + + + No documentation. + + + ERROR_SXS_XML_E_EXPECTINGCLOSEQUOTE + ERROR_SXS_XML_E_EXPECTINGCLOSEQUOTE + + + + No documentation. + + + ERROR_SXS_XML_E_MULTIPLE_COLONS + ERROR_SXS_XML_E_MULTIPLE_COLONS + + + + No documentation. + + + ERROR_SXS_XML_E_INVALID_DECIMAL + ERROR_SXS_XML_E_INVALID_DECIMAL + + + + No documentation. + + + ERROR_SXS_XML_E_INVALID_HEXIDECIMAL + ERROR_SXS_XML_E_INVALID_HEXIDECIMAL + + + + No documentation. + + + ERROR_SXS_XML_E_INVALID_UNICODE + ERROR_SXS_XML_E_INVALID_UNICODE + + + + No documentation. + + + ERROR_SXS_XML_E_WHITESPACEORQUESTIONMARK + ERROR_SXS_XML_E_WHITESPACEORQUESTIONMARK + + + + No documentation. + + + ERROR_SXS_XML_E_UNEXPECTEDENDTAG + ERROR_SXS_XML_E_UNEXPECTEDENDTAG + + + + No documentation. + + + ERROR_SXS_XML_E_UNCLOSEDTAG + ERROR_SXS_XML_E_UNCLOSEDTAG + + + + No documentation. + + + ERROR_SXS_XML_E_DUPLICATEATTRIBUTE + ERROR_SXS_XML_E_DUPLICATEATTRIBUTE + + + + No documentation. + + + ERROR_SXS_XML_E_MULTIPLEROOTS + ERROR_SXS_XML_E_MULTIPLEROOTS + + + + No documentation. + + + ERROR_SXS_XML_E_INVALIDATROOTLEVEL + ERROR_SXS_XML_E_INVALIDATROOTLEVEL + + + + No documentation. + + + ERROR_SXS_XML_E_BADXMLDECL + ERROR_SXS_XML_E_BADXMLDECL + + + + No documentation. + + + ERROR_SXS_XML_E_MISSINGROOT + ERROR_SXS_XML_E_MISSINGROOT + + + + No documentation. + + + ERROR_SXS_XML_E_UNEXPECTEDEOF + ERROR_SXS_XML_E_UNEXPECTEDEOF + + + + No documentation. + + + ERROR_SXS_XML_E_BADPEREFINSUBSET + ERROR_SXS_XML_E_BADPEREFINSUBSET + + + + No documentation. + + + ERROR_SXS_XML_E_UNCLOSEDSTARTTAG + ERROR_SXS_XML_E_UNCLOSEDSTARTTAG + + + + No documentation. + + + ERROR_SXS_XML_E_UNCLOSEDENDTAG + ERROR_SXS_XML_E_UNCLOSEDENDTAG + + + + No documentation. + + + ERROR_SXS_XML_E_UNCLOSEDSTRING + ERROR_SXS_XML_E_UNCLOSEDSTRING + + + + No documentation. + + + ERROR_SXS_XML_E_UNCLOSEDCOMMENT + ERROR_SXS_XML_E_UNCLOSEDCOMMENT + + + + No documentation. + + + ERROR_SXS_XML_E_UNCLOSEDDECL + ERROR_SXS_XML_E_UNCLOSEDDECL + + + + No documentation. + + + ERROR_SXS_XML_E_UNCLOSEDCDATA + ERROR_SXS_XML_E_UNCLOSEDCDATA + + + + No documentation. + + + ERROR_SXS_XML_E_RESERVEDNAMESPACE + ERROR_SXS_XML_E_RESERVEDNAMESPACE + + + + No documentation. + + + ERROR_SXS_XML_E_INVALIDENCODING + ERROR_SXS_XML_E_INVALIDENCODING + + + + No documentation. + + + ERROR_SXS_XML_E_INVALIDSWITCH + ERROR_SXS_XML_E_INVALIDSWITCH + + + + No documentation. + + + ERROR_SXS_XML_E_BADXMLCASE + ERROR_SXS_XML_E_BADXMLCASE + + + + No documentation. + + + ERROR_SXS_XML_E_INVALID_STANDALONE + ERROR_SXS_XML_E_INVALID_STANDALONE + + + + No documentation. + + + ERROR_SXS_XML_E_UNEXPECTED_STANDALONE + ERROR_SXS_XML_E_UNEXPECTED_STANDALONE + + + + No documentation. + + + ERROR_SXS_XML_E_INVALID_VERSION + ERROR_SXS_XML_E_INVALID_VERSION + + + + No documentation. + + + ERROR_SXS_XML_E_MISSINGEQUALS + ERROR_SXS_XML_E_MISSINGEQUALS + + + + No documentation. + + + ERROR_SXS_PROTECTION_RECOVERY_FAILED + ERROR_SXS_PROTECTION_RECOVERY_FAILED + + + + No documentation. + + + ERROR_SXS_PROTECTION_PUBLIC_KEY_TOO_SHORT + ERROR_SXS_PROTECTION_PUBLIC_KEY_TOO_SHORT + + + + No documentation. + + + ERROR_SXS_PROTECTION_CATALOG_NOT_VALID + ERROR_SXS_PROTECTION_CATALOG_NOT_VALID + + + + No documentation. + + + ERROR_SXS_UNTRANSLATABLE_HRESULT + ERROR_SXS_UNTRANSLATABLE_HRESULT + + + + No documentation. + + + ERROR_SXS_PROTECTION_CATALOG_FILE_MISSING + ERROR_SXS_PROTECTION_CATALOG_FILE_MISSING + + + + No documentation. + + + ERROR_SXS_MISSING_ASSEMBLY_IDENTITY_ATTRIBUTE + ERROR_SXS_MISSING_ASSEMBLY_IDENTITY_ATTRIBUTE + + + + No documentation. + + + ERROR_SXS_INVALID_ASSEMBLY_IDENTITY_ATTRIBUTE_NAME + ERROR_SXS_INVALID_ASSEMBLY_IDENTITY_ATTRIBUTE_NAME + + + + No documentation. + + + ERROR_SXS_ASSEMBLY_MISSING + ERROR_SXS_ASSEMBLY_MISSING + + + + No documentation. + + + ERROR_SXS_CORRUPT_ACTIVATION_STACK + ERROR_SXS_CORRUPT_ACTIVATION_STACK + + + + No documentation. + + + ERROR_SXS_CORRUPTION + ERROR_SXS_CORRUPTION + + + + No documentation. + + + ERROR_SXS_EARLY_DEACTIVATION + ERROR_SXS_EARLY_DEACTIVATION + + + + No documentation. + + + ERROR_SXS_INVALID_DEACTIVATION + ERROR_SXS_INVALID_DEACTIVATION + + + + No documentation. + + + ERROR_SXS_MULTIPLE_DEACTIVATION + ERROR_SXS_MULTIPLE_DEACTIVATION + + + + No documentation. + + + ERROR_SXS_PROCESS_TERMINATION_REQUESTED + ERROR_SXS_PROCESS_TERMINATION_REQUESTED + + + + No documentation. + + + ERROR_SXS_RELEASE_ACTIVATION_CONTEXT + ERROR_SXS_RELEASE_ACTIVATION_CONTEXT + + + + No documentation. + + + ERROR_SXS_SYSTEM_DEFAULT_ACTIVATION_CONTEXT_EMPTY + ERROR_SXS_SYSTEM_DEFAULT_ACTIVATION_CONTEXT_EMPTY + + + + No documentation. + + + ERROR_SXS_INVALID_IDENTITY_ATTRIBUTE_VALUE + ERROR_SXS_INVALID_IDENTITY_ATTRIBUTE_VALUE + + + + No documentation. + + + ERROR_SXS_INVALID_IDENTITY_ATTRIBUTE_NAME + ERROR_SXS_INVALID_IDENTITY_ATTRIBUTE_NAME + + + + No documentation. + + + ERROR_SXS_IDENTITY_DUPLICATE_ATTRIBUTE + ERROR_SXS_IDENTITY_DUPLICATE_ATTRIBUTE + + + + No documentation. + + + ERROR_SXS_IDENTITY_PARSE_ERROR + ERROR_SXS_IDENTITY_PARSE_ERROR + + + + No documentation. + + + ERROR_MALFORMED_SUBSTITUTION_STRING + ERROR_MALFORMED_SUBSTITUTION_STRING + + + + No documentation. + + + ERROR_SXS_INCORRECT_PUBLIC_KEY_TOKEN + ERROR_SXS_INCORRECT_PUBLIC_KEY_TOKEN + + + + No documentation. + + + ERROR_UNMAPPED_SUBSTITUTION_STRING + ERROR_UNMAPPED_SUBSTITUTION_STRING + + + + No documentation. + + + ERROR_SXS_ASSEMBLY_NOT_LOCKED + ERROR_SXS_ASSEMBLY_NOT_LOCKED + + + + No documentation. + + + ERROR_SXS_COMPONENT_STORE_CORRUPT + ERROR_SXS_COMPONENT_STORE_CORRUPT + + + + No documentation. + + + ERROR_ADVANCED_INSTALLER_FAILED + ERROR_ADVANCED_INSTALLER_FAILED + + + + No documentation. + + + ERROR_XML_ENCODING_MISMATCH + ERROR_XML_ENCODING_MISMATCH + + + + No documentation. + + + ERROR_SXS_MANIFEST_IDENTITY_SAME_BUT_CONTENTS_DIFFERENT + ERROR_SXS_MANIFEST_IDENTITY_SAME_BUT_CONTENTS_DIFFERENT + + + + No documentation. + + + ERROR_SXS_IDENTITIES_DIFFERENT + ERROR_SXS_IDENTITIES_DIFFERENT + + + + No documentation. + + + ERROR_SXS_ASSEMBLY_IS_NOT_A_DEPLOYMENT + ERROR_SXS_ASSEMBLY_IS_NOT_A_DEPLOYMENT + + + + No documentation. + + + ERROR_SXS_FILE_NOT_PART_OF_ASSEMBLY + ERROR_SXS_FILE_NOT_PART_OF_ASSEMBLY + + + + No documentation. + + + ERROR_SXS_MANIFEST_TOO_BIG + ERROR_SXS_MANIFEST_TOO_BIG + + + + No documentation. + + + ERROR_SXS_SETTING_NOT_REGISTERED + ERROR_SXS_SETTING_NOT_REGISTERED + + + + No documentation. + + + ERROR_SXS_TRANSACTION_CLOSURE_INCOMPLETE + ERROR_SXS_TRANSACTION_CLOSURE_INCOMPLETE + + + + No documentation. + + + ERROR_SMI_PRIMITIVE_INSTALLER_FAILED + ERROR_SMI_PRIMITIVE_INSTALLER_FAILED + + + + No documentation. + + + ERROR_GENERIC_COMMAND_FAILED + ERROR_GENERIC_COMMAND_FAILED + + + + No documentation. + + + ERROR_SXS_FILE_HASH_MISSING + ERROR_SXS_FILE_HASH_MISSING + + + + No documentation. + + + ERROR_EVT_INVALID_CHANNEL_PATH + ERROR_EVT_INVALID_CHANNEL_PATH + + + + No documentation. + + + ERROR_EVT_INVALID_QUERY + ERROR_EVT_INVALID_QUERY + + + + No documentation. + + + ERROR_EVT_PUBLISHER_METADATA_NOT_FOUND + ERROR_EVT_PUBLISHER_METADATA_NOT_FOUND + + + + No documentation. + + + ERROR_EVT_EVENT_TEMPLATE_NOT_FOUND + ERROR_EVT_EVENT_TEMPLATE_NOT_FOUND + + + + No documentation. + + + ERROR_EVT_INVALID_PUBLISHER_NAME + ERROR_EVT_INVALID_PUBLISHER_NAME + + + + No documentation. + + + ERROR_EVT_INVALID_EVENT_DATA + ERROR_EVT_INVALID_EVENT_DATA + + + + No documentation. + + + ERROR_EVT_CHANNEL_NOT_FOUND + ERROR_EVT_CHANNEL_NOT_FOUND + + + + No documentation. + + + ERROR_EVT_MALFORMED_XML_TEXT + ERROR_EVT_MALFORMED_XML_TEXT + + + + No documentation. + + + ERROR_EVT_SUBSCRIPTION_TO_DIRECT_CHANNEL + ERROR_EVT_SUBSCRIPTION_TO_DIRECT_CHANNEL + + + + No documentation. + + + ERROR_EVT_CONFIGURATION_ERROR + ERROR_EVT_CONFIGURATION_ERROR + + + + No documentation. + + + ERROR_EVT_QUERY_RESULT_STALE + ERROR_EVT_QUERY_RESULT_STALE + + + + No documentation. + + + ERROR_EVT_QUERY_RESULT_INVALID_POSITION + ERROR_EVT_QUERY_RESULT_INVALID_POSITION + + + + No documentation. + + + ERROR_EVT_NON_VALIDATING_MSXML + ERROR_EVT_NON_VALIDATING_MSXML + + + + No documentation. + + + ERROR_EVT_FILTER_ALREADYSCOPED + ERROR_EVT_FILTER_ALREADYSCOPED + + + + No documentation. + + + ERROR_EVT_FILTER_NOTELTSET + ERROR_EVT_FILTER_NOTELTSET + + + + No documentation. + + + ERROR_EVT_FILTER_INVARG + ERROR_EVT_FILTER_INVARG + + + + No documentation. + + + ERROR_EVT_FILTER_INVTEST + ERROR_EVT_FILTER_INVTEST + + + + No documentation. + + + ERROR_EVT_FILTER_INVTYPE + ERROR_EVT_FILTER_INVTYPE + + + + No documentation. + + + ERROR_EVT_FILTER_PARSEERR + ERROR_EVT_FILTER_PARSEERR + + + + No documentation. + + + ERROR_EVT_FILTER_UNSUPPORTEDOP + ERROR_EVT_FILTER_UNSUPPORTEDOP + + + + No documentation. + + + ERROR_EVT_FILTER_UNEXPECTEDTOKEN + ERROR_EVT_FILTER_UNEXPECTEDTOKEN + + + + No documentation. + + + ERROR_EVT_INVALID_OPERATION_OVER_ENABLED_DIRECT_CHANNEL + ERROR_EVT_INVALID_OPERATION_OVER_ENABLED_DIRECT_CHANNEL + + + + No documentation. + + + ERROR_EVT_INVALID_CHANNEL_PROPERTY_VALUE + ERROR_EVT_INVALID_CHANNEL_PROPERTY_VALUE + + + + No documentation. + + + ERROR_EVT_INVALID_PUBLISHER_PROPERTY_VALUE + ERROR_EVT_INVALID_PUBLISHER_PROPERTY_VALUE + + + + No documentation. + + + ERROR_EVT_CHANNEL_CANNOT_ACTIVATE + ERROR_EVT_CHANNEL_CANNOT_ACTIVATE + + + + No documentation. + + + ERROR_EVT_FILTER_TOO_COMPLEX + ERROR_EVT_FILTER_TOO_COMPLEX + + + + No documentation. + + + ERROR_EVT_MESSAGE_NOT_FOUND + ERROR_EVT_MESSAGE_NOT_FOUND + + + + No documentation. + + + ERROR_EVT_MESSAGE_ID_NOT_FOUND + ERROR_EVT_MESSAGE_ID_NOT_FOUND + + + + No documentation. + + + ERROR_EVT_UNRESOLVED_VALUE_INSERT + ERROR_EVT_UNRESOLVED_VALUE_INSERT + + + + No documentation. + + + ERROR_EVT_UNRESOLVED_PARAMETER_INSERT + ERROR_EVT_UNRESOLVED_PARAMETER_INSERT + + + + No documentation. + + + ERROR_EVT_MAX_INSERTS_REACHED + ERROR_EVT_MAX_INSERTS_REACHED + + + + No documentation. + + + ERROR_EVT_EVENT_DEFINITION_NOT_FOUND + ERROR_EVT_EVENT_DEFINITION_NOT_FOUND + + + + No documentation. + + + ERROR_EVT_MESSAGE_LOCALE_NOT_FOUND + ERROR_EVT_MESSAGE_LOCALE_NOT_FOUND + + + + No documentation. + + + ERROR_EVT_VERSION_TOO_OLD + ERROR_EVT_VERSION_TOO_OLD + + + + No documentation. + + + ERROR_EVT_VERSION_TOO_NEW + ERROR_EVT_VERSION_TOO_NEW + + + + No documentation. + + + ERROR_EVT_CANNOT_OPEN_CHANNEL_OF_QUERY + ERROR_EVT_CANNOT_OPEN_CHANNEL_OF_QUERY + + + + No documentation. + + + ERROR_EVT_PUBLISHER_DISABLED + ERROR_EVT_PUBLISHER_DISABLED + + + + No documentation. + + + ERROR_EVT_FILTER_OUT_OF_RANGE + ERROR_EVT_FILTER_OUT_OF_RANGE + + + + No documentation. + + + ERROR_EC_SUBSCRIPTION_CANNOT_ACTIVATE + ERROR_EC_SUBSCRIPTION_CANNOT_ACTIVATE + + + + No documentation. + + + ERROR_EC_LOG_DISABLED + ERROR_EC_LOG_DISABLED + + + + No documentation. + + + ERROR_EC_CIRCULAR_FORWARDING + ERROR_EC_CIRCULAR_FORWARDING + + + + No documentation. + + + ERROR_EC_CREDSTORE_FULL + ERROR_EC_CREDSTORE_FULL + + + + No documentation. + + + ERROR_EC_CRED_NOT_FOUND + ERROR_EC_CRED_NOT_FOUND + + + + No documentation. + + + ERROR_EC_NO_ACTIVE_CHANNEL + ERROR_EC_NO_ACTIVE_CHANNEL + + + + No documentation. + + + ERROR_MUI_FILE_NOT_FOUND + ERROR_MUI_FILE_NOT_FOUND + + + + No documentation. + + + ERROR_MUI_INVALID_FILE + ERROR_MUI_INVALID_FILE + + + + No documentation. + + + ERROR_MUI_INVALID_RC_CONFIG + ERROR_MUI_INVALID_RC_CONFIG + + + + No documentation. + + + ERROR_MUI_INVALID_LOCALE_NAME + ERROR_MUI_INVALID_LOCALE_NAME + + + + No documentation. + + + ERROR_MUI_INVALID_ULTIMATEFALLBACK_NAME + ERROR_MUI_INVALID_ULTIMATEFALLBACK_NAME + + + + No documentation. + + + ERROR_MUI_FILE_NOT_LOADED + ERROR_MUI_FILE_NOT_LOADED + + + + No documentation. + + + ERROR_RESOURCE_ENUM_USER_STOP + ERROR_RESOURCE_ENUM_USER_STOP + + + + No documentation. + + + ERROR_MUI_INTLSETTINGS_UILANG_NOT_INSTALLED + ERROR_MUI_INTLSETTINGS_UILANG_NOT_INSTALLED + + + + No documentation. + + + ERROR_MUI_INTLSETTINGS_INVALID_LOCALE_NAME + ERROR_MUI_INTLSETTINGS_INVALID_LOCALE_NAME + + + + No documentation. + + + ERROR_MCA_INVALID_CAPABILITIES_STRING + ERROR_MCA_INVALID_CAPABILITIES_STRING + + + + No documentation. + + + ERROR_MCA_INVALID_VCP_VERSION + ERROR_MCA_INVALID_VCP_VERSION + + + + No documentation. + + + ERROR_MCA_MONITOR_VIOLATES_MCCS_SPECIFICATION + ERROR_MCA_MONITOR_VIOLATES_MCCS_SPECIFICATION + + + + No documentation. + + + ERROR_MCA_MCCS_VERSION_MISMATCH + ERROR_MCA_MCCS_VERSION_MISMATCH + + + + No documentation. + + + ERROR_MCA_UNSUPPORTED_MCCS_VERSION + ERROR_MCA_UNSUPPORTED_MCCS_VERSION + + + + No documentation. + + + ERROR_MCA_INTERNAL_ERROR + ERROR_MCA_INTERNAL_ERROR + + + + No documentation. + + + ERROR_MCA_INVALID_TECHNOLOGY_TYPE_RETURNED + ERROR_MCA_INVALID_TECHNOLOGY_TYPE_RETURNED + + + + No documentation. + + + ERROR_MCA_UNSUPPORTED_COLOR_TEMPERATURE + ERROR_MCA_UNSUPPORTED_COLOR_TEMPERATURE + + + + No documentation. + + + ERROR_AMBIGUOUS_SYSTEM_DEVICE + ERROR_AMBIGUOUS_SYSTEM_DEVICE + + + + No documentation. + + + ERROR_SYSTEM_DEVICE_NOT_FOUND + ERROR_SYSTEM_DEVICE_NOT_FOUND + + + + No documentation. + + + ERROR_HASH_NOT_SUPPORTED + ERROR_HASH_NOT_SUPPORTED + + + + No documentation. + + + ERROR_HASH_NOT_PRESENT + ERROR_HASH_NOT_PRESENT + + + + No documentation. + + + ERROR_AUDITING_DISABLED + ERROR_AUDITING_DISABLED + + + + No documentation. + + + ERROR_ALL_SIDS_FILTERED + ERROR_ALL_SIDS_FILTERED + + + + No documentation. + + + ERROR_BIZRULES_NOT_ENABLED + ERROR_BIZRULES_NOT_ENABLED + + + + No documentation. + + + ERROR_CRED_REQUIRES_CONFIRMATION + ERROR_CRED_REQUIRES_CONFIRMATION + + + + No documentation. + + + ERROR_FLT_IO_COMPLETE + ERROR_FLT_IO_COMPLETE + + + + No documentation. + + + ERROR_FLT_NO_HANDLER_DEFINED + ERROR_FLT_NO_HANDLER_DEFINED + + + + No documentation. + + + ERROR_FLT_CONTEXT_ALREADY_DEFINED + ERROR_FLT_CONTEXT_ALREADY_DEFINED + + + + No documentation. + + + ERROR_FLT_INVALID_ASYNCHRONOUS_REQUEST + ERROR_FLT_INVALID_ASYNCHRONOUS_REQUEST + + + + No documentation. + + + ERROR_FLT_DISALLOW_FAST_IO + ERROR_FLT_DISALLOW_FAST_IO + + + + No documentation. + + + ERROR_FLT_INVALID_NAME_REQUEST + ERROR_FLT_INVALID_NAME_REQUEST + + + + No documentation. + + + ERROR_FLT_NOT_SAFE_TO_POST_OPERATION + ERROR_FLT_NOT_SAFE_TO_POST_OPERATION + + + + No documentation. + + + ERROR_FLT_NOT_INITIALIZED + ERROR_FLT_NOT_INITIALIZED + + + + No documentation. + + + ERROR_FLT_FILTER_NOT_READY + ERROR_FLT_FILTER_NOT_READY + + + + No documentation. + + + ERROR_FLT_POST_OPERATION_CLEANUP + ERROR_FLT_POST_OPERATION_CLEANUP + + + + No documentation. + + + ERROR_FLT_INTERNAL_ERROR + ERROR_FLT_INTERNAL_ERROR + + + + No documentation. + + + ERROR_FLT_DELETING_OBJECT + ERROR_FLT_DELETING_OBJECT + + + + No documentation. + + + ERROR_FLT_MUST_BE_NONPAGED_POOL + ERROR_FLT_MUST_BE_NONPAGED_POOL + + + + No documentation. + + + ERROR_FLT_DUPLICATE_ENTRY + ERROR_FLT_DUPLICATE_ENTRY + + + + No documentation. + + + ERROR_FLT_CBDQ_DISABLED + ERROR_FLT_CBDQ_DISABLED + + + + No documentation. + + + ERROR_FLT_DO_NOT_ATTACH + ERROR_FLT_DO_NOT_ATTACH + + + + No documentation. + + + ERROR_FLT_DO_NOT_DETACH + ERROR_FLT_DO_NOT_DETACH + + + + No documentation. + + + ERROR_FLT_INSTANCE_ALTITUDE_COLLISION + ERROR_FLT_INSTANCE_ALTITUDE_COLLISION + + + + No documentation. + + + ERROR_FLT_INSTANCE_NAME_COLLISION + ERROR_FLT_INSTANCE_NAME_COLLISION + + + + No documentation. + + + ERROR_FLT_FILTER_NOT_FOUND + ERROR_FLT_FILTER_NOT_FOUND + + + + No documentation. + + + ERROR_FLT_VOLUME_NOT_FOUND + ERROR_FLT_VOLUME_NOT_FOUND + + + + No documentation. + + + ERROR_FLT_INSTANCE_NOT_FOUND + ERROR_FLT_INSTANCE_NOT_FOUND + + + + No documentation. + + + ERROR_FLT_CONTEXT_ALLOCATION_NOT_FOUND + ERROR_FLT_CONTEXT_ALLOCATION_NOT_FOUND + + + + No documentation. + + + ERROR_FLT_INVALID_CONTEXT_REGISTRATION + ERROR_FLT_INVALID_CONTEXT_REGISTRATION + + + + No documentation. + + + ERROR_FLT_NAME_CACHE_MISS + ERROR_FLT_NAME_CACHE_MISS + + + + No documentation. + + + ERROR_FLT_NO_DEVICE_OBJECT + ERROR_FLT_NO_DEVICE_OBJECT + + + + No documentation. + + + ERROR_FLT_VOLUME_ALREADY_MOUNTED + ERROR_FLT_VOLUME_ALREADY_MOUNTED + + + + No documentation. + + + ERROR_FLT_ALREADY_ENLISTED + ERROR_FLT_ALREADY_ENLISTED + + + + No documentation. + + + ERROR_FLT_CONTEXT_ALREADY_LINKED + ERROR_FLT_CONTEXT_ALREADY_LINKED + + + + No documentation. + + + ERROR_FLT_NO_WAITER_FOR_REPLY + ERROR_FLT_NO_WAITER_FOR_REPLY + + + + No documentation. + + + ERROR_HUNG_DISPLAY_DRIVER_THREAD + ERROR_HUNG_DISPLAY_DRIVER_THREAD + + + + No documentation. + + + ERROR_MONITOR_NO_DESCRIPTOR + ERROR_MONITOR_NO_DESCRIPTOR + + + + No documentation. + + + ERROR_MONITOR_UNKNOWN_DESCRIPTOR_FORMAT + ERROR_MONITOR_UNKNOWN_DESCRIPTOR_FORMAT + + + + No documentation. + + + ERROR_MONITOR_INVALID_DESCRIPTOR_CHECKSUM + ERROR_MONITOR_INVALID_DESCRIPTOR_CHECKSUM + + + + No documentation. + + + ERROR_MONITOR_INVALID_STANDARD_TIMING_BLOCK + ERROR_MONITOR_INVALID_STANDARD_TIMING_BLOCK + + + + No documentation. + + + ERROR_MONITOR_WMI_DATABLOCK_REGISTRATION_FAILED + ERROR_MONITOR_WMI_DATABLOCK_REGISTRATION_FAILED + + + + No documentation. + + + ERROR_MONITOR_INVALID_SERIAL_NUMBER_MONDSC_BLOCK + ERROR_MONITOR_INVALID_SERIAL_NUMBER_MONDSC_BLOCK + + + + No documentation. + + + ERROR_MONITOR_INVALID_USER_FRIENDLY_MONDSC_BLOCK + ERROR_MONITOR_INVALID_USER_FRIENDLY_MONDSC_BLOCK + + + + No documentation. + + + ERROR_MONITOR_NO_MORE_DESCRIPTOR_DATA + ERROR_MONITOR_NO_MORE_DESCRIPTOR_DATA + + + + No documentation. + + + ERROR_MONITOR_INVALID_DETAILED_TIMING_BLOCK + ERROR_MONITOR_INVALID_DETAILED_TIMING_BLOCK + + + + No documentation. + + + ERROR_MONITOR_INVALID_MANUFACTURE_DATE + ERROR_MONITOR_INVALID_MANUFACTURE_DATE + + + + No documentation. + + + ERROR_GRAPHICS_NOT_EXCLUSIVE_MODE_OWNER + ERROR_GRAPHICS_NOT_EXCLUSIVE_MODE_OWNER + + + + No documentation. + + + ERROR_GRAPHICS_INSUFFICIENT_DMA_BUFFER + ERROR_GRAPHICS_INSUFFICIENT_DMA_BUFFER + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_DISPLAY_ADAPTER + ERROR_GRAPHICS_INVALID_DISPLAY_ADAPTER + + + + No documentation. + + + ERROR_GRAPHICS_ADAPTER_WAS_RESET + ERROR_GRAPHICS_ADAPTER_WAS_RESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_DRIVER_MODEL + ERROR_GRAPHICS_INVALID_DRIVER_MODEL + + + + No documentation. + + + ERROR_GRAPHICS_PRESENT_MODE_CHANGED + ERROR_GRAPHICS_PRESENT_MODE_CHANGED + + + + No documentation. + + + ERROR_GRAPHICS_PRESENT_OCCLUDED + ERROR_GRAPHICS_PRESENT_OCCLUDED + + + + No documentation. + + + ERROR_GRAPHICS_PRESENT_DENIED + ERROR_GRAPHICS_PRESENT_DENIED + + + + No documentation. + + + ERROR_GRAPHICS_CANNOTCOLORCONVERT + ERROR_GRAPHICS_CANNOTCOLORCONVERT + + + + No documentation. + + + ERROR_GRAPHICS_DRIVER_MISMATCH + ERROR_GRAPHICS_DRIVER_MISMATCH + + + + No documentation. + + + ERROR_GRAPHICS_PARTIAL_DATA_POPULATED + ERROR_GRAPHICS_PARTIAL_DATA_POPULATED + + + + No documentation. + + + ERROR_GRAPHICS_PRESENT_REDIRECTION_DISABLED + ERROR_GRAPHICS_PRESENT_REDIRECTION_DISABLED + + + + No documentation. + + + ERROR_GRAPHICS_PRESENT_UNOCCLUDED + ERROR_GRAPHICS_PRESENT_UNOCCLUDED + + + + No documentation. + + + ERROR_GRAPHICS_NO_VIDEO_MEMORY + ERROR_GRAPHICS_NO_VIDEO_MEMORY + + + + No documentation. + + + ERROR_GRAPHICS_CANT_LOCK_MEMORY + ERROR_GRAPHICS_CANT_LOCK_MEMORY + + + + No documentation. + + + ERROR_GRAPHICS_ALLOCATION_BUSY + ERROR_GRAPHICS_ALLOCATION_BUSY + + + + No documentation. + + + ERROR_GRAPHICS_TOO_MANY_REFERENCES + ERROR_GRAPHICS_TOO_MANY_REFERENCES + + + + No documentation. + + + ERROR_GRAPHICS_TRY_AGAIN_LATER + ERROR_GRAPHICS_TRY_AGAIN_LATER + + + + No documentation. + + + ERROR_GRAPHICS_TRY_AGAIN_NOW + ERROR_GRAPHICS_TRY_AGAIN_NOW + + + + No documentation. + + + ERROR_GRAPHICS_ALLOCATION_INVALID + ERROR_GRAPHICS_ALLOCATION_INVALID + + + + No documentation. + + + ERROR_GRAPHICS_UNSWIZZLING_APERTURE_UNAVAILABLE + ERROR_GRAPHICS_UNSWIZZLING_APERTURE_UNAVAILABLE + + + + No documentation. + + + ERROR_GRAPHICS_UNSWIZZLING_APERTURE_UNSUPPORTED + ERROR_GRAPHICS_UNSWIZZLING_APERTURE_UNSUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_CANT_EVICT_PINNED_ALLOCATION + ERROR_GRAPHICS_CANT_EVICT_PINNED_ALLOCATION + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_ALLOCATION_USAGE + ERROR_GRAPHICS_INVALID_ALLOCATION_USAGE + + + + No documentation. + + + ERROR_GRAPHICS_CANT_RENDER_LOCKED_ALLOCATION + ERROR_GRAPHICS_CANT_RENDER_LOCKED_ALLOCATION + + + + No documentation. + + + ERROR_GRAPHICS_ALLOCATION_CLOSED + ERROR_GRAPHICS_ALLOCATION_CLOSED + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_ALLOCATION_INSTANCE + ERROR_GRAPHICS_INVALID_ALLOCATION_INSTANCE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_ALLOCATION_HANDLE + ERROR_GRAPHICS_INVALID_ALLOCATION_HANDLE + + + + No documentation. + + + ERROR_GRAPHICS_WRONG_ALLOCATION_DEVICE + ERROR_GRAPHICS_WRONG_ALLOCATION_DEVICE + + + + No documentation. + + + ERROR_GRAPHICS_ALLOCATION_CONTENT_LOST + ERROR_GRAPHICS_ALLOCATION_CONTENT_LOST + + + + No documentation. + + + ERROR_GRAPHICS_GPU_EXCEPTION_ON_DEVICE + ERROR_GRAPHICS_GPU_EXCEPTION_ON_DEVICE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDPN_TOPOLOGY + ERROR_GRAPHICS_INVALID_VIDPN_TOPOLOGY + + + + No documentation. + + + ERROR_GRAPHICS_VIDPN_TOPOLOGY_NOT_SUPPORTED + ERROR_GRAPHICS_VIDPN_TOPOLOGY_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_VIDPN_TOPOLOGY_CURRENTLY_NOT_SUPPORTED + ERROR_GRAPHICS_VIDPN_TOPOLOGY_CURRENTLY_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDPN + ERROR_GRAPHICS_INVALID_VIDPN + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET + + + + No documentation. + + + ERROR_GRAPHICS_VIDPN_MODALITY_NOT_SUPPORTED + ERROR_GRAPHICS_VIDPN_MODALITY_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_MODE_NOT_PINNED + ERROR_GRAPHICS_MODE_NOT_PINNED + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDPN_SOURCEMODESET + ERROR_GRAPHICS_INVALID_VIDPN_SOURCEMODESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDPN_TARGETMODESET + ERROR_GRAPHICS_INVALID_VIDPN_TARGETMODESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_FREQUENCY + ERROR_GRAPHICS_INVALID_FREQUENCY + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_ACTIVE_REGION + ERROR_GRAPHICS_INVALID_ACTIVE_REGION + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_TOTAL_REGION + ERROR_GRAPHICS_INVALID_TOTAL_REGION + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE_MODE + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE_MODE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET_MODE + ERROR_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET_MODE + + + + No documentation. + + + ERROR_GRAPHICS_PINNED_MODE_MUST_REMAIN_IN_SET + ERROR_GRAPHICS_PINNED_MODE_MUST_REMAIN_IN_SET + + + + No documentation. + + + ERROR_GRAPHICS_PATH_ALREADY_IN_TOPOLOGY + ERROR_GRAPHICS_PATH_ALREADY_IN_TOPOLOGY + + + + No documentation. + + + ERROR_GRAPHICS_MODE_ALREADY_IN_MODESET + ERROR_GRAPHICS_MODE_ALREADY_IN_MODESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDEOPRESENTSOURCESET + ERROR_GRAPHICS_INVALID_VIDEOPRESENTSOURCESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDEOPRESENTTARGETSET + ERROR_GRAPHICS_INVALID_VIDEOPRESENTTARGETSET + + + + No documentation. + + + ERROR_GRAPHICS_SOURCE_ALREADY_IN_SET + ERROR_GRAPHICS_SOURCE_ALREADY_IN_SET + + + + No documentation. + + + ERROR_GRAPHICS_TARGET_ALREADY_IN_SET + ERROR_GRAPHICS_TARGET_ALREADY_IN_SET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDPN_PRESENT_PATH + ERROR_GRAPHICS_INVALID_VIDPN_PRESENT_PATH + + + + No documentation. + + + ERROR_GRAPHICS_NO_RECOMMENDED_VIDPN_TOPOLOGY + ERROR_GRAPHICS_NO_RECOMMENDED_VIDPN_TOPOLOGY + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGESET + ERROR_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE + ERROR_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE + + + + No documentation. + + + ERROR_GRAPHICS_FREQUENCYRANGE_NOT_IN_SET + ERROR_GRAPHICS_FREQUENCYRANGE_NOT_IN_SET + + + + No documentation. + + + ERROR_GRAPHICS_NO_PREFERRED_MODE + ERROR_GRAPHICS_NO_PREFERRED_MODE + + + + No documentation. + + + ERROR_GRAPHICS_FREQUENCYRANGE_ALREADY_IN_SET + ERROR_GRAPHICS_FREQUENCYRANGE_ALREADY_IN_SET + + + + No documentation. + + + ERROR_GRAPHICS_STALE_MODESET + ERROR_GRAPHICS_STALE_MODESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITOR_SOURCEMODESET + ERROR_GRAPHICS_INVALID_MONITOR_SOURCEMODESET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITOR_SOURCE_MODE + ERROR_GRAPHICS_INVALID_MONITOR_SOURCE_MODE + + + + No documentation. + + + ERROR_GRAPHICS_NO_RECOMMENDED_FUNCTIONAL_VIDPN + ERROR_GRAPHICS_NO_RECOMMENDED_FUNCTIONAL_VIDPN + + + + No documentation. + + + ERROR_GRAPHICS_MODE_ID_MUST_BE_UNIQUE + ERROR_GRAPHICS_MODE_ID_MUST_BE_UNIQUE + + + + No documentation. + + + ERROR_GRAPHICS_EMPTY_ADAPTER_MONITOR_MODE_SUPPORT_INTERSECTION + ERROR_GRAPHICS_EMPTY_ADAPTER_MONITOR_MODE_SUPPORT_INTERSECTION + + + + No documentation. + + + ERROR_GRAPHICS_VIDEO_PRESENT_TARGETS_LESS_THAN_SOURCES + ERROR_GRAPHICS_VIDEO_PRESENT_TARGETS_LESS_THAN_SOURCES + + + + No documentation. + + + ERROR_GRAPHICS_PATH_NOT_IN_TOPOLOGY + ERROR_GRAPHICS_PATH_NOT_IN_TOPOLOGY + + + + No documentation. + + + ERROR_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_SOURCE + ERROR_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_SOURCE + + + + No documentation. + + + ERROR_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_TARGET + ERROR_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_TARGET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITORDESCRIPTORSET + ERROR_GRAPHICS_INVALID_MONITORDESCRIPTORSET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITORDESCRIPTOR + ERROR_GRAPHICS_INVALID_MONITORDESCRIPTOR + + + + No documentation. + + + ERROR_GRAPHICS_MONITORDESCRIPTOR_NOT_IN_SET + ERROR_GRAPHICS_MONITORDESCRIPTOR_NOT_IN_SET + + + + No documentation. + + + ERROR_GRAPHICS_MONITORDESCRIPTOR_ALREADY_IN_SET + ERROR_GRAPHICS_MONITORDESCRIPTOR_ALREADY_IN_SET + + + + No documentation. + + + ERROR_GRAPHICS_MONITORDESCRIPTOR_ID_MUST_BE_UNIQUE + ERROR_GRAPHICS_MONITORDESCRIPTOR_ID_MUST_BE_UNIQUE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDPN_TARGET_SUBSET_TYPE + ERROR_GRAPHICS_INVALID_VIDPN_TARGET_SUBSET_TYPE + + + + No documentation. + + + ERROR_GRAPHICS_RESOURCES_NOT_RELATED + ERROR_GRAPHICS_RESOURCES_NOT_RELATED + + + + No documentation. + + + ERROR_GRAPHICS_SOURCE_ID_MUST_BE_UNIQUE + ERROR_GRAPHICS_SOURCE_ID_MUST_BE_UNIQUE + + + + No documentation. + + + ERROR_GRAPHICS_TARGET_ID_MUST_BE_UNIQUE + ERROR_GRAPHICS_TARGET_ID_MUST_BE_UNIQUE + + + + No documentation. + + + ERROR_GRAPHICS_NO_AVAILABLE_VIDPN_TARGET + ERROR_GRAPHICS_NO_AVAILABLE_VIDPN_TARGET + + + + No documentation. + + + ERROR_GRAPHICS_MONITOR_COULD_NOT_BE_ASSOCIATED_WITH_ADAPTER + ERROR_GRAPHICS_MONITOR_COULD_NOT_BE_ASSOCIATED_WITH_ADAPTER + + + + No documentation. + + + ERROR_GRAPHICS_NO_VIDPNMGR + ERROR_GRAPHICS_NO_VIDPNMGR + + + + No documentation. + + + ERROR_GRAPHICS_NO_ACTIVE_VIDPN + ERROR_GRAPHICS_NO_ACTIVE_VIDPN + + + + No documentation. + + + ERROR_GRAPHICS_STALE_VIDPN_TOPOLOGY + ERROR_GRAPHICS_STALE_VIDPN_TOPOLOGY + + + + No documentation. + + + ERROR_GRAPHICS_MONITOR_NOT_CONNECTED + ERROR_GRAPHICS_MONITOR_NOT_CONNECTED + + + + No documentation. + + + ERROR_GRAPHICS_SOURCE_NOT_IN_TOPOLOGY + ERROR_GRAPHICS_SOURCE_NOT_IN_TOPOLOGY + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_PRIMARYSURFACE_SIZE + ERROR_GRAPHICS_INVALID_PRIMARYSURFACE_SIZE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VISIBLEREGION_SIZE + ERROR_GRAPHICS_INVALID_VISIBLEREGION_SIZE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_STRIDE + ERROR_GRAPHICS_INVALID_STRIDE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_PIXELFORMAT + ERROR_GRAPHICS_INVALID_PIXELFORMAT + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_COLORBASIS + ERROR_GRAPHICS_INVALID_COLORBASIS + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_PIXELVALUEACCESSMODE + ERROR_GRAPHICS_INVALID_PIXELVALUEACCESSMODE + + + + No documentation. + + + ERROR_GRAPHICS_TARGET_NOT_IN_TOPOLOGY + ERROR_GRAPHICS_TARGET_NOT_IN_TOPOLOGY + + + + No documentation. + + + ERROR_GRAPHICS_NO_DISPLAY_MODE_MANAGEMENT_SUPPORT + ERROR_GRAPHICS_NO_DISPLAY_MODE_MANAGEMENT_SUPPORT + + + + No documentation. + + + ERROR_GRAPHICS_VIDPN_SOURCE_IN_USE + ERROR_GRAPHICS_VIDPN_SOURCE_IN_USE + + + + No documentation. + + + ERROR_GRAPHICS_CANT_ACCESS_ACTIVE_VIDPN + ERROR_GRAPHICS_CANT_ACCESS_ACTIVE_VIDPN + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_PATH_IMPORTANCE_ORDINAL + ERROR_GRAPHICS_INVALID_PATH_IMPORTANCE_ORDINAL + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_PATH_CONTENT_GEOMETRY_TRANSFORMATION + ERROR_GRAPHICS_INVALID_PATH_CONTENT_GEOMETRY_TRANSFORMATION + + + + No documentation. + + + ERROR_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_SUPPORTED + ERROR_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_GAMMA_RAMP + ERROR_GRAPHICS_INVALID_GAMMA_RAMP + + + + No documentation. + + + ERROR_GRAPHICS_GAMMA_RAMP_NOT_SUPPORTED + ERROR_GRAPHICS_GAMMA_RAMP_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_MULTISAMPLING_NOT_SUPPORTED + ERROR_GRAPHICS_MULTISAMPLING_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_MODE_NOT_IN_MODESET + ERROR_GRAPHICS_MODE_NOT_IN_MODESET + + + + No documentation. + + + ERROR_GRAPHICS_DATASET_IS_EMPTY + ERROR_GRAPHICS_DATASET_IS_EMPTY + + + + No documentation. + + + ERROR_GRAPHICS_NO_MORE_ELEMENTS_IN_DATASET + ERROR_GRAPHICS_NO_MORE_ELEMENTS_IN_DATASET + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_VIDPN_TOPOLOGY_RECOMMENDATION_REASON + ERROR_GRAPHICS_INVALID_VIDPN_TOPOLOGY_RECOMMENDATION_REASON + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_PATH_CONTENT_TYPE + ERROR_GRAPHICS_INVALID_PATH_CONTENT_TYPE + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_COPYPROTECTION_TYPE + ERROR_GRAPHICS_INVALID_COPYPROTECTION_TYPE + + + + No documentation. + + + ERROR_GRAPHICS_UNASSIGNED_MODESET_ALREADY_EXISTS + ERROR_GRAPHICS_UNASSIGNED_MODESET_ALREADY_EXISTS + + + + No documentation. + + + ERROR_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_PINNED + ERROR_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_PINNED + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_SCANLINE_ORDERING + ERROR_GRAPHICS_INVALID_SCANLINE_ORDERING + + + + No documentation. + + + ERROR_GRAPHICS_TOPOLOGY_CHANGES_NOT_ALLOWED + ERROR_GRAPHICS_TOPOLOGY_CHANGES_NOT_ALLOWED + + + + No documentation. + + + ERROR_GRAPHICS_NO_AVAILABLE_IMPORTANCE_ORDINALS + ERROR_GRAPHICS_NO_AVAILABLE_IMPORTANCE_ORDINALS + + + + No documentation. + + + ERROR_GRAPHICS_INCOMPATIBLE_PRIVATE_FORMAT + ERROR_GRAPHICS_INCOMPATIBLE_PRIVATE_FORMAT + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MODE_PRUNING_ALGORITHM + ERROR_GRAPHICS_INVALID_MODE_PRUNING_ALGORITHM + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITOR_CAPABILITY_ORIGIN + ERROR_GRAPHICS_INVALID_MONITOR_CAPABILITY_ORIGIN + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE_CONSTRAINT + ERROR_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE_CONSTRAINT + + + + No documentation. + + + ERROR_GRAPHICS_MAX_NUM_PATHS_REACHED + ERROR_GRAPHICS_MAX_NUM_PATHS_REACHED + + + + No documentation. + + + ERROR_GRAPHICS_CANCEL_VIDPN_TOPOLOGY_AUGMENTATION + ERROR_GRAPHICS_CANCEL_VIDPN_TOPOLOGY_AUGMENTATION + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_CLIENT_TYPE + ERROR_GRAPHICS_INVALID_CLIENT_TYPE + + + + No documentation. + + + ERROR_GRAPHICS_CLIENTVIDPN_NOT_SET + ERROR_GRAPHICS_CLIENTVIDPN_NOT_SET + + + + No documentation. + + + ERROR_GRAPHICS_SPECIFIED_CHILD_ALREADY_CONNECTED + ERROR_GRAPHICS_SPECIFIED_CHILD_ALREADY_CONNECTED + + + + No documentation. + + + ERROR_GRAPHICS_CHILD_DESCRIPTOR_NOT_SUPPORTED + ERROR_GRAPHICS_CHILD_DESCRIPTOR_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_UNKNOWN_CHILD_STATUS + ERROR_GRAPHICS_UNKNOWN_CHILD_STATUS + + + + No documentation. + + + ERROR_GRAPHICS_NOT_A_LINKED_ADAPTER + ERROR_GRAPHICS_NOT_A_LINKED_ADAPTER + + + + No documentation. + + + ERROR_GRAPHICS_LEADLINK_NOT_ENUMERATED + ERROR_GRAPHICS_LEADLINK_NOT_ENUMERATED + + + + No documentation. + + + ERROR_GRAPHICS_CHAINLINKS_NOT_ENUMERATED + ERROR_GRAPHICS_CHAINLINKS_NOT_ENUMERATED + + + + No documentation. + + + ERROR_GRAPHICS_ADAPTER_CHAIN_NOT_READY + ERROR_GRAPHICS_ADAPTER_CHAIN_NOT_READY + + + + No documentation. + + + ERROR_GRAPHICS_CHAINLINKS_NOT_STARTED + ERROR_GRAPHICS_CHAINLINKS_NOT_STARTED + + + + No documentation. + + + ERROR_GRAPHICS_CHAINLINKS_NOT_POWERED_ON + ERROR_GRAPHICS_CHAINLINKS_NOT_POWERED_ON + + + + No documentation. + + + ERROR_GRAPHICS_INCONSISTENT_DEVICE_LINK_STATE + ERROR_GRAPHICS_INCONSISTENT_DEVICE_LINK_STATE + + + + No documentation. + + + ERROR_GRAPHICS_LEADLINK_START_DEFERRED + ERROR_GRAPHICS_LEADLINK_START_DEFERRED + + + + No documentation. + + + ERROR_GRAPHICS_NOT_POST_DEVICE_DRIVER + ERROR_GRAPHICS_NOT_POST_DEVICE_DRIVER + + + + No documentation. + + + ERROR_GRAPHICS_POLLING_TOO_FREQUENTLY + ERROR_GRAPHICS_POLLING_TOO_FREQUENTLY + + + + No documentation. + + + ERROR_GRAPHICS_START_DEFERRED + ERROR_GRAPHICS_START_DEFERRED + + + + No documentation. + + + ERROR_GRAPHICS_ADAPTER_ACCESS_NOT_EXCLUDED + ERROR_GRAPHICS_ADAPTER_ACCESS_NOT_EXCLUDED + + + + No documentation. + + + ERROR_GRAPHICS_OPM_NOT_SUPPORTED + ERROR_GRAPHICS_OPM_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_COPP_NOT_SUPPORTED + ERROR_GRAPHICS_COPP_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_UAB_NOT_SUPPORTED + ERROR_GRAPHICS_UAB_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_OPM_INVALID_ENCRYPTED_PARAMETERS + ERROR_GRAPHICS_OPM_INVALID_ENCRYPTED_PARAMETERS + + + + No documentation. + + + ERROR_GRAPHICS_OPM_NO_VIDEO_OUTPUTS_EXIST + ERROR_GRAPHICS_OPM_NO_VIDEO_OUTPUTS_EXIST + + + + No documentation. + + + ERROR_GRAPHICS_OPM_INTERNAL_ERROR + ERROR_GRAPHICS_OPM_INTERNAL_ERROR + + + + No documentation. + + + ERROR_GRAPHICS_OPM_INVALID_HANDLE + ERROR_GRAPHICS_OPM_INVALID_HANDLE + + + + No documentation. + + + ERROR_GRAPHICS_PVP_INVALID_CERTIFICATE_LENGTH + ERROR_GRAPHICS_PVP_INVALID_CERTIFICATE_LENGTH + + + + No documentation. + + + ERROR_GRAPHICS_OPM_SPANNING_MODE_ENABLED + ERROR_GRAPHICS_OPM_SPANNING_MODE_ENABLED + + + + No documentation. + + + ERROR_GRAPHICS_OPM_THEATER_MODE_ENABLED + ERROR_GRAPHICS_OPM_THEATER_MODE_ENABLED + + + + No documentation. + + + ERROR_GRAPHICS_PVP_HFS_FAILED + ERROR_GRAPHICS_PVP_HFS_FAILED + + + + No documentation. + + + ERROR_GRAPHICS_OPM_INVALID_SRM + ERROR_GRAPHICS_OPM_INVALID_SRM + + + + No documentation. + + + ERROR_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_HDCP + ERROR_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_HDCP + + + + No documentation. + + + ERROR_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_ACP + ERROR_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_ACP + + + + No documentation. + + + ERROR_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_CGMSA + ERROR_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_CGMSA + + + + No documentation. + + + ERROR_GRAPHICS_OPM_HDCP_SRM_NEVER_SET + ERROR_GRAPHICS_OPM_HDCP_SRM_NEVER_SET + + + + No documentation. + + + ERROR_GRAPHICS_OPM_RESOLUTION_TOO_HIGH + ERROR_GRAPHICS_OPM_RESOLUTION_TOO_HIGH + + + + No documentation. + + + ERROR_GRAPHICS_OPM_ALL_HDCP_HARDWARE_ALREADY_IN_USE + ERROR_GRAPHICS_OPM_ALL_HDCP_HARDWARE_ALREADY_IN_USE + + + + No documentation. + + + ERROR_GRAPHICS_OPM_VIDEO_OUTPUT_NO_LONGER_EXISTS + ERROR_GRAPHICS_OPM_VIDEO_OUTPUT_NO_LONGER_EXISTS + + + + No documentation. + + + ERROR_GRAPHICS_OPM_SESSION_TYPE_CHANGE_IN_PROGRESS + ERROR_GRAPHICS_OPM_SESSION_TYPE_CHANGE_IN_PROGRESS + + + + No documentation. + + + ERROR_GRAPHICS_OPM_VIDEO_OUTPUT_DOES_NOT_HAVE_COPP_SEMANTICS + ERROR_GRAPHICS_OPM_VIDEO_OUTPUT_DOES_NOT_HAVE_COPP_SEMANTICS + + + + No documentation. + + + ERROR_GRAPHICS_OPM_INVALID_INFORMATION_REQUEST + ERROR_GRAPHICS_OPM_INVALID_INFORMATION_REQUEST + + + + No documentation. + + + ERROR_GRAPHICS_OPM_DRIVER_INTERNAL_ERROR + ERROR_GRAPHICS_OPM_DRIVER_INTERNAL_ERROR + + + + No documentation. + + + ERROR_GRAPHICS_OPM_VIDEO_OUTPUT_DOES_NOT_HAVE_OPM_SEMANTICS + ERROR_GRAPHICS_OPM_VIDEO_OUTPUT_DOES_NOT_HAVE_OPM_SEMANTICS + + + + No documentation. + + + ERROR_GRAPHICS_OPM_SIGNALING_NOT_SUPPORTED + ERROR_GRAPHICS_OPM_SIGNALING_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_OPM_INVALID_CONFIGURATION_REQUEST + ERROR_GRAPHICS_OPM_INVALID_CONFIGURATION_REQUEST + + + + No documentation. + + + ERROR_GRAPHICS_I2C_NOT_SUPPORTED + ERROR_GRAPHICS_I2C_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_I2C_DEVICE_DOES_NOT_EXIST + ERROR_GRAPHICS_I2C_DEVICE_DOES_NOT_EXIST + + + + No documentation. + + + ERROR_GRAPHICS_I2C_ERROR_TRANSMITTING_DATA + ERROR_GRAPHICS_I2C_ERROR_TRANSMITTING_DATA + + + + No documentation. + + + ERROR_GRAPHICS_I2C_ERROR_RECEIVING_DATA + ERROR_GRAPHICS_I2C_ERROR_RECEIVING_DATA + + + + No documentation. + + + ERROR_GRAPHICS_DDCCI_VCP_NOT_SUPPORTED + ERROR_GRAPHICS_DDCCI_VCP_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_DDCCI_INVALID_DATA + ERROR_GRAPHICS_DDCCI_INVALID_DATA + + + + No documentation. + + + ERROR_GRAPHICS_DDCCI_MONITOR_RETURNED_INVALID_TIMING_STATUS_BYTE + ERROR_GRAPHICS_DDCCI_MONITOR_RETURNED_INVALID_TIMING_STATUS_BYTE + + + + No documentation. + + + ERROR_GRAPHICS_MCA_INVALID_CAPABILITIES_STRING + ERROR_GRAPHICS_MCA_INVALID_CAPABILITIES_STRING + + + + No documentation. + + + ERROR_GRAPHICS_MCA_INTERNAL_ERROR + ERROR_GRAPHICS_MCA_INTERNAL_ERROR + + + + No documentation. + + + ERROR_GRAPHICS_DDCCI_INVALID_MESSAGE_COMMAND + ERROR_GRAPHICS_DDCCI_INVALID_MESSAGE_COMMAND + + + + No documentation. + + + ERROR_GRAPHICS_DDCCI_INVALID_MESSAGE_LENGTH + ERROR_GRAPHICS_DDCCI_INVALID_MESSAGE_LENGTH + + + + No documentation. + + + ERROR_GRAPHICS_DDCCI_INVALID_MESSAGE_CHECKSUM + ERROR_GRAPHICS_DDCCI_INVALID_MESSAGE_CHECKSUM + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_PHYSICAL_MONITOR_HANDLE + ERROR_GRAPHICS_INVALID_PHYSICAL_MONITOR_HANDLE + + + + No documentation. + + + ERROR_GRAPHICS_MONITOR_NO_LONGER_EXISTS + ERROR_GRAPHICS_MONITOR_NO_LONGER_EXISTS + + + + No documentation. + + + ERROR_GRAPHICS_DDCCI_CURRENT_CURRENT_VALUE_GREATER_THAN_MAXIMUM_VALUE + ERROR_GRAPHICS_DDCCI_CURRENT_CURRENT_VALUE_GREATER_THAN_MAXIMUM_VALUE + + + + No documentation. + + + ERROR_GRAPHICS_MCA_INVALID_VCP_VERSION + ERROR_GRAPHICS_MCA_INVALID_VCP_VERSION + + + + No documentation. + + + ERROR_GRAPHICS_MCA_MONITOR_VIOLATES_MCCS_SPECIFICATION + ERROR_GRAPHICS_MCA_MONITOR_VIOLATES_MCCS_SPECIFICATION + + + + No documentation. + + + ERROR_GRAPHICS_MCA_MCCS_VERSION_MISMATCH + ERROR_GRAPHICS_MCA_MCCS_VERSION_MISMATCH + + + + No documentation. + + + ERROR_GRAPHICS_MCA_UNSUPPORTED_MCCS_VERSION + ERROR_GRAPHICS_MCA_UNSUPPORTED_MCCS_VERSION + + + + No documentation. + + + ERROR_GRAPHICS_MCA_INVALID_TECHNOLOGY_TYPE_RETURNED + ERROR_GRAPHICS_MCA_INVALID_TECHNOLOGY_TYPE_RETURNED + + + + No documentation. + + + ERROR_GRAPHICS_MCA_UNSUPPORTED_COLOR_TEMPERATURE + ERROR_GRAPHICS_MCA_UNSUPPORTED_COLOR_TEMPERATURE + + + + No documentation. + + + ERROR_GRAPHICS_ONLY_CONSOLE_SESSION_SUPPORTED + ERROR_GRAPHICS_ONLY_CONSOLE_SESSION_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_NO_DISPLAY_DEVICE_CORRESPONDS_TO_NAME + ERROR_GRAPHICS_NO_DISPLAY_DEVICE_CORRESPONDS_TO_NAME + + + + No documentation. + + + ERROR_GRAPHICS_DISPLAY_DEVICE_NOT_ATTACHED_TO_DESKTOP + ERROR_GRAPHICS_DISPLAY_DEVICE_NOT_ATTACHED_TO_DESKTOP + + + + No documentation. + + + ERROR_GRAPHICS_MIRRORING_DEVICES_NOT_SUPPORTED + ERROR_GRAPHICS_MIRRORING_DEVICES_NOT_SUPPORTED + + + + No documentation. + + + ERROR_GRAPHICS_INVALID_POINTER + ERROR_GRAPHICS_INVALID_POINTER + + + + No documentation. + + + ERROR_GRAPHICS_NO_MONITORS_CORRESPOND_TO_DISPLAY_DEVICE + ERROR_GRAPHICS_NO_MONITORS_CORRESPOND_TO_DISPLAY_DEVICE + + + + No documentation. + + + ERROR_GRAPHICS_PARAMETER_ARRAY_TOO_SMALL + ERROR_GRAPHICS_PARAMETER_ARRAY_TOO_SMALL + + + + No documentation. + + + ERROR_GRAPHICS_INTERNAL_ERROR + ERROR_GRAPHICS_INTERNAL_ERROR + + + + No documentation. + + + ERROR_GRAPHICS_SESSION_TYPE_CHANGE_IN_PROGRESS + ERROR_GRAPHICS_SESSION_TYPE_CHANGE_IN_PROGRESS + + + + No documentation. + + + ERROR_NDIS_INTERFACE_CLOSING + ERROR_NDIS_INTERFACE_CLOSING + + + + No documentation. + + + ERROR_NDIS_BAD_VERSION + ERROR_NDIS_BAD_VERSION + + + + No documentation. + + + ERROR_NDIS_BAD_CHARACTERISTICS + ERROR_NDIS_BAD_CHARACTERISTICS + + + + No documentation. + + + ERROR_NDIS_ADAPTER_NOT_FOUND + ERROR_NDIS_ADAPTER_NOT_FOUND + + + + No documentation. + + + ERROR_NDIS_OPEN_FAILED + ERROR_NDIS_OPEN_FAILED + + + + No documentation. + + + ERROR_NDIS_DEVICE_FAILED + ERROR_NDIS_DEVICE_FAILED + + + + No documentation. + + + ERROR_NDIS_MULTICAST_FULL + ERROR_NDIS_MULTICAST_FULL + + + + No documentation. + + + ERROR_NDIS_MULTICAST_EXISTS + ERROR_NDIS_MULTICAST_EXISTS + + + + No documentation. + + + ERROR_NDIS_MULTICAST_NOT_FOUND + ERROR_NDIS_MULTICAST_NOT_FOUND + + + + No documentation. + + + ERROR_NDIS_REQUEST_ABORTED + ERROR_NDIS_REQUEST_ABORTED + + + + No documentation. + + + ERROR_NDIS_RESET_IN_PROGRESS + ERROR_NDIS_RESET_IN_PROGRESS + + + + No documentation. + + + ERROR_NDIS_NOT_SUPPORTED + ERROR_NDIS_NOT_SUPPORTED + + + + No documentation. + + + ERROR_NDIS_INVALID_PACKET + ERROR_NDIS_INVALID_PACKET + + + + No documentation. + + + ERROR_NDIS_ADAPTER_NOT_READY + ERROR_NDIS_ADAPTER_NOT_READY + + + + No documentation. + + + ERROR_NDIS_INVALID_LENGTH + ERROR_NDIS_INVALID_LENGTH + + + + No documentation. + + + ERROR_NDIS_INVALID_DATA + ERROR_NDIS_INVALID_DATA + + + + No documentation. + + + ERROR_NDIS_BUFFER_TOO_SHORT + ERROR_NDIS_BUFFER_TOO_SHORT + + + + No documentation. + + + ERROR_NDIS_INVALID_OID + ERROR_NDIS_INVALID_OID + + + + No documentation. + + + ERROR_NDIS_ADAPTER_REMOVED + ERROR_NDIS_ADAPTER_REMOVED + + + + No documentation. + + + ERROR_NDIS_UNSUPPORTED_MEDIA + ERROR_NDIS_UNSUPPORTED_MEDIA + + + + No documentation. + + + ERROR_NDIS_GROUP_ADDRESS_IN_USE + ERROR_NDIS_GROUP_ADDRESS_IN_USE + + + + No documentation. + + + ERROR_NDIS_FILE_NOT_FOUND + ERROR_NDIS_FILE_NOT_FOUND + + + + No documentation. + + + ERROR_NDIS_ERROR_READING_FILE + ERROR_NDIS_ERROR_READING_FILE + + + + No documentation. + + + ERROR_NDIS_ALREADY_MAPPED + ERROR_NDIS_ALREADY_MAPPED + + + + No documentation. + + + ERROR_NDIS_RESOURCE_CONFLICT + ERROR_NDIS_RESOURCE_CONFLICT + + + + No documentation. + + + ERROR_NDIS_MEDIA_DISCONNECTED + ERROR_NDIS_MEDIA_DISCONNECTED + + + + No documentation. + + + ERROR_NDIS_INVALID_ADDRESS + ERROR_NDIS_INVALID_ADDRESS + + + + No documentation. + + + ERROR_NDIS_INVALID_DEVICE_REQUEST + ERROR_NDIS_INVALID_DEVICE_REQUEST + + + + No documentation. + + + ERROR_NDIS_PAUSED + ERROR_NDIS_PAUSED + + + + No documentation. + + + ERROR_NDIS_INTERFACE_NOT_FOUND + ERROR_NDIS_INTERFACE_NOT_FOUND + + + + No documentation. + + + ERROR_NDIS_UNSUPPORTED_REVISION + ERROR_NDIS_UNSUPPORTED_REVISION + + + + No documentation. + + + ERROR_NDIS_INVALID_PORT + ERROR_NDIS_INVALID_PORT + + + + No documentation. + + + ERROR_NDIS_INVALID_PORT_STATE + ERROR_NDIS_INVALID_PORT_STATE + + + + No documentation. + + + ERROR_NDIS_LOW_POWER_STATE + ERROR_NDIS_LOW_POWER_STATE + + + + No documentation. + + + ERROR_NDIS_DOT11_AUTO_CONFIG_ENABLED + ERROR_NDIS_DOT11_AUTO_CONFIG_ENABLED + + + + No documentation. + + + ERROR_NDIS_DOT11_MEDIA_IN_USE + ERROR_NDIS_DOT11_MEDIA_IN_USE + + + + No documentation. + + + ERROR_NDIS_DOT11_POWER_STATE_INVALID + ERROR_NDIS_DOT11_POWER_STATE_INVALID + + + + No documentation. + + + ERROR_NDIS_PM_WOL_PATTERN_LIST_FULL + ERROR_NDIS_PM_WOL_PATTERN_LIST_FULL + + + + No documentation. + + + ERROR_NDIS_PM_PROTOCOL_OFFLOAD_LIST_FULL + ERROR_NDIS_PM_PROTOCOL_OFFLOAD_LIST_FULL + + + + No documentation. + + + ERROR_NDIS_INDICATION_REQUIRED + ERROR_NDIS_INDICATION_REQUIRED + + + + No documentation. + + + ERROR_NDIS_OFFLOAD_POLICY + ERROR_NDIS_OFFLOAD_POLICY + + + + No documentation. + + + ERROR_NDIS_OFFLOAD_CONNECTION_REJECTED + ERROR_NDIS_OFFLOAD_CONNECTION_REJECTED + + + + No documentation. + + + ERROR_NDIS_OFFLOAD_PATH_REJECTED + ERROR_NDIS_OFFLOAD_PATH_REJECTED + + + + No documentation. + + + ERROR_HV_INVALID_HYPERCALL_CODE + ERROR_HV_INVALID_HYPERCALL_CODE + + + + No documentation. + + + ERROR_HV_INVALID_HYPERCALL_INPUT + ERROR_HV_INVALID_HYPERCALL_INPUT + + + + No documentation. + + + ERROR_HV_INVALID_ALIGNMENT + ERROR_HV_INVALID_ALIGNMENT + + + + No documentation. + + + ERROR_HV_INVALID_PARAMETER + ERROR_HV_INVALID_PARAMETER + + + + No documentation. + + + ERROR_HV_ACCESS_DENIED + ERROR_HV_ACCESS_DENIED + + + + No documentation. + + + ERROR_HV_INVALID_PARTITION_STATE + ERROR_HV_INVALID_PARTITION_STATE + + + + No documentation. + + + ERROR_HV_OPERATION_DENIED + ERROR_HV_OPERATION_DENIED + + + + No documentation. + + + ERROR_HV_UNKNOWN_PROPERTY + ERROR_HV_UNKNOWN_PROPERTY + + + + No documentation. + + + ERROR_HV_PROPERTY_VALUE_OUT_OF_RANGE + ERROR_HV_PROPERTY_VALUE_OUT_OF_RANGE + + + + No documentation. + + + ERROR_HV_INSUFFICIENT_MEMORY + ERROR_HV_INSUFFICIENT_MEMORY + + + + No documentation. + + + ERROR_HV_PARTITION_TOO_DEEP + ERROR_HV_PARTITION_TOO_DEEP + + + + No documentation. + + + ERROR_HV_INVALID_PARTITION_ID + ERROR_HV_INVALID_PARTITION_ID + + + + No documentation. + + + ERROR_HV_INVALID_VP_INDEX + ERROR_HV_INVALID_VP_INDEX + + + + No documentation. + + + ERROR_HV_INVALID_PORT_ID + ERROR_HV_INVALID_PORT_ID + + + + No documentation. + + + ERROR_HV_INVALID_CONNECTION_ID + ERROR_HV_INVALID_CONNECTION_ID + + + + No documentation. + + + ERROR_HV_INSUFFICIENT_BUFFERS + ERROR_HV_INSUFFICIENT_BUFFERS + + + + No documentation. + + + ERROR_HV_NOT_ACKNOWLEDGED + ERROR_HV_NOT_ACKNOWLEDGED + + + + No documentation. + + + ERROR_HV_ACKNOWLEDGED + ERROR_HV_ACKNOWLEDGED + + + + No documentation. + + + ERROR_HV_INVALID_SAVE_RESTORE_STATE + ERROR_HV_INVALID_SAVE_RESTORE_STATE + + + + No documentation. + + + ERROR_HV_INVALID_SYNIC_STATE + ERROR_HV_INVALID_SYNIC_STATE + + + + No documentation. + + + ERROR_HV_OBJECT_IN_USE + ERROR_HV_OBJECT_IN_USE + + + + No documentation. + + + ERROR_HV_INVALID_PROXIMITY_DOMAIN_INFO + ERROR_HV_INVALID_PROXIMITY_DOMAIN_INFO + + + + No documentation. + + + ERROR_HV_NO_DATA + ERROR_HV_NO_DATA + + + + No documentation. + + + ERROR_HV_INACTIVE + ERROR_HV_INACTIVE + + + + No documentation. + + + ERROR_HV_NO_RESOURCES + ERROR_HV_NO_RESOURCES + + + + No documentation. + + + ERROR_HV_FEATURE_UNAVAILABLE + ERROR_HV_FEATURE_UNAVAILABLE + + + + No documentation. + + + ERROR_HV_NOT_PRESENT + ERROR_HV_NOT_PRESENT + + + + No documentation. + + + ERROR_VID_DUPLICATE_HANDLER + ERROR_VID_DUPLICATE_HANDLER + + + + No documentation. + + + ERROR_VID_TOO_MANY_HANDLERS + ERROR_VID_TOO_MANY_HANDLERS + + + + No documentation. + + + ERROR_VID_QUEUE_FULL + ERROR_VID_QUEUE_FULL + + + + No documentation. + + + ERROR_VID_HANDLER_NOT_PRESENT + ERROR_VID_HANDLER_NOT_PRESENT + + + + No documentation. + + + ERROR_VID_INVALID_OBJECT_NAME + ERROR_VID_INVALID_OBJECT_NAME + + + + No documentation. + + + ERROR_VID_PARTITION_NAME_TOO_LONG + ERROR_VID_PARTITION_NAME_TOO_LONG + + + + No documentation. + + + ERROR_VID_MESSAGE_QUEUE_NAME_TOO_LONG + ERROR_VID_MESSAGE_QUEUE_NAME_TOO_LONG + + + + No documentation. + + + ERROR_VID_PARTITION_ALREADY_EXISTS + ERROR_VID_PARTITION_ALREADY_EXISTS + + + + No documentation. + + + ERROR_VID_PARTITION_DOES_NOT_EXIST + ERROR_VID_PARTITION_DOES_NOT_EXIST + + + + No documentation. + + + ERROR_VID_PARTITION_NAME_NOT_FOUND + ERROR_VID_PARTITION_NAME_NOT_FOUND + + + + No documentation. + + + ERROR_VID_MESSAGE_QUEUE_ALREADY_EXISTS + ERROR_VID_MESSAGE_QUEUE_ALREADY_EXISTS + + + + No documentation. + + + ERROR_VID_EXCEEDED_MBP_ENTRY_MAP_LIMIT + ERROR_VID_EXCEEDED_MBP_ENTRY_MAP_LIMIT + + + + No documentation. + + + ERROR_VID_MB_STILL_REFERENCED + ERROR_VID_MB_STILL_REFERENCED + + + + No documentation. + + + ERROR_VID_CHILD_GPA_PAGE_SET_CORRUPTED + ERROR_VID_CHILD_GPA_PAGE_SET_CORRUPTED + + + + No documentation. + + + ERROR_VID_INVALID_NUMA_SETTINGS + ERROR_VID_INVALID_NUMA_SETTINGS + + + + No documentation. + + + ERROR_VID_INVALID_NUMA_NODE_INDEX + ERROR_VID_INVALID_NUMA_NODE_INDEX + + + + No documentation. + + + ERROR_VID_NOTIFICATION_QUEUE_ALREADY_ASSOCIATED + ERROR_VID_NOTIFICATION_QUEUE_ALREADY_ASSOCIATED + + + + No documentation. + + + ERROR_VID_INVALID_MEMORY_BLOCK_HANDLE + ERROR_VID_INVALID_MEMORY_BLOCK_HANDLE + + + + No documentation. + + + ERROR_VID_PAGE_RANGE_OVERFLOW + ERROR_VID_PAGE_RANGE_OVERFLOW + + + + No documentation. + + + ERROR_VID_INVALID_MESSAGE_QUEUE_HANDLE + ERROR_VID_INVALID_MESSAGE_QUEUE_HANDLE + + + + No documentation. + + + ERROR_VID_INVALID_GPA_RANGE_HANDLE + ERROR_VID_INVALID_GPA_RANGE_HANDLE + + + + No documentation. + + + ERROR_VID_NO_MEMORY_BLOCK_NOTIFICATION_QUEUE + ERROR_VID_NO_MEMORY_BLOCK_NOTIFICATION_QUEUE + + + + No documentation. + + + ERROR_VID_MEMORY_BLOCK_LOCK_COUNT_EXCEEDED + ERROR_VID_MEMORY_BLOCK_LOCK_COUNT_EXCEEDED + + + + No documentation. + + + ERROR_VID_INVALID_PPM_HANDLE + ERROR_VID_INVALID_PPM_HANDLE + + + + No documentation. + + + ERROR_VID_MBPS_ARE_LOCKED + ERROR_VID_MBPS_ARE_LOCKED + + + + No documentation. + + + ERROR_VID_MESSAGE_QUEUE_CLOSED + ERROR_VID_MESSAGE_QUEUE_CLOSED + + + + No documentation. + + + ERROR_VID_VIRTUAL_PROCESSOR_LIMIT_EXCEEDED + ERROR_VID_VIRTUAL_PROCESSOR_LIMIT_EXCEEDED + + + + No documentation. + + + ERROR_VID_STOP_PENDING + ERROR_VID_STOP_PENDING + + + + No documentation. + + + ERROR_VID_INVALID_PROCESSOR_STATE + ERROR_VID_INVALID_PROCESSOR_STATE + + + + No documentation. + + + ERROR_VID_EXCEEDED_KM_CONTEXT_COUNT_LIMIT + ERROR_VID_EXCEEDED_KM_CONTEXT_COUNT_LIMIT + + + + No documentation. + + + ERROR_VID_KM_INTERFACE_ALREADY_INITIALIZED + ERROR_VID_KM_INTERFACE_ALREADY_INITIALIZED + + + + No documentation. + + + ERROR_VID_MB_PROPERTY_ALREADY_SET_RESET + ERROR_VID_MB_PROPERTY_ALREADY_SET_RESET + + + + No documentation. + + + ERROR_VID_MMIO_RANGE_DESTROYED + ERROR_VID_MMIO_RANGE_DESTROYED + + + + No documentation. + + + ERROR_VID_INVALID_CHILD_GPA_PAGE_SET + ERROR_VID_INVALID_CHILD_GPA_PAGE_SET + + + + No documentation. + + + ERROR_VID_RESERVE_PAGE_SET_IS_BEING_USED + ERROR_VID_RESERVE_PAGE_SET_IS_BEING_USED + + + + No documentation. + + + ERROR_VID_RESERVE_PAGE_SET_TOO_SMALL + ERROR_VID_RESERVE_PAGE_SET_TOO_SMALL + + + + No documentation. + + + ERROR_VID_MBP_ALREADY_LOCKED_USING_RESERVED_PAGE + ERROR_VID_MBP_ALREADY_LOCKED_USING_RESERVED_PAGE + + + + No documentation. + + + ERROR_VID_MBP_COUNT_EXCEEDED_LIMIT + ERROR_VID_MBP_COUNT_EXCEEDED_LIMIT + + + + No documentation. + + + ERROR_VID_SAVED_STATE_CORRUPT + ERROR_VID_SAVED_STATE_CORRUPT + + + + No documentation. + + + ERROR_VID_SAVED_STATE_UNRECOGNIZED_ITEM + ERROR_VID_SAVED_STATE_UNRECOGNIZED_ITEM + + + + No documentation. + + + ERROR_VID_SAVED_STATE_INCOMPATIBLE + ERROR_VID_SAVED_STATE_INCOMPATIBLE + + + + No documentation. + + + ERROR_VID_REMOTE_NODE_PARENT_GPA_PAGES_USED + ERROR_VID_REMOTE_NODE_PARENT_GPA_PAGES_USED + + + + No documentation. + + + ERROR_VOLMGR_INCOMPLETE_REGENERATION + ERROR_VOLMGR_INCOMPLETE_REGENERATION + + + + No documentation. + + + ERROR_VOLMGR_INCOMPLETE_DISK_MIGRATION + ERROR_VOLMGR_INCOMPLETE_DISK_MIGRATION + + + + No documentation. + + + ERROR_VOLMGR_DATABASE_FULL + ERROR_VOLMGR_DATABASE_FULL + + + + No documentation. + + + ERROR_VOLMGR_DISK_CONFIGURATION_CORRUPTED + ERROR_VOLMGR_DISK_CONFIGURATION_CORRUPTED + + + + No documentation. + + + ERROR_VOLMGR_DISK_CONFIGURATION_NOT_IN_SYNC + ERROR_VOLMGR_DISK_CONFIGURATION_NOT_IN_SYNC + + + + No documentation. + + + ERROR_VOLMGR_PACK_CONFIG_UPDATE_FAILED + ERROR_VOLMGR_PACK_CONFIG_UPDATE_FAILED + + + + No documentation. + + + ERROR_VOLMGR_DISK_CONTAINS_NON_SIMPLE_VOLUME + ERROR_VOLMGR_DISK_CONTAINS_NON_SIMPLE_VOLUME + + + + No documentation. + + + ERROR_VOLMGR_DISK_DUPLICATE + ERROR_VOLMGR_DISK_DUPLICATE + + + + No documentation. + + + ERROR_VOLMGR_DISK_DYNAMIC + ERROR_VOLMGR_DISK_DYNAMIC + + + + No documentation. + + + ERROR_VOLMGR_DISK_ID_INVALID + ERROR_VOLMGR_DISK_ID_INVALID + + + + No documentation. + + + ERROR_VOLMGR_DISK_INVALID + ERROR_VOLMGR_DISK_INVALID + + + + No documentation. + + + ERROR_VOLMGR_DISK_LAST_VOTER + ERROR_VOLMGR_DISK_LAST_VOTER + + + + No documentation. + + + ERROR_VOLMGR_DISK_LAYOUT_INVALID + ERROR_VOLMGR_DISK_LAYOUT_INVALID + + + + No documentation. + + + ERROR_VOLMGR_DISK_LAYOUT_NON_BASIC_BETWEEN_BASIC_PARTITIONS + ERROR_VOLMGR_DISK_LAYOUT_NON_BASIC_BETWEEN_BASIC_PARTITIONS + + + + No documentation. + + + ERROR_VOLMGR_DISK_LAYOUT_NOT_CYLINDER_ALIGNED + ERROR_VOLMGR_DISK_LAYOUT_NOT_CYLINDER_ALIGNED + + + + No documentation. + + + ERROR_VOLMGR_DISK_LAYOUT_PARTITIONS_TOO_SMALL + ERROR_VOLMGR_DISK_LAYOUT_PARTITIONS_TOO_SMALL + + + + No documentation. + + + ERROR_VOLMGR_DISK_LAYOUT_PRIMARY_BETWEEN_LOGICAL_PARTITIONS + ERROR_VOLMGR_DISK_LAYOUT_PRIMARY_BETWEEN_LOGICAL_PARTITIONS + + + + No documentation. + + + ERROR_VOLMGR_DISK_LAYOUT_TOO_MANY_PARTITIONS + ERROR_VOLMGR_DISK_LAYOUT_TOO_MANY_PARTITIONS + + + + No documentation. + + + ERROR_VOLMGR_DISK_MISSING + ERROR_VOLMGR_DISK_MISSING + + + + No documentation. + + + ERROR_VOLMGR_DISK_NOT_EMPTY + ERROR_VOLMGR_DISK_NOT_EMPTY + + + + No documentation. + + + ERROR_VOLMGR_DISK_NOT_ENOUGH_SPACE + ERROR_VOLMGR_DISK_NOT_ENOUGH_SPACE + + + + No documentation. + + + ERROR_VOLMGR_DISK_REVECTORING_FAILED + ERROR_VOLMGR_DISK_REVECTORING_FAILED + + + + No documentation. + + + ERROR_VOLMGR_DISK_SECTOR_SIZE_INVALID + ERROR_VOLMGR_DISK_SECTOR_SIZE_INVALID + + + + No documentation. + + + ERROR_VOLMGR_DISK_SET_NOT_CONTAINED + ERROR_VOLMGR_DISK_SET_NOT_CONTAINED + + + + No documentation. + + + ERROR_VOLMGR_DISK_USED_BY_MULTIPLE_MEMBERS + ERROR_VOLMGR_DISK_USED_BY_MULTIPLE_MEMBERS + + + + No documentation. + + + ERROR_VOLMGR_DISK_USED_BY_MULTIPLE_PLEXES + ERROR_VOLMGR_DISK_USED_BY_MULTIPLE_PLEXES + + + + No documentation. + + + ERROR_VOLMGR_DYNAMIC_DISK_NOT_SUPPORTED + ERROR_VOLMGR_DYNAMIC_DISK_NOT_SUPPORTED + + + + No documentation. + + + ERROR_VOLMGR_EXTENT_ALREADY_USED + ERROR_VOLMGR_EXTENT_ALREADY_USED + + + + No documentation. + + + ERROR_VOLMGR_EXTENT_NOT_CONTIGUOUS + ERROR_VOLMGR_EXTENT_NOT_CONTIGUOUS + + + + No documentation. + + + ERROR_VOLMGR_EXTENT_NOT_IN_PUBLIC_REGION + ERROR_VOLMGR_EXTENT_NOT_IN_PUBLIC_REGION + + + + No documentation. + + + ERROR_VOLMGR_EXTENT_NOT_SECTOR_ALIGNED + ERROR_VOLMGR_EXTENT_NOT_SECTOR_ALIGNED + + + + No documentation. + + + ERROR_VOLMGR_EXTENT_OVERLAPS_EBR_PARTITION + ERROR_VOLMGR_EXTENT_OVERLAPS_EBR_PARTITION + + + + No documentation. + + + ERROR_VOLMGR_EXTENT_VOLUME_LENGTHS_DO_NOT_MATCH + ERROR_VOLMGR_EXTENT_VOLUME_LENGTHS_DO_NOT_MATCH + + + + No documentation. + + + ERROR_VOLMGR_FAULT_TOLERANT_NOT_SUPPORTED + ERROR_VOLMGR_FAULT_TOLERANT_NOT_SUPPORTED + + + + No documentation. + + + ERROR_VOLMGR_INTERLEAVE_LENGTH_INVALID + ERROR_VOLMGR_INTERLEAVE_LENGTH_INVALID + + + + No documentation. + + + ERROR_VOLMGR_MAXIMUM_REGISTERED_USERS + ERROR_VOLMGR_MAXIMUM_REGISTERED_USERS + + + + No documentation. + + + ERROR_VOLMGR_MEMBER_IN_SYNC + ERROR_VOLMGR_MEMBER_IN_SYNC + + + + No documentation. + + + ERROR_VOLMGR_MEMBER_INDEX_DUPLICATE + ERROR_VOLMGR_MEMBER_INDEX_DUPLICATE + + + + No documentation. + + + ERROR_VOLMGR_MEMBER_INDEX_INVALID + ERROR_VOLMGR_MEMBER_INDEX_INVALID + + + + No documentation. + + + ERROR_VOLMGR_MEMBER_MISSING + ERROR_VOLMGR_MEMBER_MISSING + + + + No documentation. + + + ERROR_VOLMGR_MEMBER_NOT_DETACHED + ERROR_VOLMGR_MEMBER_NOT_DETACHED + + + + No documentation. + + + ERROR_VOLMGR_MEMBER_REGENERATING + ERROR_VOLMGR_MEMBER_REGENERATING + + + + No documentation. + + + ERROR_VOLMGR_ALL_DISKS_FAILED + ERROR_VOLMGR_ALL_DISKS_FAILED + + + + No documentation. + + + ERROR_VOLMGR_NO_REGISTERED_USERS + ERROR_VOLMGR_NO_REGISTERED_USERS + + + + No documentation. + + + ERROR_VOLMGR_NO_SUCH_USER + ERROR_VOLMGR_NO_SUCH_USER + + + + No documentation. + + + ERROR_VOLMGR_NOTIFICATION_RESET + ERROR_VOLMGR_NOTIFICATION_RESET + + + + No documentation. + + + ERROR_VOLMGR_NUMBER_OF_MEMBERS_INVALID + ERROR_VOLMGR_NUMBER_OF_MEMBERS_INVALID + + + + No documentation. + + + ERROR_VOLMGR_NUMBER_OF_PLEXES_INVALID + ERROR_VOLMGR_NUMBER_OF_PLEXES_INVALID + + + + No documentation. + + + ERROR_VOLMGR_PACK_DUPLICATE + ERROR_VOLMGR_PACK_DUPLICATE + + + + No documentation. + + + ERROR_VOLMGR_PACK_ID_INVALID + ERROR_VOLMGR_PACK_ID_INVALID + + + + No documentation. + + + ERROR_VOLMGR_PACK_INVALID + ERROR_VOLMGR_PACK_INVALID + + + + No documentation. + + + ERROR_VOLMGR_PACK_NAME_INVALID + ERROR_VOLMGR_PACK_NAME_INVALID + + + + No documentation. + + + ERROR_VOLMGR_PACK_OFFLINE + ERROR_VOLMGR_PACK_OFFLINE + + + + No documentation. + + + ERROR_VOLMGR_PACK_HAS_QUORUM + ERROR_VOLMGR_PACK_HAS_QUORUM + + + + No documentation. + + + ERROR_VOLMGR_PACK_WITHOUT_QUORUM + ERROR_VOLMGR_PACK_WITHOUT_QUORUM + + + + No documentation. + + + ERROR_VOLMGR_PARTITION_STYLE_INVALID + ERROR_VOLMGR_PARTITION_STYLE_INVALID + + + + No documentation. + + + ERROR_VOLMGR_PARTITION_UPDATE_FAILED + ERROR_VOLMGR_PARTITION_UPDATE_FAILED + + + + No documentation. + + + ERROR_VOLMGR_PLEX_IN_SYNC + ERROR_VOLMGR_PLEX_IN_SYNC + + + + No documentation. + + + ERROR_VOLMGR_PLEX_INDEX_DUPLICATE + ERROR_VOLMGR_PLEX_INDEX_DUPLICATE + + + + No documentation. + + + ERROR_VOLMGR_PLEX_INDEX_INVALID + ERROR_VOLMGR_PLEX_INDEX_INVALID + + + + No documentation. + + + ERROR_VOLMGR_PLEX_LAST_ACTIVE + ERROR_VOLMGR_PLEX_LAST_ACTIVE + + + + No documentation. + + + ERROR_VOLMGR_PLEX_MISSING + ERROR_VOLMGR_PLEX_MISSING + + + + No documentation. + + + ERROR_VOLMGR_PLEX_REGENERATING + ERROR_VOLMGR_PLEX_REGENERATING + + + + No documentation. + + + ERROR_VOLMGR_PLEX_TYPE_INVALID + ERROR_VOLMGR_PLEX_TYPE_INVALID + + + + No documentation. + + + ERROR_VOLMGR_PLEX_NOT_RAID5 + ERROR_VOLMGR_PLEX_NOT_RAID5 + + + + No documentation. + + + ERROR_VOLMGR_PLEX_NOT_SIMPLE + ERROR_VOLMGR_PLEX_NOT_SIMPLE + + + + No documentation. + + + ERROR_VOLMGR_STRUCTURE_SIZE_INVALID + ERROR_VOLMGR_STRUCTURE_SIZE_INVALID + + + + No documentation. + + + ERROR_VOLMGR_TOO_MANY_NOTIFICATION_REQUESTS + ERROR_VOLMGR_TOO_MANY_NOTIFICATION_REQUESTS + + + + No documentation. + + + ERROR_VOLMGR_TRANSACTION_IN_PROGRESS + ERROR_VOLMGR_TRANSACTION_IN_PROGRESS + + + + No documentation. + + + ERROR_VOLMGR_UNEXPECTED_DISK_LAYOUT_CHANGE + ERROR_VOLMGR_UNEXPECTED_DISK_LAYOUT_CHANGE + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_CONTAINS_MISSING_DISK + ERROR_VOLMGR_VOLUME_CONTAINS_MISSING_DISK + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_ID_INVALID + ERROR_VOLMGR_VOLUME_ID_INVALID + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_LENGTH_INVALID + ERROR_VOLMGR_VOLUME_LENGTH_INVALID + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_LENGTH_NOT_SECTOR_SIZE_MULTIPLE + ERROR_VOLMGR_VOLUME_LENGTH_NOT_SECTOR_SIZE_MULTIPLE + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_NOT_MIRRORED + ERROR_VOLMGR_VOLUME_NOT_MIRRORED + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_NOT_RETAINED + ERROR_VOLMGR_VOLUME_NOT_RETAINED + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_OFFLINE + ERROR_VOLMGR_VOLUME_OFFLINE + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_RETAINED + ERROR_VOLMGR_VOLUME_RETAINED + + + + No documentation. + + + ERROR_VOLMGR_NUMBER_OF_EXTENTS_INVALID + ERROR_VOLMGR_NUMBER_OF_EXTENTS_INVALID + + + + No documentation. + + + ERROR_VOLMGR_DIFFERENT_SECTOR_SIZE + ERROR_VOLMGR_DIFFERENT_SECTOR_SIZE + + + + No documentation. + + + ERROR_VOLMGR_BAD_BOOT_DISK + ERROR_VOLMGR_BAD_BOOT_DISK + + + + No documentation. + + + ERROR_VOLMGR_PACK_CONFIG_OFFLINE + ERROR_VOLMGR_PACK_CONFIG_OFFLINE + + + + No documentation. + + + ERROR_VOLMGR_PACK_CONFIG_ONLINE + ERROR_VOLMGR_PACK_CONFIG_ONLINE + + + + No documentation. + + + ERROR_VOLMGR_NOT_PRIMARY_PACK + ERROR_VOLMGR_NOT_PRIMARY_PACK + + + + No documentation. + + + ERROR_VOLMGR_PACK_LOG_UPDATE_FAILED + ERROR_VOLMGR_PACK_LOG_UPDATE_FAILED + + + + No documentation. + + + ERROR_VOLMGR_NUMBER_OF_DISKS_IN_PLEX_INVALID + ERROR_VOLMGR_NUMBER_OF_DISKS_IN_PLEX_INVALID + + + + No documentation. + + + ERROR_VOLMGR_NUMBER_OF_DISKS_IN_MEMBER_INVALID + ERROR_VOLMGR_NUMBER_OF_DISKS_IN_MEMBER_INVALID + + + + No documentation. + + + ERROR_VOLMGR_VOLUME_MIRRORED + ERROR_VOLMGR_VOLUME_MIRRORED + + + + No documentation. + + + ERROR_VOLMGR_PLEX_NOT_SIMPLE_SPANNED + ERROR_VOLMGR_PLEX_NOT_SIMPLE_SPANNED + + + + No documentation. + + + ERROR_VOLMGR_NO_VALID_LOG_COPIES + ERROR_VOLMGR_NO_VALID_LOG_COPIES + + + + No documentation. + + + ERROR_VOLMGR_PRIMARY_PACK_PRESENT + ERROR_VOLMGR_PRIMARY_PACK_PRESENT + + + + No documentation. + + + ERROR_VOLMGR_NUMBER_OF_DISKS_INVALID + ERROR_VOLMGR_NUMBER_OF_DISKS_INVALID + + + + No documentation. + + + ERROR_VOLMGR_MIRROR_NOT_SUPPORTED + ERROR_VOLMGR_MIRROR_NOT_SUPPORTED + + + + No documentation. + + + ERROR_VOLMGR_RAID5_NOT_SUPPORTED + ERROR_VOLMGR_RAID5_NOT_SUPPORTED + + + + No documentation. + + + ERROR_BCD_NOT_ALL_ENTRIES_IMPORTED + ERROR_BCD_NOT_ALL_ENTRIES_IMPORTED + + + + No documentation. + + + ERROR_BCD_TOO_MANY_ELEMENTS + ERROR_BCD_TOO_MANY_ELEMENTS + + + + No documentation. + + + ERROR_BCD_NOT_ALL_ENTRIES_SYNCHRONIZED + ERROR_BCD_NOT_ALL_ENTRIES_SYNCHRONIZED + + + + No documentation. + + + ERROR_VHD_DRIVE_FOOTER_MISSING + ERROR_VHD_DRIVE_FOOTER_MISSING + + + + No documentation. + + + ERROR_VHD_DRIVE_FOOTER_CHECKSUM_MISMATCH + ERROR_VHD_DRIVE_FOOTER_CHECKSUM_MISMATCH + + + + No documentation. + + + ERROR_VHD_DRIVE_FOOTER_CORRUPT + ERROR_VHD_DRIVE_FOOTER_CORRUPT + + + + No documentation. + + + ERROR_VHD_FORMAT_UNKNOWN + ERROR_VHD_FORMAT_UNKNOWN + + + + No documentation. + + + ERROR_VHD_FORMAT_UNSUPPORTED_VERSION + ERROR_VHD_FORMAT_UNSUPPORTED_VERSION + + + + No documentation. + + + ERROR_VHD_SPARSE_HEADER_CHECKSUM_MISMATCH + ERROR_VHD_SPARSE_HEADER_CHECKSUM_MISMATCH + + + + No documentation. + + + ERROR_VHD_SPARSE_HEADER_UNSUPPORTED_VERSION + ERROR_VHD_SPARSE_HEADER_UNSUPPORTED_VERSION + + + + No documentation. + + + ERROR_VHD_SPARSE_HEADER_CORRUPT + ERROR_VHD_SPARSE_HEADER_CORRUPT + + + + No documentation. + + + ERROR_VHD_BLOCK_ALLOCATION_FAILURE + ERROR_VHD_BLOCK_ALLOCATION_FAILURE + + + + No documentation. + + + ERROR_VHD_BLOCK_ALLOCATION_TABLE_CORRUPT + ERROR_VHD_BLOCK_ALLOCATION_TABLE_CORRUPT + + + + No documentation. + + + ERROR_VHD_INVALID_BLOCK_SIZE + ERROR_VHD_INVALID_BLOCK_SIZE + + + + No documentation. + + + ERROR_VHD_BITMAP_MISMATCH + ERROR_VHD_BITMAP_MISMATCH + + + + No documentation. + + + ERROR_VHD_PARENT_VHD_NOT_FOUND + ERROR_VHD_PARENT_VHD_NOT_FOUND + + + + No documentation. + + + ERROR_VHD_CHILD_PARENT_ID_MISMATCH + ERROR_VHD_CHILD_PARENT_ID_MISMATCH + + + + No documentation. + + + ERROR_VHD_CHILD_PARENT_TIMESTAMP_MISMATCH + ERROR_VHD_CHILD_PARENT_TIMESTAMP_MISMATCH + + + + No documentation. + + + ERROR_VHD_METADATA_READ_FAILURE + ERROR_VHD_METADATA_READ_FAILURE + + + + No documentation. + + + ERROR_VHD_METADATA_WRITE_FAILURE + ERROR_VHD_METADATA_WRITE_FAILURE + + + + No documentation. + + + ERROR_VHD_INVALID_SIZE + ERROR_VHD_INVALID_SIZE + + + + No documentation. + + + ERROR_VHD_INVALID_FILE_SIZE + ERROR_VHD_INVALID_FILE_SIZE + + + + No documentation. + + + ERROR_VIRTDISK_PROVIDER_NOT_FOUND + ERROR_VIRTDISK_PROVIDER_NOT_FOUND + + + + No documentation. + + + ERROR_VIRTDISK_NOT_VIRTUAL_DISK + ERROR_VIRTDISK_NOT_VIRTUAL_DISK + + + + No documentation. + + + ERROR_VHD_PARENT_VHD_ACCESS_DENIED + ERROR_VHD_PARENT_VHD_ACCESS_DENIED + + + + No documentation. + + + ERROR_VHD_CHILD_PARENT_SIZE_MISMATCH + ERROR_VHD_CHILD_PARENT_SIZE_MISMATCH + + + + No documentation. + + + ERROR_VHD_DIFFERENCING_CHAIN_CYCLE_DETECTED + ERROR_VHD_DIFFERENCING_CHAIN_CYCLE_DETECTED + + + + No documentation. + + + ERROR_VHD_DIFFERENCING_CHAIN_ERROR_IN_PARENT + ERROR_VHD_DIFFERENCING_CHAIN_ERROR_IN_PARENT + + + + No documentation. + + + ERROR_VIRTUAL_DISK_LIMITATION + ERROR_VIRTUAL_DISK_LIMITATION + + + + No documentation. + + + ERROR_VHD_INVALID_TYPE + ERROR_VHD_INVALID_TYPE + + + + No documentation. + + + ERROR_VHD_INVALID_STATE + ERROR_VHD_INVALID_STATE + + + + No documentation. + + + ERROR_VIRTDISK_UNSUPPORTED_DISK_SECTOR_SIZE + ERROR_VIRTDISK_UNSUPPORTED_DISK_SECTOR_SIZE + + + + No documentation. + + + ERROR_QUERY_STORAGE_ERROR + ERROR_QUERY_STORAGE_ERROR + + + +

The + enumeration values indicate the type of locking requested for the specified range of bytes. The values are used in the + ILockBytes::LockRegion and + methods.

+
+ + aa380048 + LOCKTYPE + LOCKTYPE +
+ + + No documentation. + + + LOCK_WRITE + LOCK_WRITE + + + + No documentation. + + + LOCK_EXCLUSIVE + LOCK_EXCLUSIVE + + + + No documentation. + + + LOCK_ONLYONCE + LOCK_ONLYONCE + + + +

The + enumeration values indicate whether the method should try to return a name in the pwcsName member of the + structure. The values are used in the + ILockBytes::Stat, + IStorage::Stat, and + methods to save memory when the pwcsName member is not required.

+
+ + aa380316 + STATFLAG + STATFLAG +
+ + + No documentation. + + + STATFLAG_DEFAULT + STATFLAG_DEFAULT + + + + No documentation. + + + STATFLAG_NONAME + STATFLAG_NONAME + + + + None. + + + None + None + + + +

The + interface lets you read and write data to stream objects. Stream objects contain the data in a structured storage object, where storages provide the structure. Simple data can be written directly to a stream but, most frequently, streams are elements nested within a storage object. They are similar to standard files.

The + interface defines methods similar to the MS-DOS FAT file functions. For example, each stream object has its own access rights and a seek reference. The main difference between a DOS file and a stream object is that in the latter case, streams are opened using an + interface reference rather than a file handle.

The methods in this interface present your object's data as a contiguous sequence of bytes that you can read or write. There are also methods for committing and reverting changes on streams that are open in transacted mode and methods for restricting access to a range of bytes in the stream.

Streams can remain open for long periods of time without consuming file-system resources. The IUnknown::Release method is similar to a close function on a file. Once released, the stream object is no longer valid and cannot be used.

Clients of asynchronous monikers can choose between a data-pull or data-push model for driving an asynchronous + IMoniker::BindToStorage operation and for receiving asynchronous notifications. See + URL Monikers for more information. The following table compares the behavior of asynchronous + and + calls returned in IBindStatusCallback::OnDataAvailable in these two download models:

+
+ + aa380034 + IStream + IStream +
+ + +

The + interface supports simplified sequential access to stream objects. The + interface inherits its + Read and + Write methods from + .

+
+ + aa380010 + ISequentialStream + ISequentialStream +
+ + +

The + interface supports simplified sequential access to stream objects. The + interface inherits its + Read and + Write methods from + .

+
+ + aa380010 + ISequentialStream + ISequentialStream +
+ + + Reads a specified number of bytes from the stream object into memory starting at the current seek pointer. + + The read buffer. + The number of bytes to read. + The actual number of bytes read from the stream object. + + + + Writes a specified number of bytes into the stream object starting at the current seek pointer. + + The buffer. + The number of bytes to read. + The actual number of bytes written to the stream object + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

The Read method reads a specified number of bytes from the stream object into memory, starting at the current seek reference.

+
+

A reference to the buffer which the stream data is read into.

+

The number of bytes of data to read from the stream object.

+

A reference to a ULONG variable that receives the actual number of bytes read from the stream object.

Note??The number of bytes read may be zero.

+ +

This method reads bytes from this stream object into memory. The stream object must be opened in STGM_READ mode. This method adjusts the seek reference by the actual number of bytes read.

The number of bytes actually read is also returned in the pcbRead parameter.

Notes to Callers

The actual number of bytes read can be less than the number of bytes requested if an error occurs or if the end of the stream is reached during the read operation. The number of bytes returned should always be compared to the number of bytes requested. If the number of bytes returned is less than the number of bytes requested, it usually means the Read method attempted to read past the end of the stream.

The application should handle both a returned error and return values on end-of-stream read operations.

+
+ + aa380011 + HRESULT ISequentialStream::Read([Out, Buffer] void* pv,[In] unsigned int cb,[Out, Optional] unsigned int* pcbRead) + ISequentialStream::Read +
+ + +

The Write method writes a specified number of bytes into the stream object starting at the current seek reference.

+
+

A reference to the buffer that contains the data that is to be written to the stream. A valid reference must be provided for this parameter even when cb is zero.

+

The number of bytes of data to attempt to write into the stream. This value can be zero.

+

A reference to a ULONG variable where this method writes the actual number of bytes written to the stream object. The caller can set this reference to null, in which case this method does not provide the actual number of bytes written.

+ +

writes the specified data to a stream object. The seek reference is adjusted for the number of bytes actually written. The number of bytes actually written is returned in the pcbWritten parameter. If the byte count is zero bytes, the write operation has no effect.

If the seek reference is currently past the end of the stream and the byte count is nonzero, this method increases the size of the stream to the seek reference and writes the specified bytes starting at the seek reference. The fill bytes written to the stream are not initialized to any particular value. This is the same as the end-of-file behavior in the MS-DOS FAT file system.

With a zero byte count and a seek reference past the end of the stream, this method does not create the fill bytes to increase the stream to the seek reference. In this case, you must call the + method to increase the size of the stream and write the fill bytes.

The pcbWritten parameter can have a value even if an error occurs.

In the COM-provided implementation, stream objects are not sparse. Any fill bytes are eventually allocated on the disk and assigned to the stream.

+
+ + aa380014 + HRESULT ISequentialStream::Write([In, Buffer] const void* pv,[In] unsigned int cb,[Out, Optional] unsigned int* pcbWritten) + ISequentialStream::Write +
+ + +

The + interface lets you read and write data to stream objects. Stream objects contain the data in a structured storage object, where storages provide the structure. Simple data can be written directly to a stream but, most frequently, streams are elements nested within a storage object. They are similar to standard files.

The + interface defines methods similar to the MS-DOS FAT file functions. For example, each stream object has its own access rights and a seek reference. The main difference between a DOS file and a stream object is that in the latter case, streams are opened using an + interface reference rather than a file handle.

The methods in this interface present your object's data as a contiguous sequence of bytes that you can read or write. There are also methods for committing and reverting changes on streams that are open in transacted mode and methods for restricting access to a range of bytes in the stream.

Streams can remain open for long periods of time without consuming file-system resources. The IUnknown::Release method is similar to a close function on a file. Once released, the stream object is no longer valid and cannot be used.

Clients of asynchronous monikers can choose between a data-pull or data-push model for driving an asynchronous + IMoniker::BindToStorage operation and for receiving asynchronous notifications. See + URL Monikers for more information. The following table compares the behavior of asynchronous + and + calls returned in IBindStatusCallback::OnDataAvailable in these two download models:

+
+ + aa380034 + IStream + IStream +
+ + + Changes the seek pointer to a new location relative to the beginning of the stream, to the end of the stream, or to the current seek pointer. + + The offset. + The origin. + The offset of the seek pointer from the beginning of the stream. + + + + Changes the size of the stream object. + + The new size. + + + + Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. + + The stream destination. + The number of bytes to copy. + The number of bytes written. + The number of bytes read + + + + Commit method ensures that any changes made to a stream object open in transacted mode are reflected in the parent storage. If the stream object is open in direct mode, Commit has no effect other than flushing all memory buffers to the next-level storage object. The COM compound file implementation of streams does not support opening streams in transacted mode. + + The GRF commit flags. + + + + Discards all changes that have been made to a transacted stream since the last call. + + + + + Restricts access to a specified range of bytes in the stream. + + The offset. + The number of bytes to lock. + Type of the dw lock. + + + + Unlocks access to a specified range of bytes in the stream. + + The offset. + The number of bytes to lock. + Type of the dw lock. + + + + Gets the statistics. + + The storage statistics flags. + + + + + Clones this instance. + + + + + + Initializes a new instance of the class. + + The native pointer. + + + + Performs an explicit conversion from to . (This method is a shortcut to ) + + The native pointer. + + The result of the conversion. + + + + +

The Seek method changes the seek reference to a new location. The new location is relative to either the beginning of the stream, the end of the stream, or the current seek reference.

+
+

The displacement to be added to the location indicated by the dwOrigin parameter. If dwOrigin is STREAM_SEEK_SET, this is interpreted as an unsigned value rather than a signed value.

+

The origin for the displacement specified in dlibMove. The origin can be the beginning of the file (STREAM_SEEK_SET), the current seek reference (STREAM_SEEK_CUR), or the end of the file (STREAM_SEEK_END). For more information about values, see the STREAM_SEEK enumeration.

+

A reference to the location where this method writes the value of the new seek reference from the beginning of the stream.

You can set this reference to null. In this case, this method does not provide the new seek reference.

+ +

changes the seek reference so that subsequent read and write operations can be performed at a different location in the stream object. It is an error to seek before the beginning of the stream. It is not, however, an error to seek past the end of the stream. Seeking past the end of the stream is useful for subsequent write operations, as the stream byte range will be extended to the new seek position immediately before the write is complete.

You can also use this method to obtain the current value of the seek reference by calling this method with the dwOrigin parameter set to STREAM_SEEK_CUR and the dlibMove parameter set to 0 so that the seek reference is not changed. The current seek reference is returned in the plibNewPosition parameter.

+
+ + aa380043 + HRESULT IStream::Seek([In] LARGE_INTEGER dlibMove,[In] SHARPDX_SEEKORIGIN dwOrigin,[Out, Optional] ULARGE_INTEGER* plibNewPosition) + IStream::Seek +
+ + +

The SetSize method changes the size of the stream object.

+
+

Specifies the new size of the stream as a number of bytes.

+

This method can return one of the following values.

The size of the stream object was successfully changed.

E_PENDING

Asynchronous Storage only: Part or all of the stream's data is currently unavailable. For more information see IFillLockBytes and Asynchronous Storage.

STG_E_MEDIUMFULL

The stream size is not changed because there is no space left on the storage device.

STG_E_INVALIDFUNCTION

The value of the libNewSize parameter is not valid. Since streams cannot be greater than 232 bytes in the COM-provided implementation, the high DWORD data type of libNewSize must be 0. If it is nonzero, this parameter is not valid.

STG_E_REVERTED

The object has been invalidated by a revert operation above it in the transaction tree.

+ +

changes the size of the stream object. Call this method to preallocate space for the stream. If the libNewSize parameter is larger than the current stream size, the stream is extended to the indicated size by filling the intervening space with bytes of undefined value. This operation is similar to the + method if the seek reference is past the current end of stream.

If the libNewSize parameter is smaller than the current stream, the stream is truncated to the indicated size.

The seek reference is not affected by the change in stream size.

Calling can be an effective way to obtain a large chunk of contiguous space.

+
+ + aa380044 + HRESULT IStream::SetSize([In] ULARGE_INTEGER libNewSize) + IStream::SetSize +
+ + +

The CopyTo method copies a specified number of bytes from the current seek reference in the stream to the current seek reference in another stream.

+
+

A reference to the destination stream. The stream pointed to by pstm can be a new stream or a clone of the source stream.

+

The number of bytes to copy from the source stream.

+

A reference to the location where this method writes the actual number of bytes written to the destination. You can set this reference to null. In this case, this method does not provide the actual number of bytes written.

+

A reference to the location where this method writes the actual number of bytes read from the source. You can set this reference to null. In this case, this method does not provide the actual number of bytes read.

+ +

The CopyTo method copies the specified bytes from one stream to another. It can also be used to copy a stream to itself. The seek reference in each stream instance is adjusted for the number of bytes read or written. This method is equivalent to reading cb bytes into memory using + and then immediately writing them to the destination stream using + , although will be more efficient.

The destination stream can be a clone of the source stream created by calling the + method.

If returns an error, you cannot assume that the seek references are valid for either the source or destination. Additionally, the values of pcbRead and pcbWritten are not meaningful even though they are returned.

If returns successfully, the actual number of bytes read and written are the same.

To copy the remainder of the source from the current seek reference, specify the maximum large integer value for the cb parameter. If the seek reference is the beginning of the stream, this operation copies the entire stream.

+
+ + aa380038 + HRESULT IStream::CopyTo([In] IStream* pstm,[In] ULARGE_INTEGER cb,[Out] ULARGE_INTEGER* pcbRead,[Out] ULARGE_INTEGER* pcbWritten) + IStream::CopyTo +
+ + +

The Commit method ensures that any changes made to a stream object open in transacted mode are reflected in the parent storage. If the stream object is open in direct mode, has no effect other than flushing all memory buffers to the next-level storage object. The COM compound file implementation of streams does not support opening streams in transacted mode.

+
+

Controls how the changes for the stream object are committed. See the enumeration for a definition of these values.

+

This method can return one of the following values.

Changes to the stream object were successfully committed to the parent level.

E_PENDING

Asynchronous Storage only: Part or all of the stream's data is currently unavailable. For more information see IFillLockBytes and Asynchronous Storage.

STG_E_MEDIUMFULL

The commit operation failed due to lack of space on the storage device.

STG_E_REVERTED

The object has been invalidated by a revert operation above it in the transaction tree.

+ +

The Commit method ensures that changes to a stream object opened in transacted mode are reflected in the parent storage. Changes that have been made to the stream since it was opened or last committed are reflected to the parent storage object. If the parent is opened in transacted mode, the parent may revert at a later time, rolling back the changes to this stream object. The compound file implementation does not support the opening of streams in transacted mode, so this method has very little effect other than to flush memory buffers. For more information, see + - Compound File Implementation.

If the stream is open in direct mode, this method ensures that any memory buffers have been flushed out to the underlying storage object. This is much like a flush in traditional file systems.

The method is useful on a direct mode stream when the implementation of the + interface is a wrapper for underlying file system APIs. In this case, would be connected to the file system's flush call.

+
+ + aa380036 + HRESULT IStream::Commit([In] STGC grfCommitFlags) + IStream::Commit +
+ + +

The Revert method discards all changes that have been made to a transacted stream since the last + call. On streams open in direct mode and streams using the COM compound file implementation of , this method has no effect.

+
+

This method can return one of the following values.

The stream was successfully reverted to its previous version.

E_PENDING

Asynchronous Storage only: Part or all of the stream's data is currently unavailable. For more information see IFillLockBytes and Asynchronous Storage.

+ +

The Revert method discards changes made to a transacted stream since the last commit operation.

+
+ + aa380042 + HRESULT IStream::Revert() + IStream::Revert +
+ + +

The LockRegion method restricts access to a specified range of bytes in the stream. Supporting this functionality is optional since some file systems do not provide it.

+
+

Integer that specifies the byte offset for the beginning of the range.

+

Integer that specifies the length of the range, in bytes, to be restricted.

+

Specifies the restrictions being requested on accessing the range.

+

This method can return one of the following values.

The specified range of bytes was locked.

E_PENDING

Asynchronous Storage only: Part or all of the stream's data is currently unavailable. For more information, see IFillLockBytes and Asynchronous Storage.

STG_E_INVALIDFUNCTION

Locking is not supported at all or the specific type of lock requested is not supported.

STG_E_LOCKVIOLATION

Requested lock is supported, but cannot be granted because of an existing lock.

STG_E_REVERTED

The object has been invalidated by a revert operation above it in the transaction tree.

+ +

The byte range of the stream can be extended. Locking an extended range for the stream is useful as a method of communication between different instances of the stream without changing data that is actually part of the stream.

Three types of locking can be supported: locking to exclude other writers, locking to exclude other readers or writers, and locking that allows only one requester to obtain a lock on the given range, which is usually an alias for one of the other two lock types. A given stream instance might support either of the first two types, or both. The lock type is specified by dwLockType, using a value from the + enumeration.

Any region locked with must later be explicitly unlocked by calling + with exactly the same values for the libOffset, cb, and dwLockType parameters. The region must be unlocked before the stream is released. Two adjacent regions cannot be locked separately and then unlocked with a single unlock call.

Notes to Callers

Since the type of locking supported is optional and can vary in different implementations of + , you must provide code to deal with the STG_E_INVALIDFUNCTION error.

The LockRegion method has no effect in the compound file implementation, because the implementation does not support range locking.

Notes to Implementers

Support for this method is optional for implementations of stream objects since it may not be supported by the underlying file system. The type of locking supported is also optional. The STG_E_INVALIDFUNCTION error is returned if the requested type of locking is not supported.

+
+ + aa380039 + HRESULT IStream::LockRegion([In] ULARGE_INTEGER libOffset,[In] ULARGE_INTEGER cb,[In] LOCKTYPE dwLockType) + IStream::LockRegion +
+ + + No documentation. + + No documentation. + No documentation. + No documentation. + No documentation. + + HRESULT IStream::UnlockRegion([In] ULARGE_INTEGER libOffset,[In] ULARGE_INTEGER cb,[In] LOCKTYPE dwLockType) + IStream::UnlockRegion + + + +

The Stat method retrieves the + structure for this stream.

+
+ No documentation. + No documentation. + +

retrieves a reference to the + structure that contains information about this open stream. When this stream is within a structured storage and + IStorage::EnumElements is called, it creates an enumerator object with the + IEnumSTATSTG interface on it, which can be called to enumerate the storages and streams through the + structures associated with each of them.

+
+ + aa380045 + HRESULT IStream::Stat([Out] STATSTG* pstatstg,[In] STATFLAG grfStatFlag) + IStream::Stat +
+ + +

The Clone method creates a new stream object with its own seek reference that references the same bytes as the original stream.

+
+

When successful, reference to the location of an reference to the new stream object. If an error occurs, this parameter is null.

+ +

The Clone method creates a new stream object for accessing the same bytes but using a separate seek reference. The new stream object sees the same data as the source-stream object. Changes written to one object are immediately visible in the other. Range locking is shared between the stream objects.

The initial setting of the seek reference in the cloned stream instance is the same as the current setting of the seek reference in the original stream at the time of the clone operation.

+
+ + aa380035 + HRESULT IStream::Clone([Out] IStream** ppstm) + IStream::Clone +
+ + + Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. + + The stream destination. + The number of bytes to copy. + The bytes written. + The number of bytes read from this instance + + + + Gets a com pointer to the underlying object. + + The stream. + A Com pointer + + + +

The + structure contains statistical data about an open storage, stream, or byte-array object. This structure is used in the + IEnumSTATSTG, + ILockBytes, + IStorage, and + interfaces.

+
+ + aa380319 + STATSTG + STATSTG +
+ + + No documentation. + + + wchar_t* pwcsName + wchar_t pwcsName + + + + No documentation. + + + unsigned int type + unsigned int type + + + + No documentation. + + + ULARGE_INTEGER cbSize + ULARGE_INTEGER cbSize + + + + No documentation. + + + FILETIME mtime + FILETIME mtime + + + + No documentation. + + + FILETIME ctime + FILETIME ctime + + + + No documentation. + + + FILETIME atime + FILETIME atime + + + + No documentation. + + + unsigned int grfMode + unsigned int grfMode + + + + No documentation. + + + unsigned int grfLocksSupported + unsigned int grfLocksSupported + + + + No documentation. + + + GUID clsid + GUID clsid + + + + No documentation. + + + unsigned int grfStateBits + unsigned int grfStateBits + + + + No documentation. + + + unsigned int reserved + unsigned int reserved + + + + A half precision (16 bit) floating point value. + + + + + Number of decimal digits of precision. + + + + + Number of bits in the mantissa. + + + + + Maximum decimal exponent. + + + + + Maximum binary exponent. + + + + + Minimum decimal exponent. + + + + + Minimum binary exponent. + + + + + Exponent radix. + + + + + Additional rounding. + + + + + Smallest such that 1.0 + epsilon != 1.0 + + + + + Maximum value of the number. + + + + + Minimum value of the number. + + + + + Initializes a new instance of the structure. + + The floating point value that should be stored in 16 bit format. + + + + Converts an array of half precision values into full precision values. + + The values to be converted. + An array of converted values. + + + + Converts an array of full precision values into half precision values. + + The values to be converted. + An array of converted values. + + + + Performs an explicit conversion from to . + + The value to be converted. + The converted value. + + + + Performs an implicit conversion from to . + + The value to be converted. + The converted value. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + + true if has a different value than ; otherwise, false. + + + + Converts the value of the object to its equivalent string representation. + + The string representation of the value of this instance. + + + + Returns the hash code for this instance. + + A 32-bit signed integer hash code. + + + + + + + Determines whether the specified object instances are considered equal. + + + + + true if is the same instance as or + if both are null references or if value1.Equals(value2) returns true; otherwise, false. + + + + Returns a value that indicates whether the current instance is equal to the specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Returns a value that indicates whether the current instance is equal to a specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Gets or sets the raw 16 bit value used to back this half-float. + + + + + Defines a two component vector, using half precision floating point coordinates. + + + + + Gets or sets the X component of the vector. + + The X component of the vector. + + + + Gets or sets the Y component of the vector. + + The Y component of the vector. + + + + Initializes a new instance of the structure. + + The X component. + The Y component. + + + + Initializes a new instance of the structure. + + The value to set for both the X and Y components. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + + true if has a different value than ; otherwise, false. + + + + Returns the hash code for this instance. + + A 32-bit signed integer hash code. + + + + + + + Determines whether the specified object instances are considered equal. + + + + + true if is the same instance as or + if both are null references or if value1.Equals(value2) returns true; otherwise, false. + + + + Returns a value that indicates whether the current instance is equal to the specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Returns a value that indicates whether the current instance is equal to a specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Defines a three component vector, using half precision floating point coordinates. + + + + + Gets or sets the X component of the vector. + + The X component of the vector. + + + + Gets or sets the Y component of the vector. + + The Y component of the vector. + + + + Gets or sets the Z component of the vector. + + The Z component of the vector. + + + + Initializes a new instance of the structure. + + The X component. + The Y component. + The Z component. + + + + Initializes a new instance of the structure. + + The value to set for the X, Y, and Z components. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + + true if has a different value than ; otherwise, false. + + + + Returns the hash code for this instance. + + A 32-bit signed integer hash code. + + + + + + + Determines whether the specified object instances are considered equal. + + + + + true if is the same instance as or + if both are null references or if value1.Equals(value2) returns true; otherwise, false. + + + + Returns a value that indicates whether the current instance is equal to the specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Returns a value that indicates whether the current instance is equal to a specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Defines a four component vector, using half precision floating point coordinates. + + + + + Gets or sets the X component of the vector. + + The X component of the vector. + + + + Gets or sets the Y component of the vector. + + The Y component of the vector. + + + + Gets or sets the Z component of the vector. + + The Z component of the vector. + + + + Gets or sets the W component of the vector. + + The W component of the vector. + + + + Initializes a new instance of the structure. + + The X component. + The Y component. + The Z component. + The W component. + + + + Initializes a new instance of the structure. + + The value to set for the X, Y, Z, and W components. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + + true if has a different value than ; otherwise, false. + + + + Returns the hash code for this instance. + + A 32-bit signed integer hash code. + + + + + + + Determines whether the specified object instances are considered equal. + + + + + true if is the same instance as or + if both are null references or if value1.Equals(value2) returns true; otherwise, false. + + + + Returns a value that indicates whether the current instance is equal to the specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Returns a value that indicates whether the current instance is equal to a specified object. + + Object to make the comparison with. + + true if the current instance is equal to the specified object; false otherwise. + + + + Helper class to perform Half/Float conversion. + Code extract from paper : www.fox-toolkit.org/ftp/fasthalffloatconversion.pdf by Jeroen van der Zijp + + + + + Unpacks the specified h. + + The h. + + + + + Packs the specified f. + + The f. + + + + + Represents a four dimensional mathematical vector. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + The X unit (1, 0, 0, 0). + + + + + The Y unit (0, 1, 0, 0). + + + + + The Z unit (0, 0, 1, 0). + + + + + The W unit (0, 0, 0, 1). + + + + + A with all of its components set to one. + + + + + The X component of the vector. + + + + + The Y component of the vector. + + + + + The Z component of the vector. + + + + + The W component of the vector. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + Initial value for the X component of the vector. + Initial value for the Y component of the vector. + Initial value for the Z component of the vector. + Initial value for the W component of the vector. + + + + Initializes a new instance of the struct. + + The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Creates an array containing the elements of the vector. + + A four-element array containing the components of the vector. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + When the method completes, contains the sum of the two vectors. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + When the method completes, contains the difference of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + When the method completes, contains the modulated vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + The modulated vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Reverses the direction of a given vector. + + The vector to negate. + When the method completes, contains a vector facing in the opposite direction. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the largest components of the source vectors. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the largest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the smallest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the smallest components of the source vectors. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Assert a vector (return it unchanged). + + The vector to assert (unchange). + The asserted (unchanged) vector. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Performs an implicit conversion from array to . + + The input. + The result of the conversion. + + + + Performs an implicit conversion from to array. + + The input. + The result of the conversion. + + + + Gets or sets the component at the specified index. + + The value of the X, Y, Z, or W component, depending on the index. + The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + The implementation of this class is filled by InteropBuilder post-building-event. + + + + + Provides a fixed statement working with generics. + + + The data. + A fixed pointer to the referenced structure + + This is the only function in this class that is inlined in order to inline the fixed statement correctly. + + + + + The value for which all absolute numbers smaller than are considered equal to zero. + + + + + A value specifying the approximation of π which is 180 degrees. + + + + + A value specifying the approximation of 2π which is 360 degrees. + + + + + A value specifying the approximation of π/2 which is 90 degrees. + + + + + A value specifying the approximation of π/4 which is 45 degrees. + + + + + Checks if a - b are almost equals within a float epsilon. + + The left value to compare. + The right value to compare. + true if a almost equal to b within a float epsilon, false otherwise + + + + Does something with arrays. + + Most likely the type of elements in the array. + Who knows what this is for. + Probably the length of the array. + An array of who knows what. + + + + Converts revolutions to degrees. + + The value to convert. + The converted value. + + + + Converts revolutions to radians. + + The value to convert. + The converted value. + + + + Converts revolutions to gradians. + + The value to convert. + The converted value. + + + + Converts degrees to revolutions. + + The value to convert. + The converted value. + + + + Converts degrees to radians. + + The value to convert. + The converted value. + + + + Converts radians to revolutions. + + The value to convert. + The converted value. + + + + Converts radians to gradians. + + The value to convert. + The converted value. + + + + Converts gradians to revolutions. + + The value to convert. + The converted value. + + + + Converts gradians to degrees. + + The value to convert. + The converted value. + + + + Converts gradians to radians. + + The value to convert. + The converted value. + + + + Converts radians to degrees. + + The value to convert. + The converted value. + + + + Clamps the specified value. + + The value. + The min. + The max. + The result of clamiping a value between min and max + + + + Clamps the specified value. + + The value. + The min. + The max. + The result of clamiping a value between min and max + + + + Calculates the modulo of the specified value. + + The value. + The modulo. + The result of the modulo applied to value + + + + Calculates the modulo 2*PI of the specified value. + + The value. + The result of the modulo applied to value + + + + Wraps the specified value into a range. + + The value to wrap. + The min. + The max. + Result of the wrapping. + + + + Wraps the specified value into a range. + + The value. + The min. + The max. + Result of the wrapping. + + + + Gauss function. + + Curve amplitude. + Position X. + Position Y + Radius X. + Radius Y. + Curve sigma X. + Curve sigma Y. + The result of gaussian function. + + + + Gauss function. + + Curve amplitude. + Position X. + Position Y + Radius X. + Radius Y. + Curve sigma X. + Curve sigma Y. + The result of gaussian function. + + + + Get random float number within range. + + Current . + Minimum. + Maximum. + Random float number. + + + + Get random double number within range. + + Current . + Minimum. + Maximum. + Random double number. + + + + Get random long number. + + Current . + Random long number. + + + + Get random long number. + + Current . + Minimum. + Maximum. + Random long number. + + + + Get random within range. + + Current . + Minimum. + Maximum. + Random . + + + + Get random within range. + + Current . + Minimum. + Maximum. + Random . + + + + Get random within range. + + Current . + Minimum. + Maximum. + Random . + + + + Get random opaque + + Current . + Random . + + + + Get random opaque + + Current . + Minimum brightness. + Maximum brightness + Random . + + + + Get random . + + Current . + Minimum brightness. + Maximum brightness + Alpha value. + Random . + + + + Get random . + + Current . + Minimum brightness. + Maximum brightness + Minimum alpha. + Maximum alpha. + Random . + + + + Get random . + + Current . + Minimum. + Maximum. + Random . + + + + Get random . + + Current . + Minimum. + Maximum. + Random . + + + + Get random . + + Current . + Minimum. + Maximum. + Random . + + + + Represents a 4x4 mathematical matrix. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + The identity . + + + + + Value at row 1 column 1 of the matrix. + + + + + Value at row 1 column 2 of the matrix. + + + + + Value at row 1 column 3 of the matrix. + + + + + Value at row 1 column 4 of the matrix. + + + + + Value at row 2 column 1 of the matrix. + + + + + Value at row 2 column 2 of the matrix. + + + + + Value at row 2 column 3 of the matrix. + + + + + Value at row 2 column 4 of the matrix. + + + + + Value at row 3 column 1 of the matrix. + + + + + Value at row 3 column 2 of the matrix. + + + + + Value at row 3 column 3 of the matrix. + + + + + Value at row 3 column 4 of the matrix. + + + + + Value at row 4 column 1 of the matrix. + + + + + Value at row 4 column 2 of the matrix. + + + + + Value at row 4 column 3 of the matrix. + + + + + Value at row 4 column 4 of the matrix. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The value to assign at row 1 column 1 of the matrix. + The value to assign at row 1 column 2 of the matrix. + The value to assign at row 1 column 3 of the matrix. + The value to assign at row 1 column 4 of the matrix. + The value to assign at row 2 column 1 of the matrix. + The value to assign at row 2 column 2 of the matrix. + The value to assign at row 2 column 3 of the matrix. + The value to assign at row 2 column 4 of the matrix. + The value to assign at row 3 column 1 of the matrix. + The value to assign at row 3 column 2 of the matrix. + The value to assign at row 3 column 3 of the matrix. + The value to assign at row 3 column 4 of the matrix. + The value to assign at row 4 column 1 of the matrix. + The value to assign at row 4 column 2 of the matrix. + The value to assign at row 4 column 3 of the matrix. + The value to assign at row 4 column 4 of the matrix. + + + + Initializes a new instance of the struct. + + The values to assign to the components of the matrix. This must be an array with sixteen elements. + Thrown when is null. + Thrown when contains more or less than sixteen elements. + + + + Calculates the determinant of the matrix. + + The determinant of the matrix. + + + + Inverts the matrix. + + + + + Transposes the matrix. + + + + + Orthogonalizes the specified matrix. + + + Orthogonalization is the process of making all rows orthogonal to each other. This + means that any given row in the matrix will be orthogonal to any other given row in the + matrix. + Because this method uses the modified Gram-Schmidt process, the resulting matrix + tends to be numerically unstable. The numeric stability decreases according to the rows + so that the first row is the most stable and the last row is the least stable. + This operation is performed on the rows of the matrix rather than the columns. + If you wish for this operation to be performed on the columns, first transpose the + input and than transpose the output. + + + + + Orthonormalizes the specified matrix. + + + Orthonormalization is the process of making all rows and columns orthogonal to each + other and making all rows and columns of unit length. This means that any given row will + be orthogonal to any other given row and any given column will be orthogonal to any other + given column. Any given row will not be orthogonal to any given column. Every row and every + column will be of unit length. + Because this method uses the modified Gram-Schmidt process, the resulting matrix + tends to be numerically unstable. The numeric stability decreases according to the rows + so that the first row is the most stable and the last row is the least stable. + This operation is performed on the rows of the matrix rather than the columns. + If you wish for this operation to be performed on the columns, first transpose the + input and than transpose the output. + + + + + Decomposes a matrix into an orthonormalized matrix Q and a right traingular matrix R. + + When the method completes, contains the orthonormalized matrix of the decomposition. + When the method completes, contains the right triangular matrix of the decomposition. + + + + Decomposes a matrix into a lower triangular matrix L and an orthonormalized matrix Q. + + When the method completes, contains the lower triangular matrix of the decomposition. + When the method completes, contains the orthonormalized matrix of the decomposition. + + + + Decomposes a matrix into a scale, rotation, and translation. + + When the method completes, contains the scaling component of the decomposed matrix. + When the method completes, contains the rtoation component of the decomposed matrix. + When the method completes, contains the translation component of the decomposed matrix. + + This method is designed to decompose an SRT transformation matrix only. + + + + + Exchanges two rows in the matrix. + + The first row to exchange. This is an index of the row starting at zero. + The second row to exchange. This is an index of the row starting at zero. + + + + + + + + + + + Creates an array containing the elements of the matrix. + + A sixteen-element array containing the components of the matrix. + + + + Determines the sum of two matrices. + + The first matrix to add. + The second matrix to add. + When the method completes, contains the sum of the two matrices. + + + + Determines the sum of two matrices. + + The first matrix to add. + The second matrix to add. + The sum of the two matrices. + + + + Determines the difference between two matrices. + + The first matrix to subtract. + The second matrix to subtract. + When the method completes, contains the difference between the two matrices. + + + + Determines the difference between two matrices. + + The first matrix to subtract. + The second matrix to subtract. + The difference between the two matrices. + + + + Scales a matrix by the given value. + + The matrix to scale. + The amount by which to scale. + When the method completes, contains the scaled matrix. + + + + Scales a matrix by the given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Determines the product of two matrices. + + The first matrix to multiply. + The second matrix to multiply. + The product of the two matrices. + + + + Determines the product of two matrices. + + The first matrix to multiply. + The second matrix to multiply. + The product of the two matrices. + + + + Scales a matrix by the given value. + + The matrix to scale. + The amount by which to scale. + When the method completes, contains the scaled matrix. + + + + Scales a matrix by the given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Determines the quotient of two matrices. + + The first matrix to divide. + The second matrix to divide. + When the method completes, contains the quotient of the two matrices. + + + + Determines the quotient of two matrices. + + The first matrix to divide. + The second matrix to divide. + The quotient of the two matrices. + + + + Performs the exponential operation on a matrix. + + The matrix to perform the operation on. + The exponent to raise the matrix to. + When the method completes, contains the exponential matrix. + Thrown when the is negative. + + + + Performs the exponential operation on a matrix. + + The matrix to perform the operation on. + The exponent to raise the matrix to. + The exponential matrix. + Thrown when the is negative. + + + + Negates a matrix. + + The matrix to be negated. + When the method completes, contains the negated matrix. + + + + Negates a matrix. + + The matrix to be negated. + The negated matrix. + + + + Performs a linear interpolation between two matricies. + + Start matrix. + End matrix. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two matricies. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two matricies. + + Start matrix. + End matrix. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two matrices. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two matricies. + + Start matrix. + End matrix. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two matrices. + + + + Performs a cubic interpolation between two matrices. + + Start matrix. + End matrix. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two matrices. + + + + Calculates the transpose of the specified matrix. + + The matrix whose transpose is to be calculated. + When the method completes, contains the transpose of the specified matrix. + + + + Calculates the transpose of the specified matrix. + + The matrix whose transpose is to be calculated. + When the method completes, contains the transpose of the specified matrix. + + + + Calculates the transpose of the specified matrix. + + The matrix whose transpose is to be calculated. + The transpose of the specified matrix. + + + + Calculates the inverse of the specified matrix. + + The matrix whose inverse is to be calculated. + When the method completes, contains the inverse of the specified matrix. + + + + Calculates the inverse of the specified matrix. + + The matrix whose inverse is to be calculated. + The inverse of the specified matrix. + + + + Orthogonalizes the specified matrix. + + The matrix to orthogonalize. + When the method completes, contains the orthogonalized matrix. + + Orthogonalization is the process of making all rows orthogonal to each other. This + means that any given row in the matrix will be orthogonal to any other given row in the + matrix. + Because this method uses the modified Gram-Schmidt process, the resulting matrix + tends to be numerically unstable. The numeric stability decreases according to the rows + so that the first row is the most stable and the last row is the least stable. + This operation is performed on the rows of the matrix rather than the columns. + If you wish for this operation to be performed on the columns, first transpose the + input and than transpose the output. + + + + + Orthogonalizes the specified matrix. + + The matrix to orthogonalize. + The orthogonalized matrix. + + Orthogonalization is the process of making all rows orthogonal to each other. This + means that any given row in the matrix will be orthogonal to any other given row in the + matrix. + Because this method uses the modified Gram-Schmidt process, the resulting matrix + tends to be numerically unstable. The numeric stability decreases according to the rows + so that the first row is the most stable and the last row is the least stable. + This operation is performed on the rows of the matrix rather than the columns. + If you wish for this operation to be performed on the columns, first transpose the + input and than transpose the output. + + + + + Orthonormalizes the specified matrix. + + The matrix to orthonormalize. + When the method completes, contains the orthonormalized matrix. + + Orthonormalization is the process of making all rows and columns orthogonal to each + other and making all rows and columns of unit length. This means that any given row will + be orthogonal to any other given row and any given column will be orthogonal to any other + given column. Any given row will not be orthogonal to any given column. Every row and every + column will be of unit length. + Because this method uses the modified Gram-Schmidt process, the resulting matrix + tends to be numerically unstable. The numeric stability decreases according to the rows + so that the first row is the most stable and the last row is the least stable. + This operation is performed on the rows of the matrix rather than the columns. + If you wish for this operation to be performed on the columns, first transpose the + input and than transpose the output. + + + + + Orthonormalizes the specified matrix. + + The matrix to orthonormalize. + The orthonormalized matrix. + + Orthonormalization is the process of making all rows and columns orthogonal to each + other and making all rows and columns of unit length. This means that any given row will + be orthogonal to any other given row and any given column will be orthogonal to any other + given column. Any given row will not be orthogonal to any given column. Every row and every + column will be of unit length. + Because this method uses the modified Gram-Schmidt process, the resulting matrix + tends to be numerically unstable. The numeric stability decreases according to the rows + so that the first row is the most stable and the last row is the least stable. + This operation is performed on the rows of the matrix rather than the columns. + If you wish for this operation to be performed on the columns, first transpose the + input and than transpose the output. + + + + + Brings the matrix into upper triangular form using elementry row operations. + + The matrix to put into upper triangular form. + When the method completes, contains the upper triangular matrix. + + If the matrix is not invertable (i.e. its determinant is zero) than the result of this + method may produce Single.Nan and Single.Inf values. When the matrix represents a system + of linear equations, than this often means that either no solution exists or an infinite + number of solutions exist. + + + + + Brings the matrix into upper triangular form using elementry row operations. + + The matrix to put into upper triangular form. + The upper triangular matrix. + + If the matrix is not invertable (i.e. its determinant is zero) than the result of this + method may produce Single.Nan and Single.Inf values. When the matrix represents a system + of linear equations, than this often means that either no solution exists or an infinite + number of solutions exist. + + + + + Brings the matrix into lower triangular form using elementry row operations. + + The matrix to put into lower triangular form. + When the method completes, contains the lower triangular matrix. + + If the matrix is not invertable (i.e. its determinant is zero) than the result of this + method may produce Single.Nan and Single.Inf values. When the matrix represents a system + of linear equations, than this often means that either no solution exists or an infinite + number of solutions exist. + + + + + Brings the matrix into lower triangular form using elementry row operations. + + The matrix to put into lower triangular form. + The lower triangular matrix. + + If the matrix is not invertable (i.e. its determinant is zero) than the result of this + method may produce Single.Nan and Single.Inf values. When the matrix represents a system + of linear equations, than this often means that either no solution exists or an infinite + number of solutions exist. + + + + + Brings the matrix into row echelon form using elementry row operations; + + The matrix to put into row echelon form. + When the method completes, contains the row echelon form of the matrix. + + + + Brings the matrix into row echelon form using elementry row operations; + + The matrix to put into row echelon form. + When the method completes, contains the row echelon form of the matrix. + + + + Brings the matrix into reduced row echelon form using elementry row operations. + + The matrix to put into reduced row echelon form. + The fifth column of the matrix. + When the method completes, contains the resultant matrix after the operation. + When the method completes, contains the resultant fifth column of the matrix. + + The fifth column is often called the agumented part of the matrix. This is because the fifth + column is really just an extension of the matrix so that there is a place to put all of the + non-zero components after the operation is complete. + Often times the resultant matrix will the identity matrix or a matrix similar to the identity + matrix. Sometimes, however, that is not possible and numbers other than zero and one may appear. + This method can be used to solve systems of linear equations. Upon completion of this method, + the will contain the solution for the system. It is up to the user + to analyze both the input and the result to determine if a solution really exists. + + + + + Creates a spherical billboard that rotates around a specified object position. + + The position of the object around which the billboard will rotate. + The position of the camera. + The up vector of the camera. + The forward vector of the camera. + When the method completes, contains the created billboard matrix. + + + + Creates a spherical billboard that rotates around a specified object position. + + The position of the object around which the billboard will rotate. + The position of the camera. + The up vector of the camera. + The forward vector of the camera. + The created billboard matrix. + + + + Creates a left-handed, look-at matrix. + + The position of the viewer's eye. + The camera look-at target. + The camera's up vector. + When the method completes, contains the created look-at matrix. + + + + Creates a left-handed, look-at matrix. + + The position of the viewer's eye. + The camera look-at target. + The camera's up vector. + The created look-at matrix. + + + + Creates a right-handed, look-at matrix. + + The position of the viewer's eye. + The camera look-at target. + The camera's up vector. + When the method completes, contains the created look-at matrix. + + + + Creates a right-handed, look-at matrix. + + The position of the viewer's eye. + The camera look-at target. + The camera's up vector. + The created look-at matrix. + + + + Creates a left-handed, orthographic projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a left-handed, orthographic projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a right-handed, orthographic projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a right-handed, orthographic projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a left-handed, customized orthographic projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a left-handed, customized orthographic projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a right-handed, customized orthographic projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a right-handed, customized orthographic projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a left-handed, perspective projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a left-handed, perspective projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a right-handed, perspective projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a right-handed, perspective projection matrix. + + Width of the viewing volume. + Height of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a left-handed, perspective projection matrix based on a field of view. + + Field of view in the y direction, in radians. + Aspect ratio, defined as view space width divided by height. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a left-handed, perspective projection matrix based on a field of view. + + Field of view in the y direction, in radians. + Aspect ratio, defined as view space width divided by height. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a right-handed, perspective projection matrix based on a field of view. + + Field of view in the y direction, in radians. + Aspect ratio, defined as view space width divided by height. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a right-handed, perspective projection matrix based on a field of view. + + Field of view in the y direction, in radians. + Aspect ratio, defined as view space width divided by height. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a left-handed, customized perspective projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a left-handed, customized perspective projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Creates a right-handed, customized perspective projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + When the method completes, contains the created projection matrix. + + + + Creates a right-handed, customized perspective projection matrix. + + Minimum x-value of the viewing volume. + Maximum x-value of the viewing volume. + Minimum y-value of the viewing volume. + Maximum y-value of the viewing volume. + Minimum z-value of the viewing volume. + Maximum z-value of the viewing volume. + The created projection matrix. + + + + Builds a matrix that can be used to reflect vectors about a plane. + + The plane for which the reflection occurs. This parameter is assumed to be normalized. + When the method completes, contains the reflection matrix. + + + + Builds a matrix that can be used to reflect vectors about a plane. + + The plane for which the reflection occurs. This parameter is assumed to be normalized. + The reflection matrix. + + + + Creates a matrix that flattens geometry into a shadow. + + The light direction. If the W component is 0, the light is directional light; if the + W component is 1, the light is a point light. + The plane onto which to project the geometry as a shadow. This parameter is assumed to be normalized. + When the method completes, contains the shadow matrix. + + + + Creates a matrix that flattens geometry into a shadow. + + The light direction. If the W component is 0, the light is directional light; if the + W component is 1, the light is a point light. + The plane onto which to project the geometry as a shadow. This parameter is assumed to be normalized. + The shadow matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor for all three axes. + When the method completes, contains the created scaling matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor for all three axes. + The created scaling matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + Scaling factor that is applied along the z-axis. + When the method completes, contains the created scaling matrix. + + + + Creates a matrix that scales along the x-axis, y-axis, and y-axis. + + Scaling factor that is applied along the x-axis. + Scaling factor that is applied along the y-axis. + Scaling factor that is applied along the z-axis. + The created scaling matrix. + + + + Creates a matrix that uniformally scales along all three axis. + + The uniform scale that is applied along all axis. + When the method completes, contains the created scaling matrix. + + + + Creates a matrix that uniformally scales along all three axis. + + The uniform scale that is applied along all axis. + The created scaling matrix. + + + + Creates a matrix that rotates around the x-axis. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + When the method completes, contains the created rotation matrix. + + + + Creates a matrix that rotates around the x-axis. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + The created rotation matrix. + + + + Creates a matrix that rotates around the y-axis. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + When the method completes, contains the created rotation matrix. + + + + Creates a matrix that rotates around the y-axis. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + The created rotation matrix. + + + + Creates a matrix that rotates around the z-axis. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + When the method completes, contains the created rotation matrix. + + + + Creates a matrix that rotates around the z-axis. + + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + The created rotation matrix. + + + + Creates a matrix that rotates around an arbitary axis. + + The axis around which to rotate. This parameter is assumed to be normalized. + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + When the method completes, contains the created rotation matrix. + + + + Creates a matrix that rotates around an arbitary axis. + + The axis around which to rotate. This parameter is assumed to be normalized. + Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. + The created rotation matrix. + + + + Creates a rotation matrix from a quaternion. + + The quaternion to use to build the matrix. + The created rotation matrix. + + + + Creates a rotation matrix from a quaternion. + + The quaternion to use to build the matrix. + The created rotation matrix. + + + + Creates a rotation matrix with a specified yaw, pitch, and roll. + + Yaw around the y-axis, in radians. + Pitch around the x-axis, in radians. + Roll around the z-axis, in radians. + When the method completes, contains the created rotation matrix. + + + + Creates a rotation matrix with a specified yaw, pitch, and roll. + + Yaw around the y-axis, in radians. + Pitch around the x-axis, in radians. + Roll around the z-axis, in radians. + The created rotation matrix. + + + + Creates a translation matrix using the specified offsets. + + The offset for all three coordinate planes. + When the method completes, contains the created translation matrix. + + + + Creates a translation matrix using the specified offsets. + + The offset for all three coordinate planes. + The created translation matrix. + + + + Creates a translation matrix using the specified offsets. + + X-coordinate offset. + Y-coordinate offset. + Z-coordinate offset. + When the method completes, contains the created translation matrix. + + + + Creates a translation matrix using the specified offsets. + + X-coordinate offset. + Y-coordinate offset. + Z-coordinate offset. + The created translation matrix. + + + + Creates a 3D affine transformation matrix. + + Scaling factor. + The rotation of the transformation. + The translation factor of the transformation. + When the method completes, contains the created affine transformation matrix. + + + + Creates a 3D affine transformation matrix. + + Scaling factor. + The rotation of the transformation. + The translation factor of the transformation. + The created affine transformation matrix. + + + + Creates a 3D affine transformation matrix. + + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + When the method completes, contains the created affine transformation matrix. + + + + Creates a 3D affine transformation matrix. + + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + The created affine transformation matrix. + + + + Creates a 2D affine transformation matrix. + + Scaling factor. + The rotation of the transformation. + The translation factor of the transformation. + When the method completes, contains the created affine transformation matrix. + + + + Creates a 2D affine transformation matrix. + + Scaling factor. + The rotation of the transformation. + The translation factor of the transformation. + The created affine transformation matrix. + + + + Creates a 2D affine transformation matrix. + + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + When the method completes, contains the created affine transformation matrix. + + + + Creates a 2D affine transformation matrix. + + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + The created affine transformation matrix. + + + + Creates a transformation matrix. + + Center point of the scaling operation. + Scaling rotation amount. + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + When the method completes, contains the created transformation matrix. + + + + Creates a transformation matrix. + + Center point of the scaling operation. + Scaling rotation amount. + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + The created transformation matrix. + + + + Creates a 2D transformation matrix. + + Center point of the scaling operation. + Scaling rotation amount. + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + When the method completes, contains the created transformation matrix. + + + + Creates a 2D transformation matrix. + + Center point of the scaling operation. + Scaling rotation amount. + Scaling factor. + The center of the rotation. + The rotation of the transformation. + The translation factor of the transformation. + The created transformation matrix. + + + + Adds two matricies. + + The first matrix to add. + The second matrix to add. + The sum of the two matricies. + + + + Assert a matrix (return it unchanged). + + The matrix to assert (unchange). + The asserted (unchanged) matrix. + + + + Subtracts two matricies. + + The first matrix to subtract. + The second matrix to subtract. + The difference between the two matricies. + + + + Negates a matrix. + + The matrix to negate. + The negated matrix. + + + + Scales a matrix by a given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Scales a matrix by a given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Multiplies two matricies. + + The first matrix to multiply. + The second matrix to multiply. + The product of the two matricies. + + + + Scales a matrix by a given value. + + The matrix to scale. + The amount by which to scale. + The scaled matrix. + + + + Divides two matricies. + + The first matrix to divide. + The second matrix to divide. + The quotient of the two matricies. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Gets or sets the up of the matrix; that is M21, M22, and M23. + + + + + Gets or sets the down of the matrix; that is -M21, -M22, and -M23. + + + + + Gets or sets the right of the matrix; that is M11, M12, and M13. + + + + + Gets or sets the left of the matrix; that is -M11, -M12, and -M13. + + + + + Gets or sets the forward of the matrix; that is -M31, -M32, and -M33. + + + + + Gets or sets the backward of the matrix; that is M31, M32, and M33. + + + + + Gets or sets the first row in the matrix; that is M11, M12, M13, and M14. + + + + + Gets or sets the second row in the matrix; that is M21, M22, M23, and M24. + + + + + Gets or sets the third row in the matrix; that is M31, M32, M33, and M34. + + + + + Gets or sets the fourth row in the matrix; that is M41, M42, M43, and M44. + + + + + Gets or sets the first column in the matrix; that is M11, M21, M31, and M41. + + + + + Gets or sets the second column in the matrix; that is M12, M22, M32, and M42. + + + + + Gets or sets the third column in the matrix; that is M13, M23, M33, and M43. + + + + + Gets or sets the fourth column in the matrix; that is M14, M24, M34, and M44. + + + + + Gets or sets the translation of the matrix; that is M41, M42, and M43. + + + + + Gets or sets the scale of the matrix; that is M11, M22, and M33. + + + + + Gets a value indicating whether this instance is an identity matrix. + + + true if this instance is an identity matrix; otherwise, false. + + + + + Gets or sets the component at the specified index. + + The value of the matrix component, depending on the index. + The zero-based index of the component to access. + The value of the component at the specified index. + Thrown when the is out of the range [0, 15]. + + + + Gets or sets the component at the specified index. + + The value of the matrix component, depending on the index. + The row of the matrix to access. + The column of the matrix to access. + The value of the component at the specified index. + Thrown when the or is out of the range [0, 3]. + + + + Generic sound input stream supporting WAV (Pcm,Float), ADPCM, xWMA sound file formats. + + + + + Initializes a new instance of the class. + + The sound stream. + + + + Initializes the specified stream. + + The stream. + + + + Converts this stream to a DataStream by loading all the data from the source stream. + + + + + + Performs an implicit conversion from to . + + The stream. + + The result of the conversion. + + + + + When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. + + + An I/O error occurs. + + + + + When overridden in a derived class, sets the position within the current stream. + + A byte offset relative to the parameter. + A value of type indicating the reference point used to obtain the new position. + + The new position within the current stream. + + + An I/O error occurs. + + + + The stream does not support seeking, such as if the stream is constructed from a pipe or console output. + + + + Methods were called after the stream was closed. + + + + + When overridden in a derived class, sets the length of the current stream. + + The desired length of the current stream in bytes. + + An I/O error occurs. + + + + The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. + + + + Methods were called after the stream was closed. + + + + + When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. + The zero-based byte offset in at which to begin storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + + The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. + + + The sum of and is larger than the buffer length. + + + + is null. + + + + or is negative. + + + + An I/O error occurs. + + + + The stream does not support reading. + + + + Methods were called after the stream was closed. + + + + + When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. + + An array of bytes. This method copies bytes from to the current stream. + The zero-based byte offset in at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + The sum of and is greater than the buffer length. + + + + is null. + + + + or is negative. + + + + An I/O error occurs. + + + + The stream does not support writing. + + + + Methods were called after the stream was closed. + + + + + Gets the decoded packets info. + + + This property is only valid for XWMA stream. + + + + Gets the wave format of this instance. + + + + + When overridden in a derived class, gets a value indicating whether the current stream supports reading. + + true if the stream supports reading; otherwise, false. + + + + + When overridden in a derived class, gets a value indicating whether the current stream supports seeking. + + true if the stream supports seeking; otherwise, false. + + + + + When overridden in a derived class, gets a value indicating whether the current stream supports writing. + + true if the stream supports writing; otherwise, false. + + + + + When overridden in a derived class, gets or sets the position within the current stream. + + + The current position within the stream. + + + + An I/O error occurs. + + + + The stream does not support seeking. + + + + Methods were called after the stream was closed. + + + + + When overridden in a derived class, gets the length in bytes of the stream. + + + A long value representing the length of the stream in bytes. + + + + A class derived from Stream does not support seeking. + + + + Methods were called after the stream was closed. + + + + + WaveFormatAdpcm + http://msdn.microsoft.com/en-us/library/microsoft.directx_sdk.xaudio2.adpcmwaveformat%28v=vs.85%29.aspx + Additional documentation: http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm + + WAVEFORMATADPCM + + + + Represents a Wave file format + + WAVEFORMATEX + + + format type + + + number of channels + + + sample rate + + + for buffer estimation + + + block size of data + + + number of bits per sample of mono data + + + number of following bytes + + + + Creates a new PCM 44.1Khz stereo 16 bit format + + + + + Creates a new 16 bit wave format with the specified sample + rate and channel count + + Sample Rate + Number of channels + + + + Gets the size of a wave buffer equivalent to the latency in milliseconds. + + The milliseconds. + + + + + Creates a WaveFormat with custom members + + The encoding + Sample Rate + Number of channels + Average Bytes Per Second + Block Align + Bits Per Sample + + + + + Creates an A-law wave format + + Sample Rate + Number of Channels + Wave Format + + + + Creates a Mu-law wave format + + Sample Rate + Number of Channels + Wave Format + + + + Creates a new PCM format with the specified sample rate, bit depth and channels + + + + + Creates a new 32 bit IEEE floating point wave format + + sample rate + number of channels + + + + Helper function to retrieve a WaveFormat structure from a pointer + + Buffer to the WaveFormat rawdata + WaveFormat structure + + + + Helper function to retrieve a WaveFormat structure from a pointer + + Pointer to the WaveFormat rawdata + WaveFormat structure + + + + Helper function to marshal WaveFormat to an IntPtr + + WaveFormat + IntPtr to WaveFormat structure (needs to be freed by callee) + + + + Reads a new WaveFormat object from a stream + + A binary reader that wraps the stream + + + + Reports this WaveFormat as a string + + String describing the wave format + + + + Compares with another WaveFormat object + + Object to compare to + True if the objects are the same + + + + Provides a Hashcode for this WaveFormat + + A hashcode + + + + Returns the encoding type used + + + + + Returns the number of channels (1=mono,2=stereo etc) + + + + + Returns the sample rate (samples per second) + + + + + Returns the average number of bytes used per second + + + + + Returns the block alignment + + + + + Returns the number of bits per sample (usually 16 or 32, sometimes 24 or 8) + Can be 0 for some codecs + + + + + Returns the number of extra bytes used by this waveformat. Often 0, + except for compressed formats which store extra data after the WAVEFORMATEX header + + + + number of following bytes + + + format type + + + number of channels + + + sample rate + + + for buffer estimation + + + block size of data + + + number of bits per sample of mono data + + + + Parameterless constructor for marshalling + + + + + Creates a new WaveFormatAdpcm for MicrosoftADPCM + + The rate. + The channels. + The block align. If 0, then 256 for [0, 11KHz], 512 for ]11KHz, 22Khz], 1024 for ]22Khz, +inf] + + + + Gets or sets the samples per block. + + + The samples per block. + + + + + Gets or sets the coefficients. + + + The coefficients. + + + + + Gets or sets the coefficients. + + + The coefficients. + + + + + A FourCC descriptor. + + + + + Empty FourCC. + + + + + Initializes a new instance of the struct. + + The fourCC value as a string . + + + + Initializes a new instance of the struct. + + The byte1. + The byte2. + The byte3. + The byte4. + + + + Initializes a new instance of the struct. + + The fourCC value as an uint. + + + + Initializes a new instance of the struct. + + The fourCC value as an int. + + + + Performs an implicit conversion from to . + + The d. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The d. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The d. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The d. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The d. + + The result of the conversion. + + + + + Performs an implicit conversion from to . + + The d. + + The result of the conversion. + + + + + A chunk of a Riff stream. + + + + + Initializes a new instance of the class. + + The stream holding this chunk + The type. + The size. + The data offset. + if set to true [is list]. + if set to true [is header]. + + + + Gets the raw data contained in this chunk. + + + + + + Gets structured data contained in this chunk. + + The type of the data to return + + A structure filled with the chunk data + + + + + Gets structured data contained in this chunk. + + The type of the data to return + A structure filled with the chunk data + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets the type. + + + + + Gets the of this chunk. + + + + + Gets the size of the data enbedded by this chunk. + + + + + Gets the position of the data embedded by this chunk relative to the stream. + + + + + Gets or sets a value indicating whether this instance is a list chunk. + + + true if this instance is list; otherwise, false. + + + + + Gets a value indicating whether this instance is a header chunk. + + + true if this instance is a header; otherwise, false. + + + + + Riff chunk enumerator. + + + + + Initializes a new instance of the class. + + The input. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Advances the enumerator to the next element of the collection. + + + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, which is before the first element in the collection. + + + The collection was modified after the enumerator was created. + + + + + Ascends to the outer chunk. + + + + + Descends to the current chunk. + + + + + Gets all chunks. + + + + + + Returns an enumerator that iterates through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the current stack of chunks. + + + + + Gets the element in the collection at the current position of the enumerator. + + + The element in the collection at the current position of the enumerator. + + + + + Helper class for Speaker mask. + + + + + Counts the channels from a speaker mask. + + The speakers mask. + + + + + WaveFormatExtensible + http://www.microsoft.com/whdc/device/audio/multichaud.mspx + + WAVEFORMATEXTENSIBLE + + + + Guid of the subformat. + + + + + Speaker configuration + + + + + Parameterless constructor for marshalling + + + + + Creates a new WaveFormatExtensible for PCM or IEEE + + + + + String representation + + + + + The namespace contains fundamental classes used by SharpDX. + + + + + A general purpose tag attribute. + + + + + Initializes a new instance of class. + + + + + + Gets the value. + + + + + Overrides in order to provide for Win8 Modern App. + + + + + Provides a basic implementation to replace (not available on Win8 Modern App). + + + + + The namespace provides missing ASCIIEncoding for Win8 Modern platform. + + + + + This provides timing information similar to but an update occuring only on a method. + + + + + Initializes a new instance of the class. + + + + + Resets this instance. is set to zero. + + + + + Resumes this instance, only if a call to has been already issued. + + + + + Update the and , + + + This method must be called on a regular basis at every *tick*. + + + + + Pauses this instance. + + + + + Converts a raw time to a . + + The delta. + The . + + + + Gets the total time elasped since the last reset or when this timer was created. + + + + + Gets the elapsed adjusted time since the previous call to taking into account time. + + + + + Gets the elapsed time since the previous call to . + + + + + Gets a value indicating whether this instance is paused. + + true if this instance is paused; otherwise, false. + + + + Defines the viewport dimensions. + + + + + Position of the pixel coordinate of the upper-left corner of the viewport. + + + + + Position of the pixel coordinate of the upper-left corner of the viewport. + + + + + Width dimension of the viewport. + + + + + Height dimension of the viewport. + + + + + Gets or sets the minimum depth of the clip volume. + + + + + Gets or sets the maximum depth of the clip volume. + + + + + Initializes a new instance of the struct. + + The x coordinate of the upper-left corner of the viewport in pixels. + The y coordinate of the upper-left corner of the viewport in pixels. + The width of the viewport in pixels. + The height of the viewport in pixels. + + + + Initializes a new instance of the struct. + + The x coordinate of the upper-left corner of the viewport in pixels. + The y coordinate of the upper-left corner of the viewport in pixels. + The width of the viewport in pixels. + The height of the viewport in pixels. + The minimum depth of the clip volume. + The maximum depth of the clip volume. + + + + Initializes a new instance of the struct. + + A bounding box that defines the location and size of the viewport in a render target. + + + + Retrieves a string representation of this object. + + A that represents this instance. + + + + Projects a 3D vector from object space into screen space. + + The vector to project. + The projection matrix. + The view matrix. + The world matrix. + Vector3. + + + + Converts a screen space point into a corresponding point in world space. + + The vector to project. + The projection matrix. + The view matrix. + The world matrix. + Vector3. + + + + Gets the size of this resource. + + The bounds. + + + + Gets the aspect ratio used by the viewport + + The aspect ratio. + + + + Internal class to interact with Native Message + + + + + Represents a plane in three dimensional space. + + + + + The normal vector of the plane. + + + + + The distance of the plane along its normal from the origin. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + The X component of the normal. + The Y component of the normal. + The Z component of the normal. + The distance of the plane along its normal from the origin. + + + + Initializes a new instance of the class. + + Any point that lies along the plane. + The normal vector to the plane. + + + + Initializes a new instance of the struct. + + The normal of the plane. + The distance of the plane along its normal from the origin + + + + Initializes a new instance of the struct. + + First point of a triangle defining the plane. + Second point of a triangle defining the plane. + Third point of a triangle defining the plane. + + + + Initializes a new instance of the struct. + + The values to assign to the A, B, C, and D components of the plane. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Changes the coefficients of the normal vector of the plane to make it of unit length. + + + + + Creates an array containing the elements of the plane. + + A four-element array containing the components of the plane. + + + + Determines if there is an intersection between the current object and a point. + + The point to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The plane to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The plane to test. + When the method completes, contains the line of intersection + as a , or a zero ray if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a triangle. + + The first vertex of the triangle to test. + The second vertex of the triagnle to test. + The third vertex of the triangle to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The box to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The sphere to test. + Whether the two objects intersected. + + + + Scales the plane by the given scaling factor. + + The plane to scale. + The amount by which to scale the plane. + When the method completes, contains the scaled plane. + + + + Scales the plane by the given scaling factor. + + The plane to scale. + The amount by which to scale the plane. + The scaled plane. + + + + Calculates the dot product of the specified vector and plane. + + The source plane. + The source vector. + When the method completes, contains the dot product of the specified plane and vector. + + + + Calculates the dot product of the specified vector and plane. + + The source plane. + The source vector. + The dot product of the specified plane and vector. + + + + Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. + + The source plane. + The source vector. + When the method completes, contains the dot product of a specified vector and the normal of the Plane plus the distance value of the plane. + + + + Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. + + The source plane. + The source vector. + The dot product of a specified vector and the normal of the Plane plus the distance value of the plane. + + + + Calculates the dot product of the specified vector and the normal of the plane. + + The source plane. + The source vector. + When the method completes, contains the dot product of the specified vector and the normal of the plane. + + + + Calculates the dot product of the specified vector and the normal of the plane. + + The source plane. + The source vector. + The dot product of the specified vector and the normal of the plane. + + + + Changes the coefficients of the normal vector of the plane to make it of unit length. + + The source plane. + When the method completes, contains the normalized plane. + + + + Changes the coefficients of the normal vector of the plane to make it of unit length. + + The source plane. + The normalized plane. + + + + Transforms a normalized plane by a quaternion rotation. + + The normalized source plane. + The quaternion rotation. + When the method completes, contains the transformed plane. + + + + Transforms a normalized plane by a quaternion rotation. + + The normalized source plane. + The quaternion rotation. + The transformed plane. + + + + Transforms an array of normalized planes by a quaternion rotation. + + The array of normalized planes to transform. + The quaternion rotation. + Thrown when is null. + + + + Transforms a normalized plane by a matrix. + + The normalized source plane. + The transformation matrix. + When the method completes, contains the transformed plane. + + + + Transforms a normalized plane by a matrix. + + The normalized source plane. + The transformation matrix. + When the method completes, contains the transformed plane. + + + + Transforms an array of normalized planes by a matrix. + + The array of normalized planes to transform. + The transformation matrix. + Thrown when is null. + + + + Scales a plane by the given value. + + The amount by which to scale the plane. + The plane to scale. + The scaled plane. + + + + Scales a plane by the given value. + + The plane to scale. + The amount by which to scale the plane. + The scaled plane. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Gets or sets the component at the specified index. + + The value of the A, B, C, or D component, depending on the index. + The index of the component to access. Use 0 for the A component, 1 for the B component, 2 for the C component, and 3 for the D component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + Represents a four dimensional mathematical quaternion. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + A with all of its components set to one. + + + + + The identity (0, 0, 0, 1). + + + + + The X component of the quaternion. + + + + + The Y component of the quaternion. + + + + + The Z component of the quaternion. + + + + + The W component of the quaternion. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + A vector containing the values with which to initialize the components. + + + + Initializes a new instance of the struct. + + A vector containing the values with which to initialize the X, Y, and Z components. + Initial value for the W component of the quaternion. + + + + Initializes a new instance of the struct. + + A vector containing the values with which to initialize the X and Y components. + Initial value for the Z component of the quaternion. + Initial value for the W component of the quaternion. + + + + Initializes a new instance of the struct. + + Initial value for the X component of the quaternion. + Initial value for the Y component of the quaternion. + Initial value for the Z component of the quaternion. + Initial value for the W component of the quaternion. + + + + Initializes a new instance of the struct. + + The values to assign to the X, Y, Z, and W components of the quaternion. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Conjugates the quaternion. + + + + + Conjugates and renormalizes the quaternion. + + + + + Calculates the length of the quaternion. + + The length of the quaternion. + + may be preferred when only the relative length is needed + and speed is of the essence. + + + + + Calculates the squared length of the quaternion. + + The squared length of the quaternion. + + This method may be preferred to when only a relative length is needed + and speed is of the essence. + + + + + Converts the quaternion into a unit quaternion. + + + + + Creates an array containing the elements of the quaternion. + + A four-element array containing the components of the quaternion. + + + + Adds two quaternions. + + The first quaternion to add. + The second quaternion to add. + When the method completes, contains the sum of the two quaternions. + + + + Adds two quaternions. + + The first quaternion to add. + The second quaternion to add. + The sum of the two quaternions. + + + + Subtracts two quaternions. + + The first quaternion to subtract. + The second quaternion to subtract. + When the method completes, contains the difference of the two quaternions. + + + + Subtracts two quaternions. + + The first quaternion to subtract. + The second quaternion to subtract. + The difference of the two quaternions. + + + + Scales a quaternion by the given value. + + The quaternion to scale. + The amount by which to scale the quaternion. + When the method completes, contains the scaled quaternion. + + + + Scales a quaternion by the given value. + + The quaternion to scale. + The amount by which to scale the quaternion. + The scaled quaternion. + + + + Modulates a quaternion by another. + + The first quaternion to modulate. + The second quaternion to modulate. + When the moethod completes, contains the modulated quaternion. + + + + Modulates a quaternion by another. + + The first quaternion to modulate. + The second quaternion to modulate. + The modulated quaternion. + + + + Reverses the direction of a given quaternion. + + The quaternion to negate. + When the method completes, contains a quaternion facing in the opposite direction. + + + + Reverses the direction of a given quaternion. + + The quaternion to negate. + A quaternion facing in the opposite direction. + + + + Returns a containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. + + A containing the 4D Cartesian coordinates of vertex 1 of the triangle. + A containing the 4D Cartesian coordinates of vertex 2 of the triangle. + A containing the 4D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + When the method completes, contains a new containing the 4D Cartesian coordinates of the specified point. + + + + Returns a containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. + + A containing the 4D Cartesian coordinates of vertex 1 of the triangle. + A containing the 4D Cartesian coordinates of vertex 2 of the triangle. + A containing the 4D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + A new containing the 4D Cartesian coordinates of the specified point. + + + + Conjugates a quaternion. + + The quaternion to conjugate. + When the method completes, contains the conjugated quaternion. + + + + Conjugates a quaternion. + + The quaternion to conjugate. + The conjugated quaternion. + + + + Calculates the dot product of two quaternions. + + First source quaternion. + Second source quaternion. + When the method completes, contains the dot product of the two quaternions. + + + + Calculates the dot product of two quaternions. + + First source quaternion. + Second source quaternion. + The dot product of the two quaternions. + + + + Exponentiates a quaternion. + + The quaternion to exponentiate. + When the method completes, contains the exponentiated quaternion. + + + + Exponentiates a quaternion. + + The quaternion to exponentiate. + The exponentiated quaternion. + + + + Conjugates and renormalizes the quaternion. + + The quaternion to conjugate and renormalize. + When the method completes, contains the conjugated and renormalized quaternion. + + + + Conjugates and renormalizes the quaternion. + + The quaternion to conjugate and renormalize. + The conjugated and renormalized quaternion. + + + + Performs a linear interpolation between two quaternions. + + Start quaternion. + End quaternion. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two quaternions. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two quaternion. + + Start quaternion. + End quaternion. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two quaternions. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Calculates the natural logarithm of the specified quaternion. + + The quaternion whose logarithm will be calculated. + When the method completes, contains the natural logarithm of the quaternion. + + + + Calculates the natural logarithm of the specified quaternion. + + The quaternion whose logarithm will be calculated. + The natural logarithm of the quaternion. + + + + Converts the quaternion into a unit quaternion. + + The quaternion to normalize. + When the method completes, contains the normalized quaternion. + + + + Converts the quaternion into a unit quaternion. + + The quaternion to normalize. + The normalized quaternion. + + + + Creates a quaternion given a rotation and an axis. + + The axis of rotation. + The angle of rotation. + When the method completes, contains the newly created quaternion. + + + + Creates a quaternion given a rotation and an axis. + + The axis of rotation. + The angle of rotation. + The newly created quaternion. + + + + Creates a quaternion given a rotation matrix. + + The rotation matrix. + When the method completes, contains the newly created quaternion. + + + + Creates a quaternion given a rotation matrix. + + The rotation matrix. + The newly created quaternion. + + + + Creates a quaternion given a yaw, pitch, and roll value. + + The yaw of rotation. + The pitch of rotation. + The roll of rotation. + When the method completes, contains the newly created quaternion. + + + + Creates a quaternion given a yaw, pitch, and roll value. + + The yaw of rotation. + The pitch of rotation. + The roll of rotation. + The newly created quaternion. + + + + Interpolates between two quaternions, using spherical linear interpolation. + + Start quaternion. + End quaternion. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the spherical linear interpolation of the two quaternions. + + + + Interpolates between two quaternions, using spherical linear interpolation. + + Start quaternion. + End quaternion. + Value between 0 and 1 indicating the weight of . + The spherical linear interpolation of the two quaternions. + + + + Interpolates between quaternions, using spherical quadrangle interpolation. + + First source quaternion. + Second source quaternion. + Thrid source quaternion. + Fourth source quaternion. + Value between 0 and 1 indicating the weight of interpolation. + When the method completes, contains the spherical quadrangle interpolation of the quaternions. + + + + Interpolates between quaternions, using spherical quadrangle interpolation. + + First source quaternion. + Second source quaternion. + Thrid source quaternion. + Fourth source quaternion. + Value between 0 and 1 indicating the weight of interpolation. + The spherical quadrangle interpolation of the quaternions. + + + + Sets up control points for spherical quadrangle interpolation. + + First source quaternion. + Second source quaternion. + Third source quaternion. + Fourth source quaternion. + An array of three quaternions that represent control points for spherical quadrangle interpolation. + + + + Adds two quaternions. + + The first quaternion to add. + The second quaternion to add. + The sum of the two quaternions. + + + + Subtracts two quaternions. + + The first quaternion to subtract. + The second quaternion to subtract. + The difference of the two quaternions. + + + + Reverses the direction of a given quaternion. + + The quaternion to negate. + A quaternion facing in the opposite direction. + + + + Scales a quaternion by the given value. + + The quaternion to scale. + The amount by which to scale the quaternion. + The scaled quaternion. + + + + Scales a quaternion by the given value. + + The quaternion to scale. + The amount by which to scale the quaternion. + The scaled quaternion. + + + + Multiplies a quaternion by another. + + The first quaternion to multiply. + The second quaternion to multiply. + The multiplied quaternion. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Gets a value indicating whether this instance is equivalent to the identity quaternion. + + + true if this instance is an identity quaternion; otherwise, false. + + + + + Gets a value indicting whether this instance is normalized. + + + + + Gets the angle of the quaternion. + + The quaternion's angle. + + + + Gets the axis components of the quaternion. + + The axis components of the quaternion. + + + + Gets or sets the component at the specified index. + + The value of the X, Y, Z, or W component, depending on the index. + The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + Represents a three dimensional line based on a point in space and a direction. + + + + + The position in three dimensional space where the ray starts. + + + + + The normalized direction in which the ray points. + + + + + Initializes a new instance of the struct. + + The position in three dimensional space of the origin of the ray. + The normalized direction of the ray. + + + + Determines if there is an intersection between the current object and a point. + + The point to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The ray to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The plane to test + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The plane to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The plane to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a triangle. + + The first vertex of the triangle to test. + The second vertex of the triangle to test. + The third vertex of the triangle to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a triangle. + + The first vertex of the triangle to test. + The second vertex of the triangle to test. + The third vertex of the triangle to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a triangle. + + The first vertex of the triangle to test. + The second vertex of the triangle to test. + The third vertex of the triangle to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The box to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The box to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The box to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The sphere to test. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The sphere to test. + When the method completes, contains the distance of the intersection, + or 0 if there was no intersection. + Whether the two objects intersected. + + + + Determines if there is an intersection between the current object and a . + + The sphere to test. + When the method completes, contains the point of intersection, + or if there was no intersection. + Whether the two objects intersected. + + + + Calculates a world space from 2d screen coordinates. + + X coordinate on 2d screen. + Y coordinate on 2d screen. + . + Transformation . + Resulting . + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Define a Rectangle. This structure is slightly different from System.Drawing.Rectangle as It is + internally storing Left,Top,Right,Bottom instead of Left,Top,Width,Height. + Although automatic casting from a to System.Drawing.Rectangle is provided by this class. + + + + + An empty rectangle + + + + + Initializes a new instance of the struct. + + The left. + The top. + The right. + The bottom. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Performs an implicit conversion from to . + + The input. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The input. + The result of the conversion. + + + + Implements the operator ==. + + The left. + The right. + The result of the operator. + + + + Implements the operator !=. + + The left. + The right. + The result of the operator. + + + + + + + Gets or sets the left. + + The left. + + + + Gets or sets the top. + + The top. + + + + Gets or sets the right. + + The right. + + + + Gets or sets the bottom. + + The bottom. + + + + Gets or sets the left position. + + The left position. + + + + Gets or sets the top position. + + The top position. + + + + Gets or sets the width. + + The width. + + + + Gets or sets the height. + + The height. + + + + Define a RectangleF. This structure is slightly different from System.Drawing.RectangleF as It is + internally storing Left,Top,Right,Bottom instead of Left,Top,Width,Height. + Although automatic casting from a to System.Drawing.Rectangle is provided by this class. + + + + + An empty rectangle + + + + + Initializes a new instance of the struct. + + The left. + The top. + The right. + The bottom. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified point is inside . + + X point coordinate. + Y point coordinate. + true if point is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Checks, if specified is inside . + + Coordinate . + true if is inside , otherwise false. + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Performs an implicit conversion from to . + + The input. + The result of the conversion. + + + + Rectangles the F. + + The input. + + + + + Implements the operator ==. + + The left. + The right. + The result of the operator. + + + + Implements the operator !=. + + The left. + The right. + The result of the operator. + + + + + + + Gets or sets the left. + + The left. + + + + Gets or sets the top. + + The top. + + + + Gets or sets the right. + + The right. + + + + Gets or sets the bottom. + + The bottom. + + + + Gets or sets the left position. + + The left position. + + + + Gets or sets the top position. + + The top position. + + + + Gets or sets the width. + + The width. + + + + Gets or sets the height. + + The height. + + + + Result structure for COM methods. + + + + + Initializes a new instance of the struct. + + The HRESULT error code. + + + + Initializes a new instance of the struct. + + The HRESULT error code. + + + + Performs an implicit conversion from to . + + The result. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The result. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The result. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The result. + The result of the conversion. + + + + Equalses the specified other. + + The other. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Implements the operator ==. + + The left. + The right. + The result of the operator. + + + + Implements the operator !=. + + The left. + The right. + The result of the operator. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Checks the error. + + + + + Gets a from an . + + The exception + The associated result code + + + + Gets the result from win32 error. + + The win32Error. + A HRESULT. + + + + Result code Ok + + + + + Result code False + + + + + Result code Abord + + + + + Result code AccessDenied + + + + + Result code Fail + + + + + Resuld code Handle + + + + + Result code invalid argument + + + + + Result code no interface + + + + + Result code not implemented + + + + + Result code out of memory + + + + + Result code Invalid pointer + + + + + Unexpected failure + + + + + Gets the HRESULT error code. + + The HRESULT error code. + + + + Gets a value indicating whether this is success. + + true if success; otherwise, false. + + + + Gets a value indicating whether this is failure. + + true if failure; otherwise, false. + + + + The maximum number of bytes to which a pointer can point. Use for a count that must span the full range of a pointer. + Equivalent to Windows type SIZE_T. + + + + + Initializes a new instance of the struct. + + The size. + + + + Default constructor. + + value to set + + + + Default constructor. + + value to set + + + + Default constructor. + + value to set + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Adds two sizes. + + The first size to add. + The second size to add. + The sum of the two sizes. + + + + Assert a size (return it unchanged). + + The size to assert (unchange). + The asserted (unchanged) size. + + + + Subtracts two sizes. + + The first size to subtract. + The second size to subtract. + The difference of the two sizes. + + + + Reverses the direction of a given size. + + The size to negate. + A size facing in the opposite direction. + + + + Scales a size by the given value. + + The size to scale. + The amount by which to scale the size. + The scaled size. + + + + Scales a size by the given value. + + The size to scale. + The amount by which to scale the size. + The scaled size. + + + + Scales a size by the given value. + + The size to scale. + The amount by which to scale the size. + The scaled size. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from void* to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to void*. + + The value. + The result of the conversion. + + + + A Delegate to get a property value from an object. + + Type of the getter + The obj to get the property from + The value to get + + + + A Delegate to set a property value to an object. + + Type of the setter + The obj to set the property from + The value to set + + + + Utility class. + + + + + Native memcpy. + + The destination memory location + The source memory location. + The count. + + + + + Compares two block of memory. + + The pointer to compare from. + The pointer to compare against. + The size in bytes to compare. + True if the buffers are equivalent, false otherwise. + + + + Clears the memory. + + The dest. + The value. + The size in bytes to clear. + + + + Return the sizeof a struct from a CLR. Equivalent to sizeof operator but works on generics too. + + a struct to evaluate + sizeof this struct + + + + Return the sizeof an array of struct. Equivalent to sizeof operator but works on generics too. + + a struct + The array of struct to evaluate. + sizeof in bytes of this array of struct + + + + Pins the specified source and call an action with the pinned pointer. + + The type of the structure to pin + The source. + The pin action to perform on the pinned pointer. + + + + Pins the specified source and call an action with the pinned pointer. + + The type of the structure to pin + The source array. + The pin action to perform on the pinned pointer. + + + + Covnerts a structured array to an equivalent byte array. + + + The source. + + + + + Reads the specified T data from a memory location. + + Type of a data to read + Memory location to read from. + The data read from the memory location + + + + Reads the specified T data from a memory location. + + Type of a data to read + Memory location to read from. + The data write to. + source pointer + sizeof(T) + + + + Reads the specified T data from a memory location. + + Type of a data to read + Memory location to read from. + The data write to. + source pointer + sizeof(T) + + + + Reads the specified T data from a memory location. + + Type of a data to read + Memory location to read from. + The data write to. + source pointer + sizeof(T) + + + + Reads the specified array T[] data from a memory location. + + Type of a data to read + Memory location to read from. + The data write to. + The offset in the array to write to. + The number of T element to read from the memory location + source pointer + sizeof(T) * count + + + + Writes the specified T data to a memory location. + + Type of a data to write + Memory location to write to. + The data to write. + destination pointer + sizeof(T) + + + + Writes the specified T data to a memory location. + + Type of a data to write + Memory location to write to. + The data to write. + destination pointer + sizeof(T) + + + + Writes the specified array T[] data to a memory location. + + Type of a data to write + Memory location to write to. + The array of T data to write. + The offset in the array to read from. + The number of T element to write to the memory location + destination pointer + sizeof(T) * count + + + + Converts to int array. + + The array. + + + + + Converts to bool array. + + The array. + + + + + Gets the from a type. + + The type. + The guid associated with this type + + + + Allocate an aligned memory buffer. + + Size of the buffer to allocate. + Alignment, 16 bytes by default. + A pointer to a buffer aligned. + + To free this buffer, call + + + + + Allocate an aligned memory buffer and clear it with a specified value (0 by defaault). + + Size of the buffer to allocate. + Default value used to clear the buffer. + Alignment, 16 bytes by default. + A pointer to a buffer aligned. + + To free this buffer, call + + + + + Determines whether the specified memory pointer is aligned in memory. + + The memory pointer. + The align. + true if the specified memory pointer is aligned in memory; otherwise, false. + + + + Allocate an aligned memory buffer. + + A pointer to a buffer aligned. + + The buffer must have been allocated with + + + + + Converts a pointer to a null-terminating string up to maxLength characters to a .Net string. + + The pointer to an ansi null string. + Maximum length of the string + + + + + Converts a pointer to a null-terminating string up to maxLength characters to a .Net string. + + The pointer to an unicode null string. + Maximum length of the string + + + + + Gets the IUnknown from object. Similar to but accept null object + by returning an IntPtr.Zero IUnknown pointer. + + The managed object. + an IUnknown pointer to a managed object + + + + Gets an object from an IUnknown pointer. Similar to but accept IntPtr.Zero + by returning a null object. + + an IUnknown pointer to a managed object + The managed object. + + + + String helper join method to display an array of object as a single string. + + The separator. + The array. + a string with array elements serparated by the seperator + + + + String helper join method to display an enumrable of object as a single string. + + The separator. + The enumerable. + a string with array elements serparated by the seperator + + + + String helper join method to display an enumrable of object as a single string. + + The separator. + The enumerable. + a string with array elements serparated by the seperator + + + + Converts a blob to a string. + + A blob. + A string extracted from a blob. + + + + Equivalent to IntPtr.Add method from 3.5+ .NET Framework. + + A native pointer + The offset to add (number of bytes) + + + + + Read stream to a byte[] buffer + + input stream + a byte[] buffer + + + + Read stream to a byte[] buffer + + input stream + length to read + a byte[] buffer + + + + Compares two collection, element by elements. + + A "from" enumerator. + A "to" enumerator. + True if lists are identical. False otherwise. + + + + Compares two collection, element by elements. + + A "from" enumerator. + A "to" enumerator. + True if lists are identical. False otherwise. + + + + Compares two collection, element by elements. + + The collection to compare from. + The colllection to compare to. + True if lists are identical (but no necessarely of the same time). False otherwise. + + + + Gets the custom attribute. + + Type of the custom attribute + The member info. + if set to true [inherited]. + The custom attribute or null if not found + + + + Gets the custom attributes. + + Type of the custom attribute + The member info. + if set to true [inherited]. + The custom attribute or null if not found + + + + Determines whether fromType can be assigned to toType. + + To type. + From type. + + true if [is assignable from] [the specified to type]; otherwise, false. + + + + + Determines whether the specified type to test is an enum. + + The type to test. + + true if the specified type to test is an enum; otherwise, false. + + + + + Determines whether the specified type to test is a valuetype. + + The type to test. + + true if the specified type to test is a valuetype; otherwise, false. + + + + + Builds a fast property getter from a type and a property info. + + Type of the getter + Type of the custom effect. + The property info to get the value from. + A compiled delegate + + + + Builds a fast property setter from a type and a property info. + + Type of the setter + Type of the custom effect. + The property info to set the value to. + A compiled delegate + + + + Suspends the current thread of a . + + The duration to sleep in milliseconds. + + + + Finds an explicit converstion between a source type and a target type + + Type of the source. + Type of the target. + The method to perform the conversion. null if not found + + + + Loads a native library. + + Name of the DLL. + If dll was not found + + + + + Gets the proc address of a dll. + + The handle. + The DLL function to import. + If the function was not found + + + + + Compute a FNV1-modified Hash from Fowler/Noll/Vo Hash improved version. + + Data to compute the hash from. + A hash value + + + Determines the concurrency model used for incoming calls to objects created by this thread. This concurrency model can be either apartment-threaded or multi-threaded. + + + + Initializes the thread for apartment-threaded object concurrency. + + + + + Initializes the thread for multi-threaded object concurrency. + + + + + Disables DDE for OLE1 support. + + + + + Trade memory for speed. + + + + + Represents a two dimensional mathematical vector. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + The X unit (1, 0). + + + + + The Y unit (0, 1). + + + + + A with all of its components set to one. + + + + + The X component of the vector. + + + + + The Y component of the vector. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + Initial value for the X component of the vector. + Initial value for the Y component of the vector. + + + + Initializes a new instance of the struct. + + The values to assign to the X and Y components of the vector. This must be an array with two elements. + Thrown when is null. + Thrown when contains more or less than two elements. + + + + Calculates the length of the vector. + + The length of the vector. + + may be preferred when only the relative length is needed + and speed is of the essence. + + + + + Calculates the squared length of the vector. + + The squared length of the vector. + + This method may be preferred to when only a relative length is needed + and speed is of the essence. + + + + + Converts the vector into a unit vector. + + + + + Creates an array containing the elements of the vector. + + A two-element array containing the components of the vector. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + When the method completes, contains the sum of the two vectors. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + When the method completes, contains the difference of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + When the method completes, contains the modulated vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + The modulated vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Reverses the direction of a given vector. + + The vector to negate. + When the method completes, contains a vector facing in the opposite direction. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Returns a containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. + + A containing the 2D Cartesian coordinates of vertex 1 of the triangle. + A containing the 2D Cartesian coordinates of vertex 2 of the triangle. + A containing the 2D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + When the method completes, contains the 2D Cartesian coordinates of the specified point. + + + + Returns a containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. + + A containing the 2D Cartesian coordinates of vertex 1 of the triangle. + A containing the 2D Cartesian coordinates of vertex 2 of the triangle. + A containing the 2D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + A new containing the 2D Cartesian coordinates of the specified point. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Calculates the distance between two vectors. + + The first vector. + The second vector. + When the method completes, contains the distance between the two vectors. + + may be preferred when only the relative distance is needed + and speed is of the essence. + + + + + Calculates the distance between two vectors. + + The first vector. + The second vector. + The distance between the two vectors. + + may be preferred when only the relative distance is needed + and speed is of the essence. + + + + + Calculates the squared distance between two vectors. + + The first vector. + The second vector + When the method completes, contains the squared distance between the two vectors. + Distance squared is the value before taking the square root. + Distance squared can often be used in place of distance if relative comparisons are being made. + For example, consider three points A, B, and C. To determine whether B or C is further from A, + compare the distance between A and B to the distance between A and C. Calculating the two distances + involves two square roots, which are computationally expensive. However, using distance squared + provides the same information and avoids calculating two square roots. + + + + + Calculates the squared distance between two vectors. + + The first vector. + The second vector. + The squared distance between the two vectors. + Distance squared is the value before taking the square root. + Distance squared can often be used in place of distance if relative comparisons are being made. + For example, consider three points A, B, and C. To determine whether B or C is further from A, + compare the distance between A and B to the distance between A and C. Calculating the two distances + involves two square roots, which are computationally expensive. However, using distance squared + provides the same information and avoids calculating two square roots. + + + + + Calculates the dot product of two vectors. + + First source vector. + Second source vector. + When the method completes, contains the dot product of the two vectors. + + + + Calculates the dot product of two vectors. + + First source vector. + Second source vector. + The dot product of the two vectors. + + + + Converts the vector into a unit vector. + + The vector to normalize. + When the method completes, contains the normalized vector. + + + + Converts the vector into a unit vector. + + The vector to normalize. + The normalized vector. + + + + Performs a linear interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two vectors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two vectors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two vectors. + + + + Performs a cubic interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two vectors. + + + + Performs a Hermite spline interpolation. + + First source position vector. + First source tangent vector. + Second source position vector. + Second source tangent vector. + Weighting factor. + When the method completes, contains the result of the Hermite spline interpolation. + + + + Performs a Hermite spline interpolation. + + First source position vector. + First source tangent vector. + Second source position vector. + Second source tangent vector. + Weighting factor. + The result of the Hermite spline interpolation. + + + + Performs a Catmull-Rom interpolation using the specified positions. + + The first position in the interpolation. + The second position in the interpolation. + The third position in the interpolation. + The fourth position in the interpolation. + Weighting factor. + When the method completes, contains the result of the Catmull-Rom interpolation. + + + + Performs a Catmull-Rom interpolation using the specified positions. + + The first position in the interpolation. + The second position in the interpolation. + The third position in the interpolation. + The fourth position in the interpolation. + Weighting factor. + A vector that is the result of the Catmull-Rom interpolation. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the largest components of the source vectors. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the largest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the smallest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the smallest components of the source vectors. + + + + Returns the reflection of a vector off a surface that has the specified normal. + + The source vector. + Normal of the surface. + When the method completes, contains the reflected vector. + Reflect only gives the direction of a reflection off a surface, it does not determine + whether the original vector was close enough to the surface to hit it. + + + + Returns the reflection of a vector off a surface that has the specified normal. + + The source vector. + Normal of the surface. + The reflected vector. + Reflect only gives the direction of a reflection off a surface, it does not determine + whether the original vector was close enough to the surface to hit it. + + + + Orthogonalizes a list of vectors. + + The list of orthogonalized vectors. + The list of vectors to orthogonalize. + + Orthogonalization is the process of making all vectors orthogonal to each other. This + means that any given vector in the list will be orthogonal to any other given vector in the + list. + Because this method uses the modified Gram-Schmidt process, the resulting vectors + tend to be numerically unstable. The numeric stability decreases according to the vectors + position in the list so that the first vector is the most stable and the last vector is the + least stable. + + Thrown when or is null. + Thrown when is shorter in length than . + + + + Orthonormalizes a list of vectors. + + The list of orthonormalized vectors. + The list of vectors to orthonormalize. + + Orthonormalization is the process of making all vectors orthogonal to each + other and making all vectors of unit length. This means that any given vector will + be orthogonal to any other given vector in the list. + Because this method uses the modified Gram-Schmidt process, the resulting vectors + tend to be numerically unstable. The numeric stability decreases according to the vectors + position in the list so that the first vector is the most stable and the last vector is the + least stable. + + Thrown when or is null. + Thrown when is shorter in length than . + + + + Transforms a 2D vector by the given rotation. + + The vector to rotate. + The rotation to apply. + When the method completes, contains the transformed . + + + + Transforms a 2D vector by the given rotation. + + The vector to rotate. + The rotation to apply. + The transformed . + + + + Transforms an array of vectors by the given rotation. + + The array of vectors to transform. + The rotation to apply. + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + + + Transforms a 2D vector by the given . + + The source vector. + The transformation . + When the method completes, contains the transformed . + + + + Transforms a 2D vector by the given . + + The source vector. + The transformation . + The transformed . + + + + Transforms an array of 2D vectors by the given . + + The array of vectors to transform. + The transformation . + The array for which the transformed vectors are stored. + Thrown when or is null. + Thrown when is shorter in length than . + + + + Performs a coordinate transformation using the given . + + The coordinate vector to transform. + The transformation . + When the method completes, contains the transformed coordinates. + + A coordinate transform performs the transformation with the assumption that the w component + is one. The four dimensional vector obtained from the transformation operation has each + component in the vector divided by the w component. This forces the wcomponent to be one and + therefore makes the vector homogeneous. The homogeneous vector is often prefered when working + with coordinates as the w component can safely be ignored. + + + + + Performs a coordinate transformation using the given . + + The coordinate vector to transform. + The transformation . + The transformed coordinates. + + A coordinate transform performs the transformation with the assumption that the w component + is one. The four dimensional vector obtained from the transformation operation has each + component in the vector divided by the w component. This forces the wcomponent to be one and + therefore makes the vector homogeneous. The homogeneous vector is often prefered when working + with coordinates as the w component can safely be ignored. + + + + + Performs a coordinate transformation on an array of vectors using the given . + + The array of coordinate vectors to trasnform. + The transformation . + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + A coordinate transform performs the transformation with the assumption that the w component + is one. The four dimensional vector obtained from the transformation operation has each + component in the vector divided by the w component. This forces the wcomponent to be one and + therefore makes the vector homogeneous. The homogeneous vector is often prefered when working + with coordinates as the w component can safely be ignored. + + + + + Performs a normal transformation using the given . + + The normal vector to transform. + The transformation . + When the method completes, contains the transformed normal. + + A normal transform performs the transformation with the assumption that the w component + is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The + end result is a vector that is not translated, but all other transformation properties + apply. This is often prefered for normal vectors as normals purely represent direction + rather than location because normal vectors should not be translated. + + + + + Performs a normal transformation using the given . + + The normal vector to transform. + The transformation . + The transformed normal. + + A normal transform performs the transformation with the assumption that the w component + is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The + end result is a vector that is not translated, but all other transformation properties + apply. This is often prefered for normal vectors as normals purely represent direction + rather than location because normal vectors should not be translated. + + + + + Performs a normal transformation on an array of vectors using the given . + + The array of normal vectors to transform. + The transformation . + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + A normal transform performs the transformation with the assumption that the w component + is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The + end result is a vector that is not translated, but all other transformation properties + apply. This is often prefered for normal vectors as normals purely represent direction + rather than location because normal vectors should not be translated. + + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Modulates a vector with another by performing component-wise multiplication equivalent to . + + The first vector to multiply. + The second vector to multiply. + The multiplication of the two vectors. + + + + Assert a vector (return it unchanged). + + The vector to assert (unchange). + The asserted (unchanged) vector. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Gets a value indicting whether this instance is normalized. + + + + + Gets or sets the component at the specified index. + + The value of the X or Y component, depending on the index. + The index of the component to access. Use 0 for the X component and 1 for the Y component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 1]. + + + + Represents a three dimensional mathematical vector. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + The X unit (1, 0, 0). + + + + + The Y unit (0, 1, 0). + + + + + The Z unit (0, 0, 1). + + + + + A with all of its components set to one. + + + + + The X component of the vector. + + + + + The Y component of the vector. + + + + + The Z component of the vector. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + Initial value for the X component of the vector. + Initial value for the Y component of the vector. + Initial value for the Z component of the vector. + + + + Initializes a new instance of the struct. + + A vector containing the values with which to initialize the X and Y components. + Initial value for the Z component of the vector. + + + + Initializes a new instance of the struct. + + The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements. + Thrown when is null. + Thrown when contains more or less than three elements. + + + + Calculates the length of the vector. + + The length of the vector. + + may be preferred when only the relative length is needed + and speed is of the essence. + + + + + Calculates the squared length of the vector. + + The squared length of the vector. + + This method may be preferred to when only a relative length is needed + and speed is of the essence. + + + + + Converts the vector into a unit vector. + + + + + Creates an array containing the elements of the vector. + + A three-element array containing the components of the vector. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + When the method completes, contains the sum of the two vectors. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + When the method completes, contains the difference of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + When the method completes, contains the modulated vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + The modulated vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Reverses the direction of a given vector. + + The vector to negate. + When the method completes, contains a vector facing in the opposite direction. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Returns a containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle. + + A containing the 3D Cartesian coordinates of vertex 1 of the triangle. + A containing the 3D Cartesian coordinates of vertex 2 of the triangle. + A containing the 3D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + When the method completes, contains the 3D Cartesian coordinates of the specified point. + + + + Returns a containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle. + + A containing the 3D Cartesian coordinates of vertex 1 of the triangle. + A containing the 3D Cartesian coordinates of vertex 2 of the triangle. + A containing the 3D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + A new containing the 3D Cartesian coordinates of the specified point. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Calculates the cross product of two vectors. + + First source vector. + Second source vector. + When the method completes, contains he cross product of the two vectors. + + + + Calculates the cross product of two vectors. + + First source vector. + Second source vector. + The cross product of the two vectors. + + + + Calculates the distance between two vectors. + + The first vector. + The second vector. + When the method completes, contains the distance between the two vectors. + + may be preferred when only the relative distance is needed + and speed is of the essence. + + + + + Calculates the distance between two vectors. + + The first vector. + The second vector. + The distance between the two vectors. + + may be preferred when only the relative distance is needed + and speed is of the essence. + + + + + Calculates the squared distance between two vectors. + + The first vector. + The second vector. + When the method completes, contains the squared distance between the two vectors. + Distance squared is the value before taking the square root. + Distance squared can often be used in place of distance if relative comparisons are being made. + For example, consider three points A, B, and C. To determine whether B or C is further from A, + compare the distance between A and B to the distance between A and C. Calculating the two distances + involves two square roots, which are computationally expensive. However, using distance squared + provides the same information and avoids calculating two square roots. + + + + + Calculates the squared distance between two vectors. + + The first vector. + The second vector. + The squared distance between the two vectors. + Distance squared is the value before taking the square root. + Distance squared can often be used in place of distance if relative comparisons are being made. + For example, consider three points A, B, and C. To determine whether B or C is further from A, + compare the distance between A and B to the distance between A and C. Calculating the two distances + involves two square roots, which are computationally expensive. However, using distance squared + provides the same information and avoids calculating two square roots. + + + + + Calculates the dot product of two vectors. + + First source vector. + Second source vector. + When the method completes, contains the dot product of the two vectors. + + + + Calculates the dot product of two vectors. + + First source vector. + Second source vector. + The dot product of the two vectors. + + + + Converts the vector into a unit vector. + + The vector to normalize. + When the method completes, contains the normalized vector. + + + + Converts the vector into a unit vector. + + The vector to normalize. + The normalized vector. + + + + Performs a linear interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two vectors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two vectors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two vectors. + + + + Performs a cubic interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two vectors. + + + + Performs a Hermite spline interpolation. + + First source position vector. + First source tangent vector. + Second source position vector. + Second source tangent vector. + Weighting factor. + When the method completes, contains the result of the Hermite spline interpolation. + + + + Performs a Hermite spline interpolation. + + First source position vector. + First source tangent vector. + Second source position vector. + Second source tangent vector. + Weighting factor. + The result of the Hermite spline interpolation. + + + + Performs a Catmull-Rom interpolation using the specified positions. + + The first position in the interpolation. + The second position in the interpolation. + The third position in the interpolation. + The fourth position in the interpolation. + Weighting factor. + When the method completes, contains the result of the Catmull-Rom interpolation. + + + + Performs a Catmull-Rom interpolation using the specified positions. + + The first position in the interpolation. + The second position in the interpolation. + The third position in the interpolation. + The fourth position in the interpolation. + Weighting factor. + A vector that is the result of the Catmull-Rom interpolation. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the largest components of the source vectors. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the largest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the smallest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the smallest components of the source vectors. + + + + Projects a 3D vector from object space into screen space. + + The vector to project. + The X position of the viewport. + The Y position of the viewport. + The width of the viewport. + The height of the viewport. + The minimum depth of the viewport. + The maximum depth of the viewport. + The combined world-view-projection matrix. + When the method completes, contains the vector in screen space. + + + + Projects a 3D vector from object space into screen space. + + The vector to project. + The X position of the viewport. + The Y position of the viewport. + The width of the viewport. + The height of the viewport. + The minimum depth of the viewport. + The maximum depth of the viewport. + The combined world-view-projection matrix. + The vector in screen space. + + + + Projects a 3D vector from screen space into object space. + + The vector to project. + The X position of the viewport. + The Y position of the viewport. + The width of the viewport. + The height of the viewport. + The minimum depth of the viewport. + The maximum depth of the viewport. + The combined world-view-projection matrix. + When the method completes, contains the vector in object space. + + + + Projects a 3D vector from screen space into object space. + + The vector to project. + The X position of the viewport. + The Y position of the viewport. + The width of the viewport. + The height of the viewport. + The minimum depth of the viewport. + The maximum depth of the viewport. + The combined world-view-projection matrix. + The vector in object space. + + + + Returns the reflection of a vector off a surface that has the specified normal. + + The source vector. + Normal of the surface. + When the method completes, contains the reflected vector. + Reflect only gives the direction of a reflection off a surface, it does not determine + whether the original vector was close enough to the surface to hit it. + + + + Returns the reflection of a vector off a surface that has the specified normal. + + The source vector. + Normal of the surface. + The reflected vector. + Reflect only gives the direction of a reflection off a surface, it does not determine + whether the original vector was close enough to the surface to hit it. + + + + Orthogonalizes a list of vectors. + + The list of orthogonalized vectors. + The list of vectors to orthogonalize. + + Orthogonalization is the process of making all vectors orthogonal to each other. This + means that any given vector in the list will be orthogonal to any other given vector in the + list. + Because this method uses the modified Gram-Schmidt process, the resulting vectors + tend to be numerically unstable. The numeric stability decreases according to the vectors + position in the list so that the first vector is the most stable and the last vector is the + least stable. + + Thrown when or is null. + Thrown when is shorter in length than . + + + + Orthonormalizes a list of vectors. + + The list of orthonormalized vectors. + The list of vectors to orthonormalize. + + Orthonormalization is the process of making all vectors orthogonal to each + other and making all vectors of unit length. This means that any given vector will + be orthogonal to any other given vector in the list. + Because this method uses the modified Gram-Schmidt process, the resulting vectors + tend to be numerically unstable. The numeric stability decreases according to the vectors + position in the list so that the first vector is the most stable and the last vector is the + least stable. + + Thrown when or is null. + Thrown when is shorter in length than . + + + + Transforms a 3D vector by the given rotation. + + The vector to rotate. + The rotation to apply. + When the method completes, contains the transformed . + + + + Transforms a 3D vector by the given rotation. + + The vector to rotate. + The rotation to apply. + The transformed . + + + + Transforms an array of vectors by the given rotation. + + The array of vectors to transform. + The rotation to apply. + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + + + Transforms a 3D vector by the given . + + The source vector. + The transformation . + When the method completes, contains the transformed . + + + + Transforms a 3D vector by the given . + + The source vector. + The transformation . + The transformed . + + + + Transforms an array of 3D vectors by the given . + + The array of vectors to transform. + The transformation . + The array for which the transformed vectors are stored. + Thrown when or is null. + Thrown when is shorter in length than . + + + + Performs a coordinate transformation using the given . + + The coordinate vector to transform. + The transformation . + When the method completes, contains the transformed coordinates. + + A coordinate transform performs the transformation with the assumption that the w component + is one. The four dimensional vector obtained from the transformation operation has each + component in the vector divided by the w component. This forces the wcomponent to be one and + therefore makes the vector homogeneous. The homogeneous vector is often prefered when working + with coordinates as the w component can safely be ignored. + + + + + Performs a coordinate transformation using the given . + + The coordinate vector to transform. + The transformation . + The transformed coordinates. + + A coordinate transform performs the transformation with the assumption that the w component + is one. The four dimensional vector obtained from the transformation operation has each + component in the vector divided by the w component. This forces the wcomponent to be one and + therefore makes the vector homogeneous. The homogeneous vector is often prefered when working + with coordinates as the w component can safely be ignored. + + + + + Performs a coordinate transformation on an array of vectors using the given . + + The array of coordinate vectors to trasnform. + The transformation . + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + A coordinate transform performs the transformation with the assumption that the w component + is one. The four dimensional vector obtained from the transformation operation has each + component in the vector divided by the w component. This forces the wcomponent to be one and + therefore makes the vector homogeneous. The homogeneous vector is often prefered when working + with coordinates as the w component can safely be ignored. + + + + + Performs a normal transformation using the given . + + The normal vector to transform. + The transformation . + When the method completes, contains the transformed normal. + + A normal transform performs the transformation with the assumption that the w component + is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The + end result is a vector that is not translated, but all other transformation properties + apply. This is often prefered for normal vectors as normals purely represent direction + rather than location because normal vectors should not be translated. + + + + + Performs a normal transformation using the given . + + The normal vector to transform. + The transformation . + The transformed normal. + + A normal transform performs the transformation with the assumption that the w component + is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The + end result is a vector that is not translated, but all other transformation properties + apply. This is often prefered for normal vectors as normals purely represent direction + rather than location because normal vectors should not be translated. + + + + + Performs a normal transformation on an array of vectors using the given . + + The array of normal vectors to transform. + The transformation . + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + A normal transform performs the transformation with the assumption that the w component + is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The + end result is a vector that is not translated, but all other transformation properties + apply. This is often prefered for normal vectors as normals purely represent direction + rather than location because normal vectors should not be translated. + + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Modulates a vector with another by performing component-wise multiplication equivalent to . + + The first vector to multiply. + The second vector to multiply. + The multiplication of the two vectors. + + + + Assert a vector (return it unchanged). + + The vector to assert (unchange). + The asserted (unchanged) vector. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Gets a value indicting whether this instance is normalized. + + + + + Gets or sets the component at the specified index. + + The value of the X, Y, or Z component, depending on the index. + The index of the component to access. Use 0 for the X component, 1 for the Y component, and 2 for the Z component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 2]. + + + + Represents a four dimensional mathematical vector. + + + + + The size of the type, in bytes. + + + + + A with all of its components set to zero. + + + + + The X unit (1, 0, 0, 0). + + + + + The Y unit (0, 1, 0, 0). + + + + + The Z unit (0, 0, 1, 0). + + + + + The W unit (0, 0, 0, 1). + + + + + A with all of its components set to one. + + + + + The X component of the vector. + + + + + The Y component of the vector. + + + + + The Z component of the vector. + + + + + The W component of the vector. + + + + + Initializes a new instance of the struct. + + The value that will be assigned to all components. + + + + Initializes a new instance of the struct. + + Initial value for the X component of the vector. + Initial value for the Y component of the vector. + Initial value for the Z component of the vector. + Initial value for the W component of the vector. + + + + Initializes a new instance of the struct. + + A vector containing the values with which to initialize the X, Y, and Z components. + Initial value for the W component of the vector. + + + + Initializes a new instance of the struct. + + A vector containing the values with which to initialize the X and Y components. + Initial value for the Z component of the vector. + Initial value for the W component of the vector. + + + + Initializes a new instance of the struct. + + The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. + Thrown when is null. + Thrown when contains more or less than four elements. + + + + Calculates the length of the vector. + + The length of the vector. + + may be preferred when only the relative length is needed + and speed is of the essence. + + + + + Calculates the squared length of the vector. + + The squared length of the vector. + + This method may be preferred to when only a relative length is needed + and speed is of the essence. + + + + + Converts the vector into a unit vector. + + + + + Creates an array containing the elements of the vector. + + A four-element array containing the components of the vector. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + When the method completes, contains the sum of the two vectors. + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + When the method completes, contains the difference of the two vectors. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + When the method completes, contains the modulated vector. + + + + Modulates a vector with another by performing component-wise multiplication. + + The first vector to modulate. + The second vector to modulate. + The modulated vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + When the method completes, contains the scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Reverses the direction of a given vector. + + The vector to negate. + When the method completes, contains a vector facing in the opposite direction. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Returns a containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle. + + A containing the 4D Cartesian coordinates of vertex 1 of the triangle. + A containing the 4D Cartesian coordinates of vertex 2 of the triangle. + A containing the 4D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + When the method completes, contains the 4D Cartesian coordinates of the specified point. + + + + Returns a containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle. + + A containing the 4D Cartesian coordinates of vertex 1 of the triangle. + A containing the 4D Cartesian coordinates of vertex 2 of the triangle. + A containing the 4D Cartesian coordinates of vertex 3 of the triangle. + Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). + Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). + A new containing the 4D Cartesian coordinates of the specified point. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + When the method completes, contains the clamped value. + + + + Restricts a value to be within a specified range. + + The value to clamp. + The minimum value. + The maximum value. + The clamped value. + + + + Calculates the distance between two vectors. + + The first vector. + The second vector. + When the method completes, contains the distance between the two vectors. + + may be preferred when only the relative distance is needed + and speed is of the essence. + + + + + Calculates the distance between two vectors. + + The first vector. + The second vector. + The distance between the two vectors. + + may be preferred when only the relative distance is needed + and speed is of the essence. + + + + + Calculates the squared distance between two vectors. + + The first vector. + The second vector. + When the method completes, contains the squared distance between the two vectors. + Distance squared is the value before taking the square root. + Distance squared can often be used in place of distance if relative comparisons are being made. + For example, consider three points A, B, and C. To determine whether B or C is further from A, + compare the distance between A and B to the distance between A and C. Calculating the two distances + involves two square roots, which are computationally expensive. However, using distance squared + provides the same information and avoids calculating two square roots. + + + + + Calculates the squared distance between two vectors. + + The first vector. + The second vector. + The squared distance between the two vectors. + Distance squared is the value before taking the square root. + Distance squared can often be used in place of distance if relative comparisons are being made. + For example, consider three points A, B, and C. To determine whether B or C is further from A, + compare the distance between A and B to the distance between A and C. Calculating the two distances + involves two square roots, which are computationally expensive. However, using distance squared + provides the same information and avoids calculating two square roots. + + + + + Calculates the dot product of two vectors. + + First source vector + Second source vector. + When the method completes, contains the dot product of the two vectors. + + + + Calculates the dot product of two vectors. + + First source vector. + Second source vector. + The dot product of the two vectors. + + + + Converts the vector into a unit vector. + + The vector to normalize. + When the method completes, contains the normalized vector. + + + + Converts the vector into a unit vector. + + The vector to normalize. + The normalized vector. + + + + Performs a linear interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the linear interpolation of the two vectors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a linear interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + The linear interpolation of the two vectors. + + This method performs the linear interpolation based on the following formula. + start + (end - start) * amount + Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned. + + + + + Performs a cubic interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + When the method completes, contains the cubic interpolation of the two vectors. + + + + Performs a cubic interpolation between two vectors. + + Start vector. + End vector. + Value between 0 and 1 indicating the weight of . + The cubic interpolation of the two vectors. + + + + Performs a Hermite spline interpolation. + + First source position vector. + First source tangent vector. + Second source position vector. + Second source tangent vector. + Weighting factor. + When the method completes, contains the result of the Hermite spline interpolation. + + + + Performs a Hermite spline interpolation. + + First source position vector. + First source tangent vector. + Second source position vector. + Second source tangent vector. + Weighting factor. + The result of the Hermite spline interpolation. + + + + Performs a Catmull-Rom interpolation using the specified positions. + + The first position in the interpolation. + The second position in the interpolation. + The third position in the interpolation. + The fourth position in the interpolation. + Weighting factor. + When the method completes, contains the result of the Catmull-Rom interpolation. + + + + Performs a Catmull-Rom interpolation using the specified positions. + + The first position in the interpolation. + The second position in the interpolation. + The third position in the interpolation. + The fourth position in the interpolation. + Weighting factor. + A vector that is the result of the Catmull-Rom interpolation. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the largest components of the source vectors. + + + + Returns a vector containing the largest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the largest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + When the method completes, contains an new vector composed of the smallest components of the source vectors. + + + + Returns a vector containing the smallest components of the specified vectors. + + The first source vector. + The second source vector. + A vector containing the smallest components of the source vectors. + + + + Orthogonalizes a list of vectors. + + The list of orthogonalized vectors. + The list of vectors to orthogonalize. + + Orthogonalization is the process of making all vectors orthogonal to each other. This + means that any given vector in the list will be orthogonal to any other given vector in the + list. + Because this method uses the modified Gram-Schmidt process, the resulting vectors + tend to be numerically unstable. The numeric stability decreases according to the vectors + position in the list so that the first vector is the most stable and the last vector is the + least stable. + + Thrown when or is null. + Thrown when is shorter in length than . + + + + Orthonormalizes a list of vectors. + + The list of orthonormalized vectors. + The list of vectors to orthonormalize. + + Orthonormalization is the process of making all vectors orthogonal to each + other and making all vectors of unit length. This means that any given vector will + be orthogonal to any other given vector in the list. + Because this method uses the modified Gram-Schmidt process, the resulting vectors + tend to be numerically unstable. The numeric stability decreases according to the vectors + position in the list so that the first vector is the most stable and the last vector is the + least stable. + + Thrown when or is null. + Thrown when is shorter in length than . + + + + Transforms a 4D vector by the given rotation. + + The vector to rotate. + The rotation to apply. + When the method completes, contains the transformed . + + + + Transforms a 4D vector by the given rotation. + + The vector to rotate. + The rotation to apply. + The transformed . + + + + Transforms an array of vectors by the given rotation. + + The array of vectors to transform. + The rotation to apply. + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + + + Transforms a 4D vector by the given . + + The source vector. + The transformation . + When the method completes, contains the transformed . + + + + Transforms a 4D vector by the given . + + The source vector. + The transformation . + The transformed . + + + + Transforms a 4D vector by the given . + + The source vector. + The transformation . + When the method completes, contains the transformed . + + + + Transforms a 4D vector by the given . + + The source vector. + The transformation . + The transformed . + + + + Transforms an array of 4D vectors by the given . + + The array of vectors to transform. + The transformation . + The array for which the transformed vectors are stored. + This array may be the same array as . + Thrown when or is null. + Thrown when is shorter in length than . + + + + Adds two vectors. + + The first vector to add. + The second vector to add. + The sum of the two vectors. + + + + Modulates a vector with another by performing component-wise multiplication equivalent to . + + The first vector to multiply. + The second vector to multiply. + The multiplication of the two vectors. + + + + Assert a vector (return it unchanged). + + The vector to assert (unchange). + The asserted (unchanged) vector. + + + + Subtracts two vectors. + + The first vector to subtract. + The second vector to subtract. + The difference of the two vectors. + + + + Reverses the direction of a given vector. + + The vector to negate. + A vector facing in the opposite direction. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Scales a vector by the given value. + + The vector to scale. + The amount by which to scale the vector. + The scaled vector. + + + + Tests for equality between two objects. + + The first value to compare. + The second value to compare. + true if has the same value as ; otherwise, false. + + + + Tests for inequality between two objects. + + The first value to compare. + The second value to compare. + true if has a different value than ; otherwise, false. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Gets a value indicting whether this instance is normalized. + + + + + Gets or sets the component at the specified index. + + The value of the X, Y, Z, or W component, depending on the index. + The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. + The value of the component at the specified index. + Thrown when the is out of the range [0, 3]. + + + + Internal FontFileEnumerator callback + + + + + Internal FontFileEnumerator Callback + + + + HRESULT ISequentialStream::Read([Out, Buffer] void* pv,[In] unsigned int cb,[Out, Optional] unsigned int* pcbRead) + + + HRESULT ISequentialStream::Write([In, Buffer] const void* pv,[In] unsigned int cb,[Out, Optional] unsigned int* pcbWritten) + + + + Callbacks to pointer. + + The stream. + + + + HRESULT IStream::Seek([In] LARGE_INTEGER dlibMove,[In] SHARPDX_SEEKORIGIN dwOrigin,[Out, Optional] ULARGE_INTEGER* plibNewPosition) + + + HRESULT IStream::SetSize([In] ULARGE_INTEGER libNewSize) + + + HRESULT IStream::CopyTo([In] IStream* pstm,[In] ULARGE_INTEGER cb,[Out, Optional] ULARGE_INTEGER* pcbRead,[Out, Optional] ULARGE_INTEGER* pcbWritten) + + + HRESULT IStream::Commit([In] STGC grfCommitFlags) + + + HRESULT IStream::Revert() + + + HRESULT IStream::LockRegion([In] ULARGE_INTEGER libOffset,[In] ULARGE_INTEGER cb,[In] LOCKTYPE dwLockType) + + + HRESULT IStream::UnlockRegion([In] ULARGE_INTEGER libOffset,[In] ULARGE_INTEGER cb,[In] LOCKTYPE dwLockType) + + + HRESULT IStream::Stat([Out] STATSTG* pstatstg,[In] STATFLAG grfStatFlag) + + + HRESULT IStream::Clone([Out] IStream** ppstm) + + + + Converts a win32 error code to a . + + The error code. + A HRESULT code + + + + Converts a win32 error code to a . + + The error code. + A HRESULT code + + + + Provides a hook to WndProc of an existing window handle using . + + + + + Initializes a new instance of the class. + + The HWND. + + + + Adds a message filter to a window. + + The handle of the window. + The message filter. + + + + Removes a message filter associated with a window. + + The handle of the window. + The message filter. + + + + The namespace contains common enumerations, structures and helper classes for Win32 low-level API. + + + + + Implementation of OLE IPropertyBag2. + + IPropertyBag2 + + + + Initializes a new instance of the class. + + The property bag pointer. + + + + Gets the value of the property with this name. + + The name. + Value of the property + + + + Gets the value of the property by using a + + The public type of this property. + The marshaling type of this property. + The property key. + Value of the property + + + + Sets the value of the property with this name + + The name. + The value. + + + + Sets the value of the property by using a + + The public type of this property. + The marshaling type of this property. + The property key. + The value. + + + + Gets the number of properties. + + + + + Gets the keys. + + + + + Identifies a typed property in a . + + The public type of this property. + The marshaling type of this property. + + + + Initializes a new instance of the class. + + The name. + + + + Gets the name. + + + + + An enumerator using internally a . + + + + + Initializes a new instance of the class. + + The PTR to I enum string. + + + + Security attributes. + + SECURITY_ATTRIBUTES + + + + Length. + + + + + Descriptor. + + + + + Gets or sets a value indicating whether [inherit handle]. + + + true if [inherit handle]; otherwise, false. + + + + + Variant COM. + + PROPVARIANT + + + + Gets the type of the element. + + + The type of the element. + + + + + Gets the type. + + + + + Gets or sets the value. + + + The value. + + + + + Type of a simple variant value. + + + + + Type of a variant + + + + + Simple value + + + + + Vector value. + + + + + Array value. + + + + + By reference. + + + + + Reserved value. + + + + + The namespace contains basic controls used to render DirectX content. + + + + + RenderLoop provides a rendering loop infrastructure. + + + + + Runs the specified main loop in the specified context. + + + + + Runs the specified main loop for the specified windows form. + + The form. + The rendering callback. + + + + Gets a value indicating whether this instance is application idle. + + + true if this instance is application idle; otherwise, false. + + + + + Gets or sets a value indicating whether the render loop should use a custom windows event handler (default false). + + + true if the render loop should use a custom windows event handler (default false); otherwise, false. + + + By default, RenderLoop is using to process windows event message. Set this parameter to true to use a custom event handler that could + lead to better performance. Note that using a custom windows event message handler is not compatible with or any other features + that are part of . + + + + + Delegate for the rendering loop. + + + + + ProxyNativeWindow, used only to detect if the original window is destroyed + + + + + Initializes a new instance of the class. + + + + + Private rendering loop + + + + + A Renderable UserControl. + + + + + Initializes a new instance of the class. + + + + + Paints the background of the control. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Default Rendering Form. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The text. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Paints the background of the control. + + A that contains the event data. + + + + Raises the Pause Rendering event. + + The instance containing the event data. + + + + Raises the Resume Rendering event. + + The instance containing the event data. + + + + Raises the User resized event. + + The instance containing the event data. + + + + Raises the On App Activated event. + + The instance containing the event data. + + + + Raises the App Deactivated event + + The instance containing the event data. + + + + Raises the System Suspend event + + The instance containing the event data. + + + + Raises the System Resume event + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Override windows message loop handling. + + The Windows to process. + + + + Updates the screen. + + + + + Occurs when [app activated]. + + + + + Occurs when [app deactivated]. + + + + + Occurs when [monitor changed]. + + + + + Occurs when [pause rendering]. + + + + + Occurs when [resume rendering]. + + + + + Occurs when [screensaver]. + + + + + Occurs when [system resume]. + + + + + Occurs when [system suspend]. + + + + + Occurs when [user resized]. + + +
+
diff --git a/distribution/sharpdx_direct3d11_effects_x64.dll b/distribution/sharpdx_direct3d11_effects_x64.dll new file mode 100644 index 00000000..a7ad51df Binary files /dev/null and b/distribution/sharpdx_direct3d11_effects_x64.dll differ diff --git a/distribution/sharpdx_direct3d11_effects_x86.dll b/distribution/sharpdx_direct3d11_effects_x86.dll new file mode 100644 index 00000000..345872ec Binary files /dev/null and b/distribution/sharpdx_direct3d11_effects_x86.dll differ