From 1280a693b6ca806313e3807c8c0218c8897af4b2 Mon Sep 17 00:00:00 2001 From: Julien Vulliet Date: Wed, 19 Apr 2017 20:30:50 +0300 Subject: [PATCH 1/7] [Misc] Fix code comments for color, and add alpha description --- Source/SharpDX.Mathematics/Color.cs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Source/SharpDX.Mathematics/Color.cs b/Source/SharpDX.Mathematics/Color.cs index 4a368eab3..89424de10 100644 --- a/Source/SharpDX.Mathematics/Color.cs +++ b/Source/SharpDX.Mathematics/Color.cs @@ -107,6 +107,7 @@ public Color(byte red, byte green, byte blue) /// The red component of the color. /// The green component of the color. /// The blue component of the color. + /// The alpha component of the color public Color(int red, int green, int blue, int alpha) { R = ToByte(red); @@ -368,7 +369,7 @@ public byte[] ToArray() /// /// Gets the brightness. /// - /// The Hue-Saturation-Brightness (HSB) saturation for this + /// The Hue-Saturation-Brightness (HSB) brightness for this public float GetBrightness() { float r = (float)R / 255.0f; @@ -391,7 +392,7 @@ public float GetBrightness() /// /// Gets the hue. /// - /// The Hue-Saturation-Brightness (HSB) saturation for this + /// The Hue-Saturation-Brightness (HSB) hue for this public float GetHue() { if (R == G && G == B) From 3c36eb9dc1ee2b83cbbe4f1556793228944fee82 Mon Sep 17 00:00:00 2001 From: Julien Vulliet Date: Wed, 19 Apr 2017 20:31:12 +0300 Subject: [PATCH 2/7] [Misc] Add inherit for Size2F ToString --- Source/SharpDX/Size2F.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/Source/SharpDX/Size2F.cs b/Source/SharpDX/Size2F.cs index 091bb1659..25040c00a 100644 --- a/Source/SharpDX/Size2F.cs +++ b/Source/SharpDX/Size2F.cs @@ -116,6 +116,7 @@ public override int GetHashCode() return !left.Equals(right); } + /// public override string ToString() { return string.Format("({0},{1})", Width, Height); From efb5f9105d90b268cff59312d4d0bc2354932193 Mon Sep 17 00:00:00 2001 From: Julien Vulliet Date: Wed, 19 Apr 2017 20:31:57 +0300 Subject: [PATCH 3/7] [Doc] Fix documentation comments on function reflection. Add comment for return parameter --- Source/SharpDX.D3DCompiler/FunctionReflection.cs | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/Source/SharpDX.D3DCompiler/FunctionReflection.cs b/Source/SharpDX.D3DCompiler/FunctionReflection.cs index ac87523a1..e397cc820 100644 --- a/Source/SharpDX.D3DCompiler/FunctionReflection.cs +++ b/Source/SharpDX.D3DCompiler/FunctionReflection.cs @@ -58,6 +58,10 @@ public FunctionParameterReflection[] Parameters } } + /// + /// Returns reflection for function return parameter + /// + /// Thrown if function has no return value (void) public FunctionParameterReflection ReturnParameter { get @@ -74,11 +78,11 @@ public FunctionParameterReflection ReturnParameter ///

Gets a description of how a resource is bound to a function.

/// ///

A zero-based resource index.

- ///

A reference to a structure that describes input binding of the resource.

+ ///

A reference to a structure that describes input binding of the resource.

/// ///

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

/// - /// + /// /// dn280551 /// HRESULT ID3D11FunctionReflection::GetResourceBindingDesc([In] unsigned int ResourceIndex,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc) /// ID3D11FunctionReflection::GetResourceBindingDesc @@ -93,11 +97,11 @@ public InputBindingDescription GetResourceBindingDescription(int index) ///

Gets a description of how a resource is bound to a function.

/// ///

Resource name.

- ///

A reference to a structure that describes input binding of the resource.

+ ///

A reference to a structure that describes input binding of the resource.

/// ///

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

/// - /// + /// /// dn280551 /// HRESULT ID3D11FunctionReflection::GetResourceBindingDesc([In] unsigned int ResourceIndex,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc) /// ID3D11FunctionReflection::GetResourceBindingDesc From 8b648d64f742f92e73796c633ba04cefdcfe41e7 Mon Sep 17 00:00:00 2001 From: Julien Vulliet Date: Wed, 19 Apr 2017 20:53:43 +0300 Subject: [PATCH 4/7] [Comments] Add inherit on basic disposes and tostring --- Source/SharpDX.Direct3D11/Device1.cs | 2 +- Source/SharpDX.Direct3D11/Device2.cs | 1 + Source/SharpDX.Direct3D11/Device3.cs | 1 + Source/SharpDX.Direct3D11/DeviceChild.cs | 2 ++ Source/SharpDX.Direct3D11/DeviceContext.cs | 1 + Source/SharpDX.Direct3D11/Message.cs | 1 + Source/SharpDX.Direct3D12/Message.cs | 1 + 7 files changed, 8 insertions(+), 1 deletion(-) diff --git a/Source/SharpDX.Direct3D11/Device1.cs b/Source/SharpDX.Direct3D11/Device1.cs index 2ee8b23e2..f27ca7716 100644 --- a/Source/SharpDX.Direct3D11/Device1.cs +++ b/Source/SharpDX.Direct3D11/Device1.cs @@ -270,7 +270,7 @@ public T OpenSharedResource1(string name, SharpDX.DXGI.SharedResourceFlags de return FromPointer(temp); } - + /// protected override void Dispose(bool disposing) { if (disposing) diff --git a/Source/SharpDX.Direct3D11/Device2.cs b/Source/SharpDX.Direct3D11/Device2.cs index 438542bae..67b97a432 100644 --- a/Source/SharpDX.Direct3D11/Device2.cs +++ b/Source/SharpDX.Direct3D11/Device2.cs @@ -21,6 +21,7 @@ namespace SharpDX.Direct3D11 { public partial class Device2 { + /// protected override void Dispose(bool disposing) { if (disposing) diff --git a/Source/SharpDX.Direct3D11/Device3.cs b/Source/SharpDX.Direct3D11/Device3.cs index e40aabfce..3138b9f24 100644 --- a/Source/SharpDX.Direct3D11/Device3.cs +++ b/Source/SharpDX.Direct3D11/Device3.cs @@ -21,6 +21,7 @@ namespace SharpDX.Direct3D11 { public partial class Device3 { + /// protected override void Dispose(bool disposing) { if (disposing) diff --git a/Source/SharpDX.Direct3D11/DeviceChild.cs b/Source/SharpDX.Direct3D11/DeviceChild.cs index c490afa9e..bb0f35558 100644 --- a/Source/SharpDX.Direct3D11/DeviceChild.cs +++ b/Source/SharpDX.Direct3D11/DeviceChild.cs @@ -63,12 +63,14 @@ public string DebugName } } + /// protected override void NativePointerUpdated(IntPtr oldNativePointer) { DisposeDevice(); base.NativePointerUpdated(oldNativePointer); } + /// protected override unsafe void Dispose(bool disposing) { if (disposing) diff --git a/Source/SharpDX.Direct3D11/DeviceContext.cs b/Source/SharpDX.Direct3D11/DeviceContext.cs index 1ba47414e..1489d92d1 100644 --- a/Source/SharpDX.Direct3D11/DeviceContext.cs +++ b/Source/SharpDX.Direct3D11/DeviceContext.cs @@ -608,6 +608,7 @@ internal unsafe bool UpdateSubresourceSafe(SharpDX.Direct3D11.Resource dstResour private bool isCheckThreadingSupport; private bool supportsCommandLists; + /// protected override unsafe void Dispose(bool disposing) { if (disposing) diff --git a/Source/SharpDX.Direct3D11/Message.cs b/Source/SharpDX.Direct3D11/Message.cs index 0481cc571..c831465a7 100644 --- a/Source/SharpDX.Direct3D11/Message.cs +++ b/Source/SharpDX.Direct3D11/Message.cs @@ -45,6 +45,7 @@ internal unsafe void __MarshalFrom(ref __Native @ref) this.DescriptionByteLength = @ref.DescriptionByteLength; } + /// public override string ToString() { return string.Format("[{0}] [{1}] [{2}] : {3}", Id, Severity, Category, Description); diff --git a/Source/SharpDX.Direct3D12/Message.cs b/Source/SharpDX.Direct3D12/Message.cs index c241272eb..5567a2538 100644 --- a/Source/SharpDX.Direct3D12/Message.cs +++ b/Source/SharpDX.Direct3D12/Message.cs @@ -26,6 +26,7 @@ internal unsafe void __MarshalFrom(ref __Native @ref) this.DescriptionByteLength = @ref.DescriptionByteLength; } + /// public override string ToString() { return string.Format("[{0}] [{1}] [{2}] : {3}", Id, Severity, Category, Description); From c0abdbd49517c32d51da82bb4f5af9fafba836b7 Mon Sep 17 00:00:00 2001 From: Julien Vulliet Date: Wed, 19 Apr 2017 20:54:17 +0300 Subject: [PATCH 5/7] [Direct3D12] Add code comments and fix include path where relevant --- .../SharpDX.Direct3D12/GraphicsCommandList.cs | 7 +++---- .../InputLayoutDescription.cs | 6 +++++- Source/SharpDX.Direct3D12/ResourceBarrier.cs | 5 ++++- .../RootSignatureDeserializer.cs | 6 +++--- .../StreamOutputDescription.cs | 2 +- .../SharpDX.Direct3D12/TextureCopyLocation.cs | 20 ++++++++++++++----- 6 files changed, 31 insertions(+), 15 deletions(-) diff --git a/Source/SharpDX.Direct3D12/GraphicsCommandList.cs b/Source/SharpDX.Direct3D12/GraphicsCommandList.cs index 5e815d28b..252b508cc 100644 --- a/Source/SharpDX.Direct3D12/GraphicsCommandList.cs +++ b/Source/SharpDX.Direct3D12/GraphicsCommandList.cs @@ -243,8 +243,7 @@ public void SetVertexBuffers(int startSlot, SharpDX.Direct3D12.VertexBufferView[ ///

Sets a CPU descriptor handle for the vertex buffers.

/// ///

Index into the device's zero-based array to begin setting vertex buffers.

- ///

Specifies the vertex buffer views in an array of structures.

- ///

The number of views in the pViews array.

+ ///

Specifies the vertex buffer views in an array of structures.

/// dn986883 /// void ID3D12GraphicsCommandList::IASetVertexBuffers([In] unsigned int StartSlot,[In] unsigned int NumViews,[In] const void* pViews) /// ID3D12GraphicsCommandList::IASetVertexBuffers @@ -335,7 +334,7 @@ public unsafe void SetScissorRectangles(SharpDX.Mathematics.Interop.RawRectangle ///

For internal use only.

/// ///

Internal.

- /// + /// /// dn986879 /// void ID3D12GraphicsCommandList::BeginEvent([In] unsigned int Metadata,[In, Buffer, Optional] const void* pData,[In] unsigned int Size) /// ID3D12GraphicsCommandList::BeginEvent @@ -362,7 +361,7 @@ public void BeginEvent(string name) ///

For internal use only.

/// ///

Internal.

- /// + /// /// dn986885 /// void ID3D12GraphicsCommandList::SetMarker([In] unsigned int Metadata,[In, Buffer, Optional] const void* pData,[In] unsigned int Size) /// ID3D12GraphicsCommandList::SetMarker diff --git a/Source/SharpDX.Direct3D12/InputLayoutDescription.cs b/Source/SharpDX.Direct3D12/InputLayoutDescription.cs index 064115ea1..d5ce8e8c9 100644 --- a/Source/SharpDX.Direct3D12/InputLayoutDescription.cs +++ b/Source/SharpDX.Direct3D12/InputLayoutDescription.cs @@ -31,12 +31,16 @@ public InputLayoutDescription(InputElement[] elements) /// ///

An array of structures that describe the data types of the input-assembler stage.

/// - /// + /// /// dn770378 /// const D3D12_INPUT_ELEMENT_DESC* pInputElementDescs /// D3D12_INPUT_ELEMENT_DESC pInputElementDescs public InputElement[] Elements { get; set; } + /// + /// Implicitely converts to an InputLayoutDescription from an array of + /// + /// Array of input elements public static implicit operator InputLayoutDescription(InputElement[] elements) { return new InputLayoutDescription(elements); diff --git a/Source/SharpDX.Direct3D12/ResourceBarrier.cs b/Source/SharpDX.Direct3D12/ResourceBarrier.cs index 5a800cb01..2bee76020 100644 --- a/Source/SharpDX.Direct3D12/ResourceBarrier.cs +++ b/Source/SharpDX.Direct3D12/ResourceBarrier.cs @@ -24,12 +24,15 @@ namespace SharpDX.Direct3D12 { public partial struct ResourceBarrier { + /// + /// Specifies the barrier type, see + /// public SharpDX.Direct3D12.ResourceBarrierType Type; /// /// No documentation. /// - /// + /// /// D3D12_RESOURCE_BARRIER_FLAGS Flags /// D3D12_RESOURCE_BARRIER_FLAGS Flags public SharpDX.Direct3D12.ResourceBarrierFlags Flags; diff --git a/Source/SharpDX.Direct3D12/RootSignatureDeserializer.cs b/Source/SharpDX.Direct3D12/RootSignatureDeserializer.cs index 1c40e2088..fcf7cd7eb 100644 --- a/Source/SharpDX.Direct3D12/RootSignatureDeserializer.cs +++ b/Source/SharpDX.Direct3D12/RootSignatureDeserializer.cs @@ -9,10 +9,10 @@ namespace SharpDX.Direct3D12 { public partial class RootSignatureDeserializer { - // + /// ///

Gets the layout of the root signature.

/// - /// + /// /// dn986887 /// GetRootSignatureDesc /// GetRootSignatureDesc @@ -23,7 +23,7 @@ public partial class RootSignatureDeserializer ///

Gets the layout of the root signature.

/// ///

Returns a reference to a structure that describes the layout of the root signature.

- /// + /// /// dn986887 /// const D3D12_ROOT_SIGNATURE_DESC* ID3D12RootSignatureDeserializer::GetRootSignatureDesc() /// ID3D12RootSignatureDeserializer::GetRootSignatureDesc diff --git a/Source/SharpDX.Direct3D12/StreamOutputDescription.cs b/Source/SharpDX.Direct3D12/StreamOutputDescription.cs index 2b4d437aa..1bc4d9edf 100644 --- a/Source/SharpDX.Direct3D12/StreamOutputDescription.cs +++ b/Source/SharpDX.Direct3D12/StreamOutputDescription.cs @@ -38,7 +38,7 @@ public StreamOutputDescription(StreamOutputElement[] elements) /// ///

An array of structures. Can't be null if NumEntries > 0.

/// - /// + /// /// dn770410 /// const D3D12_SO_DECLARATION_ENTRY* pSODeclaration /// D3D12_SO_DECLARATION_ENTRY pSODeclaration diff --git a/Source/SharpDX.Direct3D12/TextureCopyLocation.cs b/Source/SharpDX.Direct3D12/TextureCopyLocation.cs index 6d00a6be5..daeb674df 100644 --- a/Source/SharpDX.Direct3D12/TextureCopyLocation.cs +++ b/Source/SharpDX.Direct3D12/TextureCopyLocation.cs @@ -13,7 +13,7 @@ namespace SharpDX.Direct3D12 /// ///

Use this structure with CopyTextureRegion.

/// - /// + /// /// dn903818 /// D3D12_TEXTURE_COPY_LOCATION /// D3D12_TEXTURE_COPY_LOCATION @@ -22,7 +22,7 @@ public partial struct TextureCopyLocation /// /// No documentation. /// - /// + /// /// ID3D12Resource* pResource /// ID3D12Resource pResource private System.IntPtr PResource; @@ -30,7 +30,7 @@ public partial struct TextureCopyLocation /// /// No documentation. /// - /// + /// /// D3D12_TEXTURE_COPY_TYPE Type /// D3D12_TEXTURE_COPY_TYPE Type public SharpDX.Direct3D12.TextureCopyType Type; @@ -40,7 +40,7 @@ public partial struct TextureCopyLocation /// /// No documentation. /// - /// + /// /// D3D12_PLACED_SUBRESOURCE_FOOTPRINT PlacedFootprint /// D3D12_PLACED_SUBRESOURCE_FOOTPRINT PlacedFootprint public SharpDX.Direct3D12.PlacedSubResourceFootprint PlacedFootprint @@ -52,7 +52,7 @@ public SharpDX.Direct3D12.PlacedSubResourceFootprint PlacedFootprint /// /// No documentation. /// - /// + /// /// unsigned int SubresourceIndex /// unsigned int SubresourceIndex public int SubresourceIndex @@ -61,6 +61,11 @@ public int SubresourceIndex set { union.SubResourceIndex = value; } } + /// + /// Creates a new resource copy that is represented by a subresource index + /// + /// A valid Direct3D12 Resource + /// Sub resource index public TextureCopyLocation(SharpDX.Direct3D12.Resource resource, int subResourceIndex) : this() { Type = TextureCopyType.SubResourceIndex; @@ -68,6 +73,11 @@ public TextureCopyLocation(SharpDX.Direct3D12.Resource resource, int subResource SubresourceIndex = subResourceIndex; } + /// + /// Creates a new resource copy that is represented by a resource footprint + /// + /// A valid Direct3D12 Resource + /// Placement footprint for the resource copy operation public TextureCopyLocation(SharpDX.Direct3D12.Resource resource, PlacedSubResourceFootprint placedFootprint) : this() { Type = TextureCopyType.PlacedFootprint; From d48d2496b17f0cf579e1b0ee8c1074591f3fe9b0 Mon Sep 17 00:00:00 2001 From: Julien Vulliet Date: Wed, 19 Apr 2017 20:58:54 +0300 Subject: [PATCH 6/7] [Comments] Fix path on compositor --- Source/SharpDX.DirectManipulation/Compositor.cs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Source/SharpDX.DirectManipulation/Compositor.cs b/Source/SharpDX.DirectManipulation/Compositor.cs index e780bba4a..9575ec37e 100644 --- a/Source/SharpDX.DirectManipulation/Compositor.cs +++ b/Source/SharpDX.DirectManipulation/Compositor.cs @@ -19,7 +19,7 @@ partial interface Compositor ///

The parent in the composition tree for the content being added.

parentVisual must also be a parent of childVisual in the composition tree.

///

The child in the composition tree for the content being added.

parentVisual must also be a parent of childVisual in the composition tree.

/// No documentation. - /// + /// /// Hh768898 /// HRESULT IDirectManipulationCompositor::AddContent([In] IDirectManipulationContent* content,[In, Optional] IUnknown* device,[In, Optional] IUnknown* parentVisual,[In, Optional] IUnknown* childVisual) /// IDirectManipulationCompositor::AddContent @@ -31,7 +31,7 @@ partial interface Compositor /// ///

The content to remove from the composition tree.

/// No documentation. - /// + /// /// Hh768899 /// HRESULT IDirectManipulationCompositor::RemoveContent([In] IDirectManipulationContent* content) /// IDirectManipulationCompositor::RemoveContent @@ -43,7 +43,7 @@ partial interface Compositor /// /// No documentation. /// No documentation. - /// + /// /// Hh768900 /// HRESULT IDirectManipulationCompositor::SetUpdateManager([In] IDirectManipulationUpdateManager* updateManager) /// IDirectManipulationCompositor::SetUpdateManager @@ -53,7 +53,7 @@ partial interface Compositor ///

Commits all pending updates in the compositor to the system for rendering.

Syntax
 Flush();
Parameters

This method has no parameters.

Return value

If the method succeeds, it returns . Otherwise, it returns an error code.

Remarks

This method enables Direct Manipulation to flush any pending changes to its visuals before a system event, such as a process suspension.

Requirements /// /// No documentation. - /// + /// /// jj647930 /// HRESULT IDirectManipulationCompositor::Flush() /// IDirectManipulationCompositor::Flush From 80b7e645d4e2a2eec679fe1a82e44672e8c98a01 Mon Sep 17 00:00:00 2001 From: Julien Vulliet Date: Wed, 19 Apr 2017 21:32:54 +0300 Subject: [PATCH 7/7] [Comments] Fix include path in order to remove some warnings in visual studio --- .../SharpDX.Animation/PriorityComparison.cs | 2 +- Source/SharpDX.Animation/Storyboard.cs | 2 +- Source/SharpDX.D3DCompiler/ShaderBytecode.cs | 6 ++- Source/SharpDX.DXGI/SwapChain.cs | 4 +- Source/SharpDX.DXGI/SwapChain1.cs | 2 +- Source/SharpDX.DXGI/SwapChain2.cs | 2 - .../DirectWrite/BitmapRenderTarget.cs | 2 +- .../DirectWrite/TextAnalysisSink1.cs | 2 +- .../DirectWrite/TextAnalysisSource1.cs | 2 +- .../DirectWrite/TextAnalyzer1.cs | 2 +- .../WIC/BitmapFrameEncode.cs | 4 +- .../DeviceContext.CommonShaderStage.cs | 1 - Source/SharpDX.Direct3D12/Device.cs | 38 +++++++++---------- .../SharpDX.Direct3D12/GraphicsCommandList.cs | 22 +++++------ Source/SharpDX.Direct3D9/EffectHandle.cs | 4 +- .../CompositorNative.cs | 11 ++++-- Source/SharpDX.DirectSound/SoundBuffer.cs | 2 +- Source/SharpDX.MediaFoundation/Activate.cs | 4 +- .../SharpDX.MediaFoundation/CaptureEngine.cs | 4 +- .../CapturePhotoConfirmation.cs | 2 +- .../CapturePhotoSink.cs | 4 +- .../CapturePreviewSink.cs | 2 +- .../CaptureRecordSink.cs | 4 +- Source/SharpDX.MediaFoundation/CaptureSink.cs | 2 +- .../SharpDX.MediaFoundation/ClockStateSink.cs | 10 ++--- .../SharpDX.MediaFoundation/IAsyncCallback.cs | 2 +- Source/SharpDX.MediaFoundation/MediaEngine.cs | 2 +- .../MediaTypeHandler.cs | 2 +- .../PresentationDescriptor.cs | 2 +- .../SampleGrabberSinkCallback.cs | 6 +-- .../SharpDX.MediaFoundation/SourceReader.cs | 2 +- .../SharpDX.MediaFoundation/VideoPresenter.cs | 4 +- Source/SharpDX.XAudio2/DeviceDetails.cs | 26 ++++++------- Source/SharpDX.XAudio2/MasteringVoice.cs | 2 +- Source/SharpDX.XAudio2/SourceVoice.cs | 2 +- Source/SharpDX.XAudio2/SubmixVoiceFlags.cs | 6 +-- Source/SharpDX.XAudio2/Voice.cs | 2 +- Source/SharpDX.XAudio2/X3DAudio/X3DAudio17.cs | 6 +-- Source/SharpDX.XAudio2/X3DAudio/X3DAudio28.cs | 6 +-- Source/SharpDX.XAudio2/XAudio2.cs | 4 +- Source/SharpDX.XAudio2/XAudio28Functions.cs | 8 ++-- Source/SharpDX.XInput/XInput13.cs | 2 +- 42 files changed, 113 insertions(+), 111 deletions(-) diff --git a/Source/SharpDX.Animation/PriorityComparison.cs b/Source/SharpDX.Animation/PriorityComparison.cs index 36abafe5f..310553f82 100644 --- a/Source/SharpDX.Animation/PriorityComparison.cs +++ b/Source/SharpDX.Animation/PriorityComparison.cs @@ -30,7 +30,7 @@ internal partial interface PriorityComparison /// No documentation. /// No documentation. /// No documentation. - /// + /// /// HRESULT IUIAnimationPriorityComparison::HasPriority([In] IUIAnimationStoryboard* scheduledStoryboard,[In] IUIAnimationStoryboard* newStoryboard,[In] UI_ANIMATION_PRIORITY_EFFECT priorityEffect) bool HasPriority( SharpDX.Animation.Storyboard scheduledStoryboard, SharpDX.Animation.Storyboard newStoryboard, SharpDX.Animation.PriorityEffect priorityEffect); } diff --git a/Source/SharpDX.Animation/Storyboard.cs b/Source/SharpDX.Animation/Storyboard.cs index ff8edbf49..fe01962a7 100644 --- a/Source/SharpDX.Animation/Storyboard.cs +++ b/Source/SharpDX.Animation/Storyboard.cs @@ -35,7 +35,7 @@ public Storyboard(Manager manager) manager.CreateStoryboard(this); } - /// + /// /// HRESULT IUIAnimationStoryboard::RepeatBetweenKeyframes([In] __MIDL___MIDL_itf_UIAnimation_0000_0002_0003* startKeyframe,[In] __MIDL___MIDL_itf_UIAnimation_0000_0002_0003* endKeyframe,[In] int repetitionCount) public void RepeatBetweenKeyframes(SharpDX.Animation.KeyFrame startKeyframe, SharpDX.Animation.KeyFrame endKeyframe, RepeatCount repetitionCount) { diff --git a/Source/SharpDX.D3DCompiler/ShaderBytecode.cs b/Source/SharpDX.D3DCompiler/ShaderBytecode.cs index 0006a32f9..85ce07e3a 100644 --- a/Source/SharpDX.D3DCompiler/ShaderBytecode.cs +++ b/Source/SharpDX.D3DCompiler/ShaderBytecode.cs @@ -957,6 +957,10 @@ internal static ShaderMacro[] PrepareMacros(ShaderMacro[] macros) return macroArray; } + /// + /// Disposes all resource for the allocated object + /// + /// This is kept for backwards compatibility only, this actually does nothing in that case public void Dispose() { // Just to keep backward compatibility @@ -965,9 +969,7 @@ public void Dispose() /// /// Gets the shader type and version string from the provided bytecode. /// - /// The shader bytecode data. /// The type and version string of the provided shader bytecode. - /// Is thrown when is null. /// Is thrown when bytecode contains invalid data or the version could not be read. /// Is thrown when bytecode contains invalid data. public ShaderProfile GetVersion() diff --git a/Source/SharpDX.DXGI/SwapChain.cs b/Source/SharpDX.DXGI/SwapChain.cs index cc83487ba..d062ab6fa 100644 --- a/Source/SharpDX.DXGI/SwapChain.cs +++ b/Source/SharpDX.DXGI/SwapChain.cs @@ -67,7 +67,7 @@ public T GetBackBuffer(int index) where T : ComObject /// ///

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 value in the SwapEffect member of the structure to specify that the swap chain uses the flip presentation model.

/// - /// + /// /// bb174573 /// GetFrameStatistics /// GetFrameStatistics @@ -119,7 +119,7 @@ public bool IsFullScreen /// ///

Starting with Direct3D 11.1, we recommend to instead use because you can then use dirty rectangles and the scroll rectangle in the swap chain presentation and as such use less memory bandwidth and as a result less system power. For more info about using dirty rectangles and the scroll rectangle in swap chain presentation, see Using dirty rectangles and the scroll rectangle in swap chain presentation.

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 IDirect3DDevice9::TestCooperativeLevel in Direct3D 9.

?

For flip presentation model swap chains that you create with the value set, a successful presentation unbinds back buffer 0 from the graphics pipeline, except for when you pass the flag in the Flags parameter.

For info about how data values change when you present content to the screen, see Converting data for the color space.

/// - /// + /// /// bb174576 /// HRESULT IDXGISwapChain::Present([In] unsigned int SyncInterval,[In] DXGI_PRESENT_FLAGS Flags) /// IDXGISwapChain::Present diff --git a/Source/SharpDX.DXGI/SwapChain1.cs b/Source/SharpDX.DXGI/SwapChain1.cs index edd5a0211..8d4328cbc 100644 --- a/Source/SharpDX.DXGI/SwapChain1.cs +++ b/Source/SharpDX.DXGI/SwapChain1.cs @@ -77,7 +77,7 @@ public SwapChain1(Factory2 factory, ComObject device, ref SwapChainDescription1 /// /// An application can use Present1 to optimize presentation by specifying scroll and dirty rectangles. When the runtime has information about these rectangles, the runtime can then perform necessary bitblts during presentation more efficiently and pass this metadata to the Desktop Window Manager (DWM). The DWM can then use the metadata to optimize presentation and pass the metadata to indirect displays and terminal servers to optimize traffic over the wire. An application must confine its modifications to only the dirty regions that it passes to Present1, as well as modify the entire dirty region to avoid undefined resource contents from being exposed.For flip presentation model swap chains that you create with the value set, a successful presentation results in an unbind of back buffer 0 from the graphics pipeline, except for when you pass the flag in the Flags parameter.Flip presentation model queueSuppose the following frames with sync-interval values are queued from oldest (A) to newest (E) before you call Present1.A: 3, B: 0, C: 0, D: 1, E: 0When you call Present1, 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. /// - /// + /// /// HRESULT IDXGISwapChain1::Present1([In] unsigned int SyncInterval,[In] unsigned int PresentFlags,[In] const void* pPresentParameters) public unsafe Result Present(int syncInterval, PresentFlags presentFlags, PresentParameters presentParameters) { diff --git a/Source/SharpDX.DXGI/SwapChain2.cs b/Source/SharpDX.DXGI/SwapChain2.cs index 4d538f427..bd638333c 100644 --- a/Source/SharpDX.DXGI/SwapChain2.cs +++ b/Source/SharpDX.DXGI/SwapChain2.cs @@ -24,8 +24,6 @@ public partial class SwapChain2 /// ///

[This documentation is preliminary and is subject to change.]

Gets the source region used for the swap chain.

Use GetSourceSize to get the portion of the swap chain from which the operating system presents. The source rectangle is always defined by the region [0, 0, Width, Height]. Use SetSourceSize to set this portion of the swap chain.

/// - /// No documentation. - /// No documentation. ///

This method can return error codes that are described in the DXGI_ERROR topic.

 /// /// dn280408 diff --git a/Source/SharpDX.Direct2D1/DirectWrite/BitmapRenderTarget.cs b/Source/SharpDX.Direct2D1/DirectWrite/BitmapRenderTarget.cs index d07e02677..7359e899a 100644 --- a/Source/SharpDX.Direct2D1/DirectWrite/BitmapRenderTarget.cs +++ b/Source/SharpDX.Direct2D1/DirectWrite/BitmapRenderTarget.cs @@ -43,7 +43,7 @@ public partial class BitmapRenderTarget /// } ///

The baselineOriginX, baslineOriginY, measuringMethod, and glyphRun parameters are provided (as arguments) when the callback method is invoked. The renderingParams, textColor and blackBoxRect are not.

Default rendering params can be retrieved by using the method.

/// - /// + /// /// dd368167 /// HRESULT IDWriteBitmapRenderTarget::DrawGlyphRun([In] float baselineOriginX,[In] float baselineOriginY,[In] DWRITE_MEASURING_MODE measuringMode,[In] const DWRITE_GLYPH_RUN* glyphRun,[In] IDWriteRenderingParams* renderingParams,[In] int textColor,[Out, Optional] RECT* blackBoxRect) /// IDWriteBitmapRenderTarget::DrawGlyphRun diff --git a/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSink1.cs b/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSink1.cs index cc14b2840..5e51422c9 100644 --- a/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSink1.cs +++ b/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSink1.cs @@ -35,7 +35,7 @@ public partial interface TextAnalysisSink1 ///

Whether the glyphs are rotated on their side, which is the default case for CJK and the case stacked Latin

///

Whether the script should be shaped as right-to-left. For Arabic stacked top-to-bottom, even when the adjusted bidi level is coerced to an even level, this will still be true.

///

Returns a successful code or an error code to abort analysis.

 - /// + /// /// Hh780425 /// HRESULT IDWriteTextAnalysisSink1::SetGlyphOrientation([In] unsigned int textPosition,[In] unsigned int textLength,[In] DWRITE_GLYPH_ORIENTATION_ANGLE glyphOrientationAngle,[In] unsigned char adjustedBidiLevel,[In] BOOL isSideways,[In] BOOL isRightToLeft) /// IDWriteTextAnalysisSink1::SetGlyphOrientation diff --git a/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSource1.cs b/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSource1.cs index 7e72d04be..53e2088b4 100644 --- a/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSource1.cs +++ b/Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSource1.cs @@ -35,7 +35,7 @@ public partial interface TextAnalysisSource1 /// ///

The text analyzer calls back to this to get the desired glyph orientation and resolved bidi level, which it uses along with the script properties of the text to determine the actual orientation of each character, which it reports back to the client via the sink SetGlyphOrientation method.

/// - /// + /// /// Hh780427 /// HRESULT IDWriteTextAnalysisSource1::GetVerticalGlyphOrientation([In] unsigned int textPosition,[Out] unsigned int* textLength,[Out] DWRITE_VERTICAL_GLYPH_ORIENTATION* glyphOrientation,[Out] unsigned char* bidiLevel) /// IDWriteTextAnalysisSource1::GetVerticalGlyphOrientation diff --git a/Source/SharpDX.Direct2D1/DirectWrite/TextAnalyzer1.cs b/Source/SharpDX.Direct2D1/DirectWrite/TextAnalyzer1.cs index 2569d8078..9e84773fb 100644 --- a/Source/SharpDX.Direct2D1/DirectWrite/TextAnalyzer1.cs +++ b/Source/SharpDX.Direct2D1/DirectWrite/TextAnalyzer1.cs @@ -32,7 +32,7 @@ public partial class TextAnalyzer1 ///

Length to analyze.

///

Length to analyze.

///

If this method succeeds, it returns . Otherwise, it returns an error code.

 - /// + /// /// Hh780429 /// HRESULT IDWriteTextAnalyzer1::AnalyzeVerticalGlyphOrientation([In] IDWriteTextAnalysisSource1* analysisSource,[In] unsigned int textPosition,[In] unsigned int textLength,[In] IDWriteTextAnalysisSink1* analysisSink) /// IDWriteTextAnalyzer1::AnalyzeVerticalGlyphOrientation diff --git a/Source/SharpDX.Direct2D1/WIC/BitmapFrameEncode.cs b/Source/SharpDX.Direct2D1/WIC/BitmapFrameEncode.cs index 7183027d0..ab7678dc4 100644 --- a/Source/SharpDX.Direct2D1/WIC/BitmapFrameEncode.cs +++ b/Source/SharpDX.Direct2D1/WIC/BitmapFrameEncode.cs @@ -127,7 +127,7 @@ public unsafe void WritePixels(int lineCount, int stride, T[] pixelBuffer) wh /// ///

If SetSize is not called prior to calling WriteSource, the size given in prc is used if not null. Otherwise, the size of the given in pIBitmapSource is used.

If SetPixelFormat is not called prior to calling WriteSource, the pixel format of the given in pIBitmapSource is used.

If SetResolution is not called prior to calling WriteSource, the pixel format of pIBitmapSource is used.

If SetPalette is not called prior to calling WriteSource, the target pixel format is indexed, and the pixel format of pIBitmapSource matches the encoder frame's pixel format, then the pIBitmapSource pixel format is used.

When encoding a GIF image, if the global palette is set and the frame level palette is not set directly by the user or by a custom independent software vendor (ISV) GIF codec, WriteSource will use the global palette to encode the frame even when pIBitmapSource has a frame level palette.

Windows Vista:The source rect width must match the width set through SetSize. Repeated WriteSource calls can be made as long as the total accumulated source rect height is the same as set through SetSize.

/// - /// + /// /// ee690159 /// HRESULT IWICBitmapFrameEncode::WriteSource([In, Optional] IWICBitmapSource* pIBitmapSource,[In, Optional] WICRect* prc) /// IWICBitmapFrameEncode::WriteSource @@ -144,7 +144,7 @@ public void WriteSource(SharpDX.WIC.BitmapSource bitmapSource) /// ///

If SetSize is not called prior to calling WriteSource, the size given in prc is used if not null. Otherwise, the size of the given in pIBitmapSource is used.

If SetPixelFormat is not called prior to calling WriteSource, the pixel format of the given in pIBitmapSource is used.

If SetResolution is not called prior to calling WriteSource, the pixel format of pIBitmapSource is used.

If SetPalette is not called prior to calling WriteSource, the target pixel format is indexed, and the pixel format of pIBitmapSource matches the encoder frame's pixel format, then the pIBitmapSource pixel format is used.

When encoding a GIF image, if the global palette is set and the frame level palette is not set directly by the user or by a custom independent software vendor (ISV) GIF codec, WriteSource will use the global palette to encode the frame even when pIBitmapSource has a frame level palette.

Windows Vista:The source rect width must match the width set through SetSize. Repeated WriteSource calls can be made as long as the total accumulated source rect height is the same as set through SetSize.

/// - /// + /// /// ee690159 /// HRESULT IWICBitmapFrameEncode::WriteSource([In, Optional] IWICBitmapSource* pIBitmapSource,[In, Optional] WICRect* prc) /// IWICBitmapFrameEncode::WriteSource diff --git a/Source/SharpDX.Direct3D11/DeviceContext.CommonShaderStage.cs b/Source/SharpDX.Direct3D11/DeviceContext.CommonShaderStage.cs index 6b34dbd18..25192cd8b 100644 --- a/Source/SharpDX.Direct3D11/DeviceContext.CommonShaderStage.cs +++ b/Source/SharpDX.Direct3D11/DeviceContext.CommonShaderStage.cs @@ -25,7 +25,6 @@ namespace SharpDX.Direct3D11 /// 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 public abstract partial class CommonShaderStage : CppObject { /// diff --git a/Source/SharpDX.Direct3D12/Device.cs b/Source/SharpDX.Direct3D12/Device.cs index 232c172a3..1d8e79954 100644 --- a/Source/SharpDX.Direct3D12/Device.cs +++ b/Source/SharpDX.Direct3D12/Device.cs @@ -63,7 +63,7 @@ public Device(Adapter adapter, FeatureLevel minFeatureLevel) : base(IntPtr.Zero) /// ///

Refer to Capability Querying.

/// - /// + /// /// dn788653 /// HRESULT ID3D12Device::CheckFeatureSupport([In] D3D12_FEATURE Feature,[Out, Buffer] void* pFeatureSupportData,[In] unsigned int FeatureSupportDataSize) /// ID3D12Device::CheckFeatureSupport @@ -84,7 +84,7 @@ public bool CheckFeatureSupport(SharpDX.Direct3D12.Feature feature, ref T fea /// ///

The REFIID, or , of the interface to the command queue can be obtained by using the __uuidof() macro. For example, __uuidof() will get the of the interface to a command queue.

/// - /// + /// /// dn788657 /// HRESULT ID3D12Device::CreateCommandQueue([In] const D3D12_COMMAND_QUEUE_DESC* pDesc,[In] const GUID& riid,[Out] ID3D12CommandQueue** ppCommandQueue) /// ID3D12Device::CreateCommandQueue @@ -102,7 +102,7 @@ public SharpDX.Direct3D12.CommandQueue CreateCommandQueue(SharpDX.Direct3D12.Com /// ///

The device creates command lists from the command allocator.

/// - /// + /// /// dn788655 /// HRESULT ID3D12Device::CreateCommandAllocator([In] D3D12_COMMAND_LIST_TYPE type,[In] const GUID& riid,[Out] ID3D12CommandAllocator** ppCommandAllocator) /// ID3D12Device::CreateCommandAllocator @@ -129,7 +129,7 @@ public GraphicsCommandList CreateCommandList( /// No documentation. /// No documentation. /// dn788656 - /// + /// /// HRESULT ID3D12Device::CreateCommandList([In] unsigned int nodeMask,[In] D3D12_COMMAND_LIST_TYPE type,[In] ID3D12CommandAllocator* pCommandAllocator,[In, Optional] ID3D12PipelineState* pInitialState,[In] const GUID& riid,[Out] void** ppCommandList) /// ID3D12Device::CreateCommandList public GraphicsCommandList CreateCommandList(int nodeMask, @@ -148,7 +148,7 @@ public GraphicsCommandList CreateCommandList(int nodeMask, ///

Specifies the that the command signature applies to.

///

The globally unique identifier () for the command signature interface (). The REFIID, or , of the interface to the command signature can be obtained by using the __uuidof() macro. For example, __uuidof() will get the of the interface to a command signature.

///

Specifies a reference, that on successful completion of the method will point to the created command signature ().

- /// + /// /// dn903827 /// HRESULT ID3D12Device::CreateCommandSignature([In] const void* pDesc,[In, Optional] ID3D12RootSignature* pRootSignature,[In] const GUID& riid,[Out] ID3D12CommandSignature** ppvCommandSignature) /// ID3D12Device::CreateCommandSignature @@ -181,7 +181,7 @@ public unsafe CommandSignature CreateCommandSignature(SharpDX.Direct3D12.Command /// ///

This method creates both a resource and a heap, such that the heap is big enough to contain the entire resource and the resource is mapped to the heap. The created heap is known as an implicit heap, because the heap object cannot be obtained by the application. The application must ensure the GPU will no longer read or write to this resource before releasing the final reference on the resource.

The implicit heap is made resident for GPU access before the method returns to the application. See Residency.

The resource GPU VA mapping cannot be changed. See and Volume Tiled Resources.

This method may be called by multiple threads concurrently.

/// - /// + /// /// dn899178 /// HRESULT ID3D12Device::CreateCommittedResource([In] const D3D12_HEAP_PROPERTIES* pHeapProperties,[In] D3D12_HEAP_FLAGS HeapFlags,[In, Value] const D3D12_RESOURCE_DESC* pResourceDesc,[In] D3D12_RESOURCE_STATES InitialResourceState,[In, Optional] const D3D12_CLEAR_VALUE* pOptimizedClearValue,[In] const GUID& riidResource,[Out] ID3D12Resource** ppvResource) /// ID3D12Device::CreateCommittedResource @@ -196,7 +196,7 @@ public SharpDX.Direct3D12.Resource CreateCommittedResource(SharpDX.Direct3D12.He ///

A reference to a structure that describes compute pipeline state.

///

The globally unique identifier () for the pipeline state interface (). The REFIID, or , of the interface to the pipeline state can be obtained by using the __uuidof() macro. For example, __uuidof() will get the of the interface to a pipeline state.

///

A reference to a memory block that receives a reference to the interface for the pipeline state object. The pipeline state object is an immutable state object. It contains no methods.

- /// + /// /// dn788658 /// HRESULT ID3D12Device::CreateComputePipelineState([In] const void* pDesc,[In] const GUID& riid,[Out] ID3D12PipelineState** ppPipelineState) /// ID3D12Device::CreateComputePipelineState @@ -220,7 +220,7 @@ public unsafe SharpDX.Direct3D12.PipelineState CreateComputePipelineState(SharpD /// No documentation. /// No documentation. /// No documentation. - /// + /// /// dn788658 /// HRESULT ID3D12Device::CreateRootSignature([In] unsigned int nodeMask,[In, Buffer] const void* pBlobWithRootSignature,[In] SIZE_T blobLengthInBytes,[In] const GUID& riid,[Out] ID3D12RootSignature** ppvRootSignature) /// ID3D12Device::CreateRootSignature @@ -237,7 +237,7 @@ public SharpDX.Direct3D12.RootSignature CreateRootSignature(DataPointer rootSign /// No documentation. /// No documentation. /// No documentation. - /// + /// /// dn788658 /// HRESULT ID3D12Device::CreateRootSignature([In] unsigned int nodeMask,[In, Buffer] const void* pBlobWithRootSignature,[In] SIZE_T blobLengthInBytes,[In] const GUID& riid,[Out] ID3D12RootSignature** ppvRootSignature) /// ID3D12Device::CreateRootSignature @@ -254,7 +254,7 @@ public SharpDX.Direct3D12.RootSignature CreateRootSignature(int nodeMask, DataPo /// No documentation. /// No documentation. /// No documentation. - /// + /// /// dn788658 /// HRESULT ID3D12Device::CreateRootSignature([In] unsigned int nodeMask,[In, Buffer] const void* pBlobWithRootSignature,[In] SIZE_T blobLengthInBytes,[In] const GUID& riid,[Out] ID3D12RootSignature** ppvRootSignature) /// ID3D12Device::CreateRootSignature @@ -289,7 +289,7 @@ public SharpDX.Direct3D12.DescriptorHeap CreateDescriptorHeap(SharpDX.Direct3D12 /// No documentation. /// No documentation. /// No documentation. - /// + /// /// dn899179 /// HRESULT ID3D12Device::CreateFence([In] unsigned longlong InitialValue,[In] D3D12_FENCE_FLAGS Flags,[In] const GUID& riid,[Out] ID3D12Fence** ppFence) /// ID3D12Device::CreateFence @@ -304,7 +304,7 @@ public Fence CreateFence(long initialValue, SharpDX.Direct3D12.FenceFlags flags) /// No documentation. /// No documentation. /// No documentation. - /// + /// /// dn788663 /// HRESULT ID3D12Device::CreateGraphicsPipelineState([In] const void* pDesc,[In] const GUID& riid,[Out] ID3D12PipelineState** ppPipelineState) /// ID3D12Device::CreateGraphicsPipelineState @@ -395,7 +395,7 @@ public unsafe SharpDX.Direct3D12.PipelineState CreateGraphicsPipelineState(Sharp /// ///

CreateHeap creates a heap that can be used with placed resources and reserved resources. Before releasing the final reference on the heap, the application must ensure that the GPU will no longer read or write to this heap. Placed resource objects will hold a reference on the heap they are created on, but reserved resources will not hold a reference for each mapping made to a heap.

/// - /// + /// /// dn788664 /// HRESULT ID3D12Device::CreateHeap([In] const D3D12_HEAP_DESC* pDesc,[In] const GUID& riid,[Out] ID3D12Heap** ppvHeap) /// ID3D12Device::CreateHeap @@ -413,7 +413,7 @@ public SharpDX.Direct3D12.Heap CreateHeap(SharpDX.Direct3D12.HeapDescription des /// ///

Refer to Queries for more information.

/// - /// + /// /// dn903828 /// HRESULT ID3D12Device::CreateQueryHeap([In] const D3D12_QUERY_HEAP_DESC* pDesc,[In] const GUID& riid,[Out] ID3D12QueryHeap** ppvHeap) /// ID3D12Device::CreateQueryHeap @@ -435,7 +435,7 @@ public SharpDX.Direct3D12.QueryHeap CreateQueryHeap(SharpDX.Direct3D12.QueryHeap /// ///

CreatePlacedResource is similar to fully mapping a reserved resource to an offset within a heap; but the virtual address space associated with a heap may be reused as well.

Placed resources are lighter weight than committed resources to create and destroy, because no heap is created or destroyed during this operation. However, placed resources enable an even lighter weight technique to reuse memory than resource creation and destruction: reuse through aliasing and aliasing barriers. Multiple placed resources may simultaneously overlap each other on the same heap, but only a single overlapping resource can be used at a time.

There are two placed resource usage semantics, a simple model and an advanced model. The simple model is recommended, and is the most likely model for tool support, until the advanced model is proven to be required by the app.

/// - /// + /// /// dn899180 /// HRESULT ID3D12Device::CreatePlacedResource([In] ID3D12Heap* pHeap,[In] unsigned longlong HeapOffset,[In] const D3D12_RESOURCE_DESC* pDesc,[In] D3D12_RESOURCE_STATES InitialState,[In, Optional] const D3D12_CLEAR_VALUE* pOptimizedClearValue,[In] const GUID& riid,[Out] ID3D12Resource** ppvResource) /// ID3D12Device::CreatePlacedResource @@ -457,7 +457,7 @@ public SharpDX.Direct3D12.Resource CreatePlacedResource(SharpDX.Direct3D12.Heap /// No documentation. /// No documentation. /// dn899181 - /// + /// /// HRESULT ID3D12Device::CreateReservedResource([In] const D3D12_RESOURCE_DESC* pDesc,[In] D3D12_RESOURCE_STATES InitialState,[In, Optional] const D3D12_CLEAR_VALUE* pOptimizedClearValue,[In] const GUID& riid,[Out] ID3D12Resource** ppvResource) /// ID3D12Device::CreateReservedResource public SharpDX.Direct3D12.Resource CreateReservedResource(SharpDX.Direct3D12.ResourceDescription descRef, @@ -477,7 +477,7 @@ public SharpDX.Direct3D12.Resource CreateReservedResource(SharpDX.Direct3D12.Res /// ///

When using CreatePlacedResource, the application must use this method to understand the size and alignment characteristics of texture resources. The results of this method vary depending on the particular adapter, and must be treated as unique to this adapter and driver version.

Applications cannot use the output of GetResourceAllocationInfo to understand packed mip properties of textures. To understand packed mip properties of textures, applications must use GetResourceTiling. Texture resource sizes significantly differ from the information returned by GetResourceTiling, because some adapter architectures allocate extra memory for textures to reduce the effective bandwidth during common rendering scenarios. This even includes textures that have constraints on their texture layouts or have standardized texture layouts. That extra memory cannot be sparsely mapped or remapped by an application using CreateReservedResource and UpdateTileMappings, so it isn't reported in GetResourceTiling.

Applications can forgo using GetResourceAllocationInfo for buffer resources (_BUFFER). Buffers have the same size on all adapters, which is merely the smallest multiple of 64KB which is greater or equal to ::Width.

When multiple resource descriptions are passed in, the C++ algorithm for calculating a structure size and alignment are used. For example, a three-element array with two tiny 64KB-aligned resources and a tiny 4MB-aligned resource reports differing sizes based on the order of the array. If the 4MB aligned resource is in the middle, the resulting Size is 12MB. Otherwise, the resulting Size is 8MB. The Alignment returned would always be 4MB, as it is the superset of all alignments in the resource array.

/// - /// + /// /// dn788680 /// D3D12_RESOURCE_ALLOCATION_INFO ID3D12Device::GetResourceAllocationInfo([In] unsigned int visibleMask,[In] unsigned int numResourceDescs,[In, Buffer] const D3D12_RESOURCE_DESC* pResourceDescs) /// ID3D12Device::GetResourceAllocationInfo @@ -496,7 +496,7 @@ public SharpDX.Direct3D12.ResourceAllocationInformation GetResourceAllocationInf /// ///

Refer to Capability Querying.

/// - /// + /// /// dn788653 /// HRESULT ID3D12Device::CheckFeatureSupport([In] D3D12_FEATURE Feature,[Out, Buffer] void* pFeatureSupportData,[In] unsigned int FeatureSupportDataSize) /// ID3D12Device::CheckFeatureSupport @@ -520,7 +520,7 @@ public unsafe FeatureDataD3D12Options D3D12Options /// ///

Refer to Capability Querying.

/// - /// + /// /// dn788653 /// HRESULT ID3D12Device::CheckFeatureSupport([In] D3D12_FEATURE Feature,[Out, Buffer] void* pFeatureSupportData,[In] unsigned int FeatureSupportDataSize) /// ID3D12Device::CheckFeatureSupport diff --git a/Source/SharpDX.Direct3D12/GraphicsCommandList.cs b/Source/SharpDX.Direct3D12/GraphicsCommandList.cs index 252b508cc..27865f25e 100644 --- a/Source/SharpDX.Direct3D12/GraphicsCommandList.cs +++ b/Source/SharpDX.Direct3D12/GraphicsCommandList.cs @@ -34,7 +34,7 @@ public partial class GraphicsCommandList ///

A value to clear the stencil buffer with.

///

The number of rectangles in the array that the pRects parameter specifies.

///

An array of D3D12_RECT structures for the rectangles in the resource view to clear. If null, ClearDepthStencilView clears the entire resource view.

- /// + /// /// dn903840 /// void ID3D12GraphicsCommandList::ClearDepthStencilView([In] D3D12_CPU_DESCRIPTOR_HANDLE DepthStencilView,[In] D3D12_CLEAR_FLAGS ClearFlags,[In] float Depth,[In] unsigned char Stencil,[In] unsigned int NumRects,[In, Buffer] const RECT* pRects) /// ID3D12GraphicsCommandList::ClearDepthStencilView @@ -50,7 +50,7 @@ public void ClearDepthStencilView(SharpDX.Direct3D12.CpuDescriptorHandle depthSt ///

A 4-component array that represents the color to fill the render target with.

///

The number of rectangles in the array that the pRects parameter specifies.

///

An array of D3D12_RECT structures for the rectangles in the resource view to clear. If null, ClearRenderTargetView clears the entire resource view.

- /// + /// /// dn903842 /// void ID3D12GraphicsCommandList::ClearRenderTargetView([In] D3D12_CPU_DESCRIPTOR_HANDLE RenderTargetView,[In] const SHARPDX_COLOR4* ColorRGBA,[In] unsigned int NumRects,[In, Buffer] const RECT* pRects) /// ID3D12GraphicsCommandList::ClearRenderTargetView @@ -67,7 +67,7 @@ public void ClearRenderTargetView(CpuDescriptorHandle renderTargetView, Mathemat /// ///

There are three types of barrier descriptions:

  • - Transition barriers indicate that a set of subresources transition between different usages. The caller must specify the before and after usages of the subresources. The D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES flag is used to transition all subresources in a resource at the same time.
  • - Aliasing barriers indicate a transition between usages of two different resources which have mappings into the same heap. The application can specify both the before and the after resource. Note that one or both resources can be null (indicating that any tiled resource could cause aliasing).
  • - Unordered access view barriers indicate all UAV accesses (read or writes) to a particular resource must complete before any future UAV accesses (read or write) can begin. The specified resource cannot be null. It is not necessary to insert a UAV barrier between two draw or dispatch calls which only read a UAV. Additionally, it is not necessary to insert a UAV barrier between two draw or dispatch calls which write to the same UAV if the application knows that it is safe to execute the UAV accesses in any order. The resource can be null (indicating that any UAV access could require the barrier).

When is passed an array of resource barrier descriptions, the API behaves as if it was called N times (1 for each array element), in the specified order.

For descriptions of the usage states a subresource can be in, see the enumeration and the Using Resource Barriers to Synchronize Resource States in Direct3D 12 section.

A subresource can be in any state when is called.

When a back buffer is presented, it must be in the state. If Present is called on a resource which is not in the PRESENT state, a debug layer warning will be emitted.

The resource usage bits are group into two categories, read-only and read/write.

The following usage bits are read-only:

The following usage bits are read/write:

  • D3D12_RESOURCE_STATE_GENERATE_MIPS

At most one write bit can be set. If any write bit is set, then no read bit may be set. If no write bit is set, then any number of read bits may be set.

At any given time, a subresource is in exactly one state (determined by a set of flags). The application must ensure that the states are matched when making a sequence of ResourceBarrier calls. In other words, the before and after states in consecutive calls to ResourceBarrier must agree.

To transition all subresources within a resource, the application can set the subresource index to D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES, which implies that all subresources are changed.

For improved performance, applications should use split barriers (refer to Synchronization and Multi-Engine). Applications should also batch multiple transitions into a single call whenever possible.

/// - /// + /// /// dn903898 /// void ID3D12GraphicsCommandList::ResourceBarrier([In] unsigned int NumBarriers,[In, Buffer] const void* pBarriers) /// ID3D12GraphicsCommandList::ResourceBarrier @@ -84,7 +84,7 @@ public void ResourceBarrierTransition(Resource resource, ResourceStates stateBef /// ///

There are three types of barrier descriptions:

  • - Transition barriers indicate that a set of subresources transition between different usages. The caller must specify the before and after usages of the subresources. The D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES flag is used to transition all subresources in a resource at the same time.
  • - Aliasing barriers indicate a transition between usages of two different resources which have mappings into the same heap. The application can specify both the before and the after resource. Note that one or both resources can be null (indicating that any tiled resource could cause aliasing).
  • - Unordered access view barriers indicate all UAV accesses (read or writes) to a particular resource must complete before any future UAV accesses (read or write) can begin. The specified resource cannot be null. It is not necessary to insert a UAV barrier between two draw or dispatch calls which only read a UAV. Additionally, it is not necessary to insert a UAV barrier between two draw or dispatch calls which write to the same UAV if the application knows that it is safe to execute the UAV accesses in any order. The resource can be null (indicating that any UAV access could require the barrier).

When is passed an array of resource barrier descriptions, the API behaves as if it was called N times (1 for each array element), in the specified order.

For descriptions of the usage states a subresource can be in, see the enumeration and the Using Resource Barriers to Synchronize Resource States in Direct3D 12 section.

A subresource can be in any state when is called.

When a back buffer is presented, it must be in the state. If Present is called on a resource which is not in the PRESENT state, a debug layer warning will be emitted.

The resource usage bits are group into two categories, read-only and read/write.

The following usage bits are read-only:

The following usage bits are read/write:

  • D3D12_RESOURCE_STATE_GENERATE_MIPS

At most one write bit can be set. If any write bit is set, then no read bit may be set. If no write bit is set, then any number of read bits may be set.

At any given time, a subresource is in exactly one state (determined by a set of flags). The application must ensure that the states are matched when making a sequence of ResourceBarrier calls. In other words, the before and after states in consecutive calls to ResourceBarrier must agree.

To transition all subresources within a resource, the application can set the subresource index to D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES, which implies that all subresources are changed.

For improved performance, applications should use split barriers (refer to Synchronization and Multi-Engine). Applications should also batch multiple transitions into a single call whenever possible.

/// - /// + /// /// dn903898 /// void ID3D12GraphicsCommandList::ResourceBarrier([In] unsigned int NumBarriers,[In, Buffer] const void* pBarriers) /// ID3D12GraphicsCommandList::ResourceBarrier @@ -102,7 +102,7 @@ public unsafe void ResourceBarrierTransition(Resource resource, int subresource, /// ///

There are three types of barrier descriptions:

  • - Transition barriers indicate that a set of subresources transition between different usages. The caller must specify the before and after usages of the subresources. The D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES flag is used to transition all subresources in a resource at the same time.
  • - Aliasing barriers indicate a transition between usages of two different resources which have mappings into the same heap. The application can specify both the before and the after resource. Note that one or both resources can be null (indicating that any tiled resource could cause aliasing).
  • - Unordered access view barriers indicate all UAV accesses (read or writes) to a particular resource must complete before any future UAV accesses (read or write) can begin. The specified resource cannot be null. It is not necessary to insert a UAV barrier between two draw or dispatch calls which only read a UAV. Additionally, it is not necessary to insert a UAV barrier between two draw or dispatch calls which write to the same UAV if the application knows that it is safe to execute the UAV accesses in any order. The resource can be null (indicating that any UAV access could require the barrier).

When is passed an array of resource barrier descriptions, the API behaves as if it was called N times (1 for each array element), in the specified order.

For descriptions of the usage states a subresource can be in, see the enumeration and the Using Resource Barriers to Synchronize Resource States in Direct3D 12 section.

A subresource can be in any state when is called.

When a back buffer is presented, it must be in the state. If Present is called on a resource which is not in the PRESENT state, a debug layer warning will be emitted.

The resource usage bits are group into two categories, read-only and read/write.

The following usage bits are read-only:

The following usage bits are read/write:

  • D3D12_RESOURCE_STATE_GENERATE_MIPS

At most one write bit can be set. If any write bit is set, then no read bit may be set. If no write bit is set, then any number of read bits may be set.

At any given time, a subresource is in exactly one state (determined by a set of flags). The application must ensure that the states are matched when making a sequence of ResourceBarrier calls. In other words, the before and after states in consecutive calls to ResourceBarrier must agree.

To transition all subresources within a resource, the application can set the subresource index to D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES, which implies that all subresources are changed.

For improved performance, applications should use split barriers (refer to Synchronization and Multi-Engine). Applications should also batch multiple transitions into a single call whenever possible.

/// - /// + /// /// dn903898 /// void ID3D12GraphicsCommandList::ResourceBarrier([In] unsigned int NumBarriers,[In, Buffer] const void* pBarriers) /// ID3D12GraphicsCommandList::ResourceBarrier @@ -120,7 +120,7 @@ public unsafe void ResourceBarrierAliasing(Resource resourceBefore, Resource res /// ///

There are three types of barrier descriptions:

  • - Transition barriers indicate that a set of subresources transition between different usages. The caller must specify the before and after usages of the subresources. The D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES flag is used to transition all subresources in a resource at the same time.
  • - Aliasing barriers indicate a transition between usages of two different resources which have mappings into the same heap. The application can specify both the before and the after resource. Note that one or both resources can be null (indicating that any tiled resource could cause aliasing).
  • - Unordered access view barriers indicate all UAV accesses (read or writes) to a particular resource must complete before any future UAV accesses (read or write) can begin. The specified resource cannot be null. It is not necessary to insert a UAV barrier between two draw or dispatch calls which only read a UAV. Additionally, it is not necessary to insert a UAV barrier between two draw or dispatch calls which write to the same UAV if the application knows that it is safe to execute the UAV accesses in any order. The resource can be null (indicating that any UAV access could require the barrier).

When is passed an array of resource barrier descriptions, the API behaves as if it was called N times (1 for each array element), in the specified order.

For descriptions of the usage states a subresource can be in, see the enumeration and the Using Resource Barriers to Synchronize Resource States in Direct3D 12 section.

A subresource can be in any state when is called.

When a back buffer is presented, it must be in the state. If Present is called on a resource which is not in the PRESENT state, a debug layer warning will be emitted.

The resource usage bits are group into two categories, read-only and read/write.

The following usage bits are read-only:

The following usage bits are read/write:

  • D3D12_RESOURCE_STATE_GENERATE_MIPS

At most one write bit can be set. If any write bit is set, then no read bit may be set. If no write bit is set, then any number of read bits may be set.

At any given time, a subresource is in exactly one state (determined by a set of flags). The application must ensure that the states are matched when making a sequence of ResourceBarrier calls. In other words, the before and after states in consecutive calls to ResourceBarrier must agree.

To transition all subresources within a resource, the application can set the subresource index to D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES, which implies that all subresources are changed.

For improved performance, applications should use split barriers (refer to Synchronization and Multi-Engine). Applications should also batch multiple transitions into a single call whenever possible.

/// - /// + /// /// dn903898 /// void ID3D12GraphicsCommandList::ResourceBarrier([In] unsigned int NumBarriers,[In, Buffer] const void* pBarriers) /// ID3D12GraphicsCommandList::ResourceBarrier @@ -137,7 +137,7 @@ public unsafe void ResourceBarrier(SharpDX.Direct3D12.ResourceBarrier barrier) /// ///

There are three types of barrier descriptions:

  • - Transition barriers indicate that a set of subresources transition between different usages. The caller must specify the before and after usages of the subresources. The D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES flag is used to transition all subresources in a resource at the same time.
  • - Aliasing barriers indicate a transition between usages of two different resources which have mappings into the same heap. The application can specify both the before and the after resource. Note that one or both resources can be null (indicating that any tiled resource could cause aliasing).
  • - Unordered access view barriers indicate all UAV accesses (read or writes) to a particular resource must complete before any future UAV accesses (read or write) can begin. The specified resource cannot be null. It is not necessary to insert a UAV barrier between two draw or dispatch calls which only read a UAV. Additionally, it is not necessary to insert a UAV barrier between two draw or dispatch calls which write to the same UAV if the application knows that it is safe to execute the UAV accesses in any order. The resource can be null (indicating that any UAV access could require the barrier).

When is passed an array of resource barrier descriptions, the API behaves as if it was called N times (1 for each array element), in the specified order.

For descriptions of the usage states a subresource can be in, see the enumeration and the Using Resource Barriers to Synchronize Resource States in Direct3D 12 section.

A subresource can be in any state when is called.

When a back buffer is presented, it must be in the state. If Present is called on a resource which is not in the PRESENT state, a debug layer warning will be emitted.

The resource usage bits are group into two categories, read-only and read/write.

The following usage bits are read-only:

The following usage bits are read/write:

  • D3D12_RESOURCE_STATE_GENERATE_MIPS

At most one write bit can be set. If any write bit is set, then no read bit may be set. If no write bit is set, then any number of read bits may be set.

At any given time, a subresource is in exactly one state (determined by a set of flags). The application must ensure that the states are matched when making a sequence of ResourceBarrier calls. In other words, the before and after states in consecutive calls to ResourceBarrier must agree.

To transition all subresources within a resource, the application can set the subresource index to D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES, which implies that all subresources are changed.

For improved performance, applications should use split barriers (refer to Synchronization and Multi-Engine). Applications should also batch multiple transitions into a single call whenever possible.

/// - /// + /// /// dn903898 /// void ID3D12GraphicsCommandList::ResourceBarrier([In] unsigned int NumBarriers,[In, Buffer] const void* pBarriers) /// ID3D12GraphicsCommandList::ResourceBarrier @@ -156,7 +156,7 @@ public unsafe void ResourceBarrier(params SharpDX.Direct3D12.ResourceBarrier[] b /// ///

SetDescriptorHeaps can be called on a bundle, but the bundle descriptor heaps must match the calling command list descriptor heap. For more information on bundle restrictions, refer to Creating and Recording Command Lists and Bundles.

/// - /// + /// /// Dn903908 /// void ID3D12GraphicsCommandList::SetDescriptorHeaps([In] unsigned int NumDescriptorHeaps,[In, Buffer] const ID3D12DescriptorHeap** ppDescriptorHeaps) /// ID3D12GraphicsCommandList::SetDescriptorHeaps @@ -172,7 +172,7 @@ public void SetDescriptorHeaps(params SharpDX.Direct3D12.DescriptorHeap[] descri ///

Specifies an array of structures that describe the CPU descriptor handles that represents the start of the heap of render target descriptors.

///

True means the handle passed in is the reference to a contiguous range of NumRenderTargetDescriptors descriptors. This case is useful if the set of descriptors to bind already happens to be contiguous in memory (so all that?s needed is a handle to the first one). For example, if NumRenderTargetDescriptors is 3 then the memory layout is taken as follows:

In this case the driver dereferences the handle and then increments the memory being pointed to.

False means that the handle is the first of an array of NumRenderTargetDescriptors handles. The false case allows an application to bind a set of descriptors from different locations at once. Again assuming that NumRenderTargetDescriptors is 3, the memory layout is taken as follows:

In this case the driver dereferences three handles that are expected to be adjacent to each other in memory.

///

A reference to a structure that describes the CPU descriptor handle that represents the start of the heap that holds the depth stencil descriptor.

- /// + /// /// dn986884 /// void ID3D12GraphicsCommandList::OMSetRenderTargets([In] unsigned int NumRenderTargetDescriptors,[In, Optional] const void* pRenderTargetDescriptors,[In] BOOL RTsSingleHandleToDescriptorRange,[In, Optional] const D3D12_CPU_DESCRIPTOR_HANDLE* pDepthStencilDescriptor) /// ID3D12GraphicsCommandList::OMSetRenderTargets @@ -190,7 +190,7 @@ public unsafe void SetRenderTargets(int numRenderTargetDescriptors, ///

Specifies an array of structures that describe the CPU descriptor handles that represents the start of the heap of render target descriptors.

///

True means the handle passed in is the reference to a contiguous range of NumRenderTargetDescriptors descriptors. This case is useful if the set of descriptors to bind already happens to be contiguous in memory (so all that?s needed is a handle to the first one). For example, if NumRenderTargetDescriptors is 3 then the memory layout is taken as follows:

In this case the driver dereferences the handle and then increments the memory being pointed to.

False means that the handle is the first of an array of NumRenderTargetDescriptors handles. The false case allows an application to bind a set of descriptors from different locations at once. Again assuming that NumRenderTargetDescriptors is 3, the memory layout is taken as follows:

In this case the driver dereferences three handles that are expected to be adjacent to each other in memory.

///

A reference to a structure that describes the CPU descriptor handle that represents the start of the heap that holds the depth stencil descriptor.

- /// + /// /// dn986884 /// void ID3D12GraphicsCommandList::OMSetRenderTargets([In] unsigned int NumRenderTargetDescriptors,[In, Optional] const void* pRenderTargetDescriptors,[In] BOOL RTsSingleHandleToDescriptorRange,[In, Optional] const D3D12_CPU_DESCRIPTOR_HANDLE* pDepthStencilDescriptor) /// ID3D12GraphicsCommandList::OMSetRenderTargets @@ -207,7 +207,7 @@ public unsafe void SetRenderTargets(CpuDescriptorHandle[] renderTargetDescriptor ///

Specifies an array of structures that describe the CPU descriptor handles that represents the start of the heap of render target descriptors.

///

True means the handle passed in is the reference to a contiguous range of NumRenderTargetDescriptors descriptors. This case is useful if the set of descriptors to bind already happens to be contiguous in memory (so all that?s needed is a handle to the first one). For example, if NumRenderTargetDescriptors is 3 then the memory layout is taken as follows:

In this case the driver dereferences the handle and then increments the memory being pointed to.

False means that the handle is the first of an array of NumRenderTargetDescriptors handles. The false case allows an application to bind a set of descriptors from different locations at once. Again assuming that NumRenderTargetDescriptors is 3, the memory layout is taken as follows:

In this case the driver dereferences three handles that are expected to be adjacent to each other in memory.

///

A reference to a structure that describes the CPU descriptor handle that represents the start of the heap that holds the depth stencil descriptor.

- /// + /// /// dn986884 /// void ID3D12GraphicsCommandList::OMSetRenderTargets([In] unsigned int NumRenderTargetDescriptors,[In, Optional] const void* pRenderTargetDescriptors,[In] BOOL RTsSingleHandleToDescriptorRange,[In, Optional] const D3D12_CPU_DESCRIPTOR_HANDLE* pDepthStencilDescriptor) /// ID3D12GraphicsCommandList::OMSetRenderTargets diff --git a/Source/SharpDX.Direct3D9/EffectHandle.cs b/Source/SharpDX.Direct3D9/EffectHandle.cs index 748e5fd04..af6357226 100644 --- a/Source/SharpDX.Direct3D9/EffectHandle.cs +++ b/Source/SharpDX.Direct3D9/EffectHandle.cs @@ -224,7 +224,7 @@ public static implicit operator EffectHandle(IntPtr value) } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from to raw pointer"/>. /// /// The value. /// @@ -236,7 +236,7 @@ public static implicit operator EffectHandle(IntPtr value) } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from raw pointer to . /// /// The value. /// diff --git a/Source/SharpDX.DirectManipulation/CompositorNative.cs b/Source/SharpDX.DirectManipulation/CompositorNative.cs index 940ae7780..c08c68220 100644 --- a/Source/SharpDX.DirectManipulation/CompositorNative.cs +++ b/Source/SharpDX.DirectManipulation/CompositorNative.cs @@ -7,6 +7,9 @@ namespace SharpDX.DirectManipulation { partial class CompositorNative { + /// + /// Class ID for compositor + /// public static readonly Guid DirectCompositionCompositorClassId = new Guid("79DEA627-A08A-43AC-8EF5-6900B9299126"); /// @@ -31,7 +34,7 @@ public static CompositorNative CreateDefaultDirectCompositor() ///

The parent in the composition tree for the content being added.

parentVisual must also be a parent of childVisual in the composition tree.

///

The child in the composition tree for the content being added.

parentVisual must also be a parent of childVisual in the composition tree.

/// No documentation. - /// + /// /// Hh768898 /// HRESULT IDirectManipulationCompositor::AddContent([In] IDirectManipulationContent* content,[In, Optional] IUnknown* device,[In, Optional] IUnknown* parentVisual,[In, Optional] IUnknown* childVisual) /// IDirectManipulationCompositor::AddContent @@ -46,7 +49,7 @@ public void AddContent(SharpDX.DirectManipulation.Content content, SharpDX.ComOb /// ///

The content to remove from the composition tree.

/// No documentation. - /// + /// /// Hh768899 /// HRESULT IDirectManipulationCompositor::RemoveContent([In] IDirectManipulationContent* content) /// IDirectManipulationCompositor::RemoveContent @@ -61,7 +64,7 @@ public void RemoveContent(SharpDX.DirectManipulation.Content content) /// /// No documentation. /// No documentation. - /// + /// /// Hh768900 /// HRESULT IDirectManipulationCompositor::SetUpdateManager([In] IDirectManipulationUpdateManager* updateManager) /// IDirectManipulationCompositor::SetUpdateManager @@ -74,7 +77,7 @@ public void SetUpdateManager(SharpDX.DirectManipulation.UpdateManager updateMana ///

Commits all pending updates in the compositor to the system for rendering.

Syntax
 Flush();
Parameters

This method has no parameters.

Return value

If the method succeeds, it returns . Otherwise, it returns an error code.

Remarks

This method enables Direct Manipulation to flush any pending changes to its visuals before a system event, such as a process suspension.

Requirements /// /// No documentation. - /// + /// /// jj647930 /// HRESULT IDirectManipulationCompositor::Flush() /// IDirectManipulationCompositor::Flush diff --git a/Source/SharpDX.DirectSound/SoundBuffer.cs b/Source/SharpDX.DirectSound/SoundBuffer.cs index fbda97f14..b0b19645b 100644 --- a/Source/SharpDX.DirectSound/SoundBuffer.cs +++ b/Source/SharpDX.DirectSound/SoundBuffer.cs @@ -128,7 +128,7 @@ public void SetNotificationPositions(NotificationPosition[] positions) /// /// The wave format. /// - /// + /// /// HRESULT IDirectSoundBuffer::SetFormat([In] const WAVEFORMATEX* pcfxFormat) public SharpDX.Multimedia.WaveFormat Format { diff --git a/Source/SharpDX.MediaFoundation/Activate.cs b/Source/SharpDX.MediaFoundation/Activate.cs index 285312e5f..ab75645a5 100644 --- a/Source/SharpDX.MediaFoundation/Activate.cs +++ b/Source/SharpDX.MediaFoundation/Activate.cs @@ -49,7 +49,7 @@ public Activate(string activatableClassId, ComObject propertySet = null) /// ///

Some Microsoft Media Foundation objects must be shut down before being released. If so, the caller is responsible for shutting down the object that is returned in ppv. To shut down the object, do one of the following:

  • Call on the activation object, or
  • Call the object-specific shutdown method. This method will depend on the type of object. Possibilities include:
    • Media sources: Call .
    • Media sinks: Call .
    • Any object that supports the interface: Call .

The method is generic to all object types. If the object does not require a shutdown method, ShutdownObject succeeds and has no effect. If you do not know the specific shutdown method for the object (or do not know the object type), call .

After the first call to ActivateObject, subsequent calls return a reference to the same instance, until the client calls either ShutdownObject or .

/// - /// + /// /// ms694292 /// HRESULT IMFActivate::ActivateObject([In] const GUID& riid,[Out] void** ppv) /// IMFActivate::ActivateObject @@ -70,7 +70,7 @@ public T ActivateObject(System.Guid riid) where T : SharpDX.ComObject /// ///

Some Microsoft Media Foundation objects must be shut down before being released. If so, the caller is responsible for shutting down the object that is returned in ppv. To shut down the object, do one of the following:

  • Call on the activation object, or
  • Call the object-specific shutdown method. This method will depend on the type of object. Possibilities include:
    • Media sources: Call .
    • Media sinks: Call .
    • Any object that supports the interface: Call .

The method is generic to all object types. If the object does not require a shutdown method, ShutdownObject succeeds and has no effect. If you do not know the specific shutdown method for the object (or do not know the object type), call .

After the first call to ActivateObject, subsequent calls return a reference to the same instance, until the client calls either ShutdownObject or .

/// - /// + /// /// ms694292 /// HRESULT IMFActivate::ActivateObject([In] const GUID& riid,[Out] void** ppv) /// IMFActivate::ActivateObject diff --git a/Source/SharpDX.MediaFoundation/CaptureEngine.cs b/Source/SharpDX.MediaFoundation/CaptureEngine.cs index d322cb96f..b4d034a41 100644 --- a/Source/SharpDX.MediaFoundation/CaptureEngine.cs +++ b/Source/SharpDX.MediaFoundation/CaptureEngine.cs @@ -23,7 +23,7 @@ public partial class CaptureEngine /// ///

Before calling this method, call the function.

/// - /// + /// /// hh447848 /// HRESULT IMFCaptureEngineClassFactory::CreateInstance([In] const GUID& clsid,[In] const GUID& riid,[Out] void** ppvObject) /// IMFCaptureEngineClassFactory::CreateInstance @@ -47,7 +47,7 @@ public CaptureEngine(CaptureEngineClassFactory factory) /// ///

You must call this method once before using the capture engine. Calling the method a second time returns .

This method is asynchronous. If the method returns a success code, the caller will receive an MF_CAPTURE_ENGINE_INITIALIZED event through the method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the OnEvent method.

/// - /// + /// /// hh447855 /// HRESULT IMFCaptureEngine::Initialize([In] IMFCaptureEngineOnEventCallback* pEventCallback,[In, Optional] IMFAttributes* pAttributes,[In, Optional] IUnknown* pAudioSource,[In, Optional] IUnknown* pVideoSource) /// IMFCaptureEngine::Initialize diff --git a/Source/SharpDX.MediaFoundation/CapturePhotoConfirmation.cs b/Source/SharpDX.MediaFoundation/CapturePhotoConfirmation.cs index fa951b771..d6df8d072 100644 --- a/Source/SharpDX.MediaFoundation/CapturePhotoConfirmation.cs +++ b/Source/SharpDX.MediaFoundation/CapturePhotoConfirmation.cs @@ -14,7 +14,7 @@ public partial class CapturePhotoConfirmation /// /// No documentation. /// No documentation. - /// + /// /// HRESULT IMFCapturePhotoConfirmation::SetPhotoConfirmationCallback([In] IMFAsyncCallback* pNotificationCallback) /// IMFCapturePhotoConfirmation::SetPhotoConfirmationCallback public IAsyncCallback PhotoConfirmationCallback diff --git a/Source/SharpDX.MediaFoundation/CapturePhotoSink.cs b/Source/SharpDX.MediaFoundation/CapturePhotoSink.cs index 270bd6a79..58461458f 100644 --- a/Source/SharpDX.MediaFoundation/CapturePhotoSink.cs +++ b/Source/SharpDX.MediaFoundation/CapturePhotoSink.cs @@ -17,7 +17,7 @@ public partial class CapturePhotoSink /// ///

Calling this method overrides any previous call to or .

/// - /// + /// /// hh447862 /// HRESULT IMFCapturePhotoSink::SetOutputByteStream([In] IMFByteStream* pByteStream) /// IMFCapturePhotoSink::SetOutputByteStream @@ -37,7 +37,7 @@ public ByteStream OutputByteStream /// ///

Calling this method overrides any previous call to or .

/// - /// + /// /// hh447864 /// HRESULT IMFCapturePhotoSink::SetSampleCallback([In] IMFCaptureEngineOnSampleCallback* pCallback) /// IMFCapturePhotoSink::SetSampleCallback diff --git a/Source/SharpDX.MediaFoundation/CapturePreviewSink.cs b/Source/SharpDX.MediaFoundation/CapturePreviewSink.cs index fb4ad1727..dd9be5038 100644 --- a/Source/SharpDX.MediaFoundation/CapturePreviewSink.cs +++ b/Source/SharpDX.MediaFoundation/CapturePreviewSink.cs @@ -18,7 +18,7 @@ public partial class CapturePreviewSink /// ///

Calling this method overrides any previous call to .

/// - /// + /// /// hh447873 /// HRESULT IMFCapturePreviewSink::SetSampleCallback([In] unsigned int dwStreamSinkIndex,[In] IMFCaptureEngineOnSampleCallback* pCallback) /// IMFCapturePreviewSink::SetSampleCallback diff --git a/Source/SharpDX.MediaFoundation/CaptureRecordSink.cs b/Source/SharpDX.MediaFoundation/CaptureRecordSink.cs index cb68a52b8..9a97e117f 100644 --- a/Source/SharpDX.MediaFoundation/CaptureRecordSink.cs +++ b/Source/SharpDX.MediaFoundation/CaptureRecordSink.cs @@ -18,7 +18,7 @@ public partial class CaptureRecordSink /// ///

Calling this method overrides any previous call to or .

/// - /// + /// /// hh447878 /// HRESULT IMFCaptureRecordSink::SetOutputByteStream([In] IMFByteStream* pByteStream,[In] const GUID& guidContainerType) /// IMFCaptureRecordSink::SetOutputByteStream @@ -36,7 +36,7 @@ public void SetOutputByteStream(ByteStream stream, Guid containerType) /// ///

Calling this method overrides any previous call to or .

/// - /// + /// /// hh447881 /// HRESULT IMFCaptureRecordSink::SetSampleCallback([In] unsigned int dwStreamSinkIndex,[In] IMFCaptureEngineOnSampleCallback* pCallback) /// IMFCaptureRecordSink::SetSampleCallback diff --git a/Source/SharpDX.MediaFoundation/CaptureSink.cs b/Source/SharpDX.MediaFoundation/CaptureSink.cs index 2af43b54d..e0a69f0a0 100644 --- a/Source/SharpDX.MediaFoundation/CaptureSink.cs +++ b/Source/SharpDX.MediaFoundation/CaptureSink.cs @@ -16,7 +16,7 @@ public partial class CaptureSink /// No documentation. /// No documentation. /// No documentation. - /// + /// /// hh447885 /// HRESULT IMFCaptureSink::GetService([In] unsigned int dwSinkStreamIndex,[In] const GUID& rguidService,[In] const GUID& riid,[Out, Optional] IUnknown** ppUnknown) /// IMFCaptureSink::GetService diff --git a/Source/SharpDX.MediaFoundation/ClockStateSink.cs b/Source/SharpDX.MediaFoundation/ClockStateSink.cs index 6f415b046..96507502d 100644 --- a/Source/SharpDX.MediaFoundation/ClockStateSink.cs +++ b/Source/SharpDX.MediaFoundation/ClockStateSink.cs @@ -32,7 +32,7 @@ public partial interface ClockStateSink /// /// When the presentation clock's Pause method is called, the clock notifies the presentation time source by calling the time source's OnClockPause method. This call occurs synchronously within the Pause method. If the time source returns an error from OnClockPause, the presentation clock's Pause method returns an error and the state change does not take place. For any object that is not the presentation time source, the OnClockPause method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored. /// - /// + /// /// HRESULT IMFClockStateSink::OnClockPause([In] longlong hnsSystemTime) void OnClockPause(long hnsSystemTime); @@ -43,7 +43,7 @@ public partial interface ClockStateSink /// /// This method is called if the presentation clock is paused and the Start method is called with the value PRESENTATION_CURRENT_POSITION. The clock notifies the presentation time source by calling the time source's OnClockRestart method. This call occurs synchronously within the Start method. If the time source returns an error from OnClockRestart, the presentation clock's Start method returns an error and the state change does not take place. For any object that is not the presentation time source, the OnClockRestart method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored. /// - /// + /// /// HRESULT IMFClockStateSink::OnClockRestart([In] longlong hnsSystemTime) void OnClockRestart(long hnsSystemTime); @@ -55,7 +55,7 @@ public partial interface ClockStateSink /// /// When the presentation clock's SetRate method is called, the clock notifies the presentation time source by calling the time source's OnClockSetRate method. This call occurs synchronously within the SetRate method. If the time source returns an error from OnClockSetRate, the presentation clock's SetRate method returns an error and the state change does not take place. For any object that is not the presentation time source, the OnClockSetRate method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored. /// - /// + /// /// HRESULT IMFClockStateSink::OnClockSetRate([In] longlong hnsSystemTime,[In] float flRate) void OnClockSetRate(long hnsSystemTime, float flRate); @@ -67,7 +67,7 @@ public partial interface ClockStateSink /// /// This method is called whe the presentation clock's Start method is called, with the following exception: If the clock is paused and Start is called with the value PRESENTATION_CURRENT_POSITION, OnClockRestart is called instead of OnClockStart. The clock notifies the presentation time source by calling the time source's OnClockStart method. This call occurs synchronously within the Start method. If the time source returns an error from OnClockStart, the presentation clock's Start method returns an error and the state change does not take place. For any object that is not the presentation time source, the OnClockStart method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored. The value given in llClockStartOffset is the presentation time when the clock starts, so it is relative to the start of the presentation. Media sinks should not render any data with a presentation time earlier than llClockStartOffSet. If a sample straddles the offset?that is, if the offset falls between the sample's start and stop times?the sink should either trim the sample so that only data after llClockStartOffset is rendered, or else simply drop the sample. /// - /// + /// /// HRESULT IMFClockStateSink::OnClockStart([In] longlong hnsSystemTime,[In] longlong llClockStartOffset) void OnClockStart(long hnsSystemTime, long llClockStartOffset); @@ -78,7 +78,7 @@ public partial interface ClockStateSink /// /// When the presentation clock's Stop method is called, the clock notifies the presentation time source by calling the presentation time source's OnClockStop method. This call occurs synchronously within the Stop method. If the time source returns an error from OnClockStop, the presentation clock's Stop method returns an error and the state change does not take place. For any object that is not the presentation time source, the OnClockStop method is called asynchronously, after the state change is completed. If an object is already stopped, it should return Ok from OnClockStop. It should not return an error code. Note??Although the header file mferror.h defines an error code named MF_E_SINK_ALREADYSTOPPED, it should not be returned in this situation. /// - /// + /// /// HRESULT IMFClockStateSink::OnClockStop([In] longlong hnsSystemTime) void OnClockStop(long hnsSystemTime); } diff --git a/Source/SharpDX.MediaFoundation/IAsyncCallback.cs b/Source/SharpDX.MediaFoundation/IAsyncCallback.cs index 074bbe774..a5369b82a 100644 --- a/Source/SharpDX.MediaFoundation/IAsyncCallback.cs +++ b/Source/SharpDX.MediaFoundation/IAsyncCallback.cs @@ -52,7 +52,7 @@ public partial interface IAsyncCallback /// ///

Within your implementation of Invoke, call the corresponding End... method.

This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:

  • Windows?XP with Service Pack?2 (SP2) and later.
  • Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.
/// - /// + /// /// bb970360 /// HRESULT IMFAsyncCallback::Invoke([In, Optional] IMFAsyncResult* pAsyncResult) /// IMFAsyncCallback::Invoke diff --git a/Source/SharpDX.MediaFoundation/MediaEngine.cs b/Source/SharpDX.MediaFoundation/MediaEngine.cs index d791c46fa..653034a73 100644 --- a/Source/SharpDX.MediaFoundation/MediaEngine.cs +++ b/Source/SharpDX.MediaFoundation/MediaEngine.cs @@ -132,7 +132,7 @@ public void OnPlaybackEvent(MediaEngineEvent mediaEngineEvent, long param1, int /// ///

This method corresponds to setting the src attribute of the HTMLMediaElement interface in HTML5.

The URL specified by this method takes precedence over media resources specified in the method. To load the URL, call .

This method asynchronously loads the URL. When the operation starts, the Media Engine sends an event. If no errors occur during the Load operation, several other events are generated, including the following.

If the Media Engine is unable to load the URL, the Media Engine sends an event.

For more information about event handling in the Media Engine, see .

/// - /// + /// /// hh448017 /// HRESULT IMFMediaEngine::SetSource([In] wchar_t* pUrl) /// IMFMediaEngine::SetSource diff --git a/Source/SharpDX.MediaFoundation/MediaTypeHandler.cs b/Source/SharpDX.MediaFoundation/MediaTypeHandler.cs index 5fb1e234c..ea18ce55e 100644 --- a/Source/SharpDX.MediaFoundation/MediaTypeHandler.cs +++ b/Source/SharpDX.MediaFoundation/MediaTypeHandler.cs @@ -17,7 +17,7 @@ public partial class MediaTypeHandler /// ///

Media types are returned in the approximate order of preference. The list of supported types is not guaranteed to be complete. To test whether a particular media type is supported, call .

This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:

  • Windows?XP with Service Pack?2 (SP2) and later.
  • Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.
/// - /// + /// /// bb970473 /// HRESULT IMFMediaTypeHandler::GetMediaTypeByIndex([In] unsigned int dwIndex,[Out] IMFMediaType** ppType) /// IMFMediaTypeHandler::GetMediaTypeByIndex diff --git a/Source/SharpDX.MediaFoundation/PresentationDescriptor.cs b/Source/SharpDX.MediaFoundation/PresentationDescriptor.cs index 0be99fb6a..0d9cf5632 100644 --- a/Source/SharpDX.MediaFoundation/PresentationDescriptor.cs +++ b/Source/SharpDX.MediaFoundation/PresentationDescriptor.cs @@ -18,7 +18,7 @@ public partial class PresentationDescriptor /// ///

This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:

  • Windows?XP with Service Pack?2 (SP2) and later.
  • Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.
/// - /// + /// /// ms694924 /// HRESULT IMFPresentationDescriptor::GetStreamDescriptorByIndex([In] unsigned int dwIndex,[Out] BOOL* pfSelected,[Out] IMFStreamDescriptor** ppDescriptor) /// IMFPresentationDescriptor::GetStreamDescriptorByIndex diff --git a/Source/SharpDX.MediaFoundation/SampleGrabberSinkCallback.cs b/Source/SharpDX.MediaFoundation/SampleGrabberSinkCallback.cs index 39fb36649..b93de9f9f 100644 --- a/Source/SharpDX.MediaFoundation/SampleGrabberSinkCallback.cs +++ b/Source/SharpDX.MediaFoundation/SampleGrabberSinkCallback.cs @@ -32,7 +32,7 @@ public partial interface SampleGrabberSinkCallback : ClockStateSink /// /// This method is called when the sink's Shutdown method is called. The OnShutdown method should return quickly, or it might interfere with playback. Do not block the thread, wait on events, or perform other lengthy operations inside this method. /// - /// + /// /// HRESULT IMFSampleGrabberSinkCallback::OnShutdown() void OnShutdown(); @@ -43,7 +43,7 @@ public partial interface SampleGrabberSinkCallback : ClockStateSink /// /// This method should return quickly, or it might interfere with playback. Do not block the thread, wait on events, or perform other lengthy operations inside this method. /// - /// + /// /// HRESULT IMFSampleGrabberSinkCallback::OnSetPresentationClock([In] IMFPresentationClock* pPresentationClock) void OnSetPresentationClock(PresentationClock presentationClockRef); @@ -59,7 +59,7 @@ public partial interface SampleGrabberSinkCallback : ClockStateSink /// /// If you use the sample-grabber sink in a playback topology, this method should return quickly, or it might interfere with playback. Do not block the thread, wait on events, or perform other lengthy operations inside this method. /// - /// + /// /// HRESULT IMFSampleGrabberSinkCallback::OnProcessSample([In] const GUID& guidMajorMediaType,[In] unsigned int dwSampleFlags,[In] longlong llSampleTime,[In] longlong llSampleDuration,[In, Buffer] const unsigned char* pSampleBuffer,[In] unsigned int dwSampleSize) void OnProcessSample(Guid guidMajorMediaType, int dwSampleFlags, long llSampleTime, long llSampleDuration, IntPtr pSampleBuffer, int dwSampleSize); } diff --git a/Source/SharpDX.MediaFoundation/SourceReader.cs b/Source/SharpDX.MediaFoundation/SourceReader.cs index ac25437a1..475c2340b 100644 --- a/Source/SharpDX.MediaFoundation/SourceReader.cs +++ b/Source/SharpDX.MediaFoundation/SourceReader.cs @@ -264,7 +264,7 @@ public SharpDX.MediaFoundation.Sample ReadSample(SourceReaderIndex dwStreamIndex /// ///

The Flush method discards all queued samples and cancels all pending sample requests.

This method can complete either synchronously or asynchronously. If you provide a callback reference when you create the source reader, the method is asynchronous. Otherwise, the method is synchronous. For more information about the setting the callback reference, see .

In synchronous mode, the method blocks until the operation is complete.

In asynchronous mode, the application's method is called when the flush operation completes. While a flush operation is pending, the method returns MF_E_NOTACCEPTING.

Note??In Windows?7, there was a bug in the implementation of this method, which causes OnFlush to be called before the flush operation completes. A hotfix is available that fixes this bug. For more information, see http://support.microsoft.com/kb/979567.

This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.

/// - /// + /// /// dd374659 /// HRESULT IMFSourceReader::Flush([In] unsigned int dwStreamIndex) /// IMFSourceReader::Flush diff --git a/Source/SharpDX.MediaFoundation/VideoPresenter.cs b/Source/SharpDX.MediaFoundation/VideoPresenter.cs index ffec4db46..e7de0c2e0 100644 --- a/Source/SharpDX.MediaFoundation/VideoPresenter.cs +++ b/Source/SharpDX.MediaFoundation/VideoPresenter.cs @@ -31,7 +31,7 @@ public partial interface VideoPresenter : ClockStateSink /// Retrieves the presenter's media type. /// /// Receives a pointer to the IMFVideoMediaType interface. The caller must release the interface. - /// + /// /// HRESULT IMFVideoPresenter::GetCurrentMediaType([out] IMFVideoMediaType **ppMediaType VideoMediaType CurrentMediaType { get; } @@ -40,7 +40,7 @@ public partial interface VideoPresenter : ClockStateSink /// /// Specifies the message as a member of the VpMessageType enumeration. /// Message parameter. The meaning of this parameter depends on the message type. - /// + /// /// HRESULT IMFVideoPresenter::ProcessMessage([In] MFVP_MESSAGE_TYPE eMessage,[In] ULONG_PTR ulParam) void ProcessMessage(VpMessageType eMessage, IntPtr ulParam); } diff --git a/Source/SharpDX.XAudio2/DeviceDetails.cs b/Source/SharpDX.XAudio2/DeviceDetails.cs index a1bd5d9d8..56c98c6a5 100644 --- a/Source/SharpDX.XAudio2/DeviceDetails.cs +++ b/Source/SharpDX.XAudio2/DeviceDetails.cs @@ -27,7 +27,7 @@ namespace SharpDX.XAudio2 /// /// Device role, only valid for XAudio27. /// - /// + /// /// XAUDIO2_DEVICE_ROLE /// XAUDIO2_DEVICE_ROLE public enum DeviceRole @@ -35,49 +35,49 @@ public enum DeviceRole /// /// No documentation. /// - /// + /// /// NotDefaultDevice /// NotDefaultDevice NotDefaultDevice, /// /// No documentation. /// - /// + /// /// DefaultConsoleDevice /// DefaultConsoleDevice DefaultConsoleDevice, /// /// No documentation. /// - /// + /// /// DefaultMultimediaDevice /// DefaultMultimediaDevice DefaultMultimediaDevice, /// /// No documentation. /// - /// + /// /// DefaultCommunicationsDevice /// DefaultCommunicationsDevice DefaultCommunicationsDevice = 4, /// /// No documentation. /// - /// + /// /// DefaultGameDevice /// DefaultGameDevice DefaultGameDevice = 8, /// /// No documentation. /// - /// + /// /// GlobalDefaultDevice /// GlobalDefaultDevice GlobalDefaultDevice = 15, /// /// No documentation. /// - /// + /// /// InvalidDeviceRole /// InvalidDeviceRole InvalidDeviceRole = -16 @@ -86,7 +86,7 @@ public enum DeviceRole /// /// Details of the device, only valid for XAudio27. /// - /// + /// /// XAUDIO2_DEVICE_DETAILS /// XAUDIO2_DEVICE_DETAILS public struct DeviceDetails @@ -616,28 +616,28 @@ internal void __MarshalFree() /// /// No documentation. /// - /// + /// /// wchar_t DeviceID[256] /// wchar_t DeviceID public string DeviceID; /// /// No documentation. /// - /// + /// /// wchar_t DisplayName[256] /// wchar_t DisplayName public string DisplayName; /// /// No documentation. /// - /// + /// /// XAUDIO2_DEVICE_ROLE Role /// XAUDIO2_DEVICE_ROLE Role public DeviceRole Role; /// /// No documentation. /// - /// + /// /// WAVEFORMATEXTENSIBLE OutputFormat /// WAVEFORMATEXTENSIBLE OutputFormat public WaveFormatExtensible OutputFormat; diff --git a/Source/SharpDX.XAudio2/MasteringVoice.cs b/Source/SharpDX.XAudio2/MasteringVoice.cs index e231b8c0b..b553abfef 100644 --- a/Source/SharpDX.XAudio2/MasteringVoice.cs +++ b/Source/SharpDX.XAudio2/MasteringVoice.cs @@ -81,7 +81,7 @@ public MasteringVoice(XAudio2 device, int inputChannels, int inputSampleRate, in /// ///

The pChannelMask argument is a bit-mask of the various channels in the speaker geometry reported by the audio system. This information is needed for the SpeakerChannelMask parameter.

The X3DAUDIO.H header declares a number of SPEAKER_ positional defines to decode these channels masks.

Examples include: 

 //  (0x1) |  (0x2)   //  (0x1) |  (0x2) // |  (0x4) // |  (0x8) // |  (0x10) |  (0x20)

Note??For the DirectX SDK versions of XAUDIO, the channel mask for the output device was obtained via the IXAudio2::GetDeviceDetails method, which doesn't exist in Windows?8 and later.

/// - /// + /// /// microsoft.directx_sdk.ixaudio2masteringvoice.ixaudio2masteringvoice.getchannelmask /// GetChannelMask /// GetChannelMask diff --git a/Source/SharpDX.XAudio2/SourceVoice.cs b/Source/SharpDX.XAudio2/SourceVoice.cs index 85bf77c66..dd1bb27e3 100644 --- a/Source/SharpDX.XAudio2/SourceVoice.cs +++ b/Source/SharpDX.XAudio2/SourceVoice.cs @@ -252,7 +252,7 @@ public void Stop(int operationSet) /// No documentation. /// No documentation. /// No documentation. - /// + /// /// HRESULT IXAudio2SourceVoice::SubmitSourceBuffer([In] const XAUDIO2_BUFFER* pBuffer,[In, Optional] const XAUDIO2_BUFFER_WMA* pBufferWMA) public void SubmitSourceBuffer(SharpDX.XAudio2.AudioBuffer bufferRef, uint[] decodedXMWAPacketInfo) { diff --git a/Source/SharpDX.XAudio2/SubmixVoiceFlags.cs b/Source/SharpDX.XAudio2/SubmixVoiceFlags.cs index c20eeb52a..a7f19866b 100644 --- a/Source/SharpDX.XAudio2/SubmixVoiceFlags.cs +++ b/Source/SharpDX.XAudio2/SubmixVoiceFlags.cs @@ -24,7 +24,7 @@ namespace SharpDX.XAudio2 /// /// No documentation. /// - /// + /// [Flags] public enum SubmixVoiceFlags : int { @@ -32,7 +32,7 @@ public enum SubmixVoiceFlags : int /// /// No documentation. /// - /// + /// /// XAUDIO2_VOICE_USEFILTER /// XAUDIO2_VOICE_USEFILTER UseFilter = VoiceFlags.UseFilter, @@ -40,7 +40,7 @@ public enum SubmixVoiceFlags : int /// /// None. /// - /// + /// /// None /// None None = VoiceFlags.None, diff --git a/Source/SharpDX.XAudio2/Voice.cs b/Source/SharpDX.XAudio2/Voice.cs index 8ca473d0c..5889b155f 100644 --- a/Source/SharpDX.XAudio2/Voice.cs +++ b/Source/SharpDX.XAudio2/Voice.cs @@ -33,7 +33,7 @@ protected Voice(XAudio2 device) : base(IntPtr.Zero) /// ///

Returns information about the creation flags, input channels, and sample rate of a voice.

/// - /// + /// /// microsoft.directx_sdk.ixaudio2voice.ixaudio2voice.getvoicedetails /// GetVoiceDetails /// GetVoiceDetails diff --git a/Source/SharpDX.XAudio2/X3DAudio/X3DAudio17.cs b/Source/SharpDX.XAudio2/X3DAudio/X3DAudio17.cs index 49626fa84..687b79e1f 100644 --- a/Source/SharpDX.XAudio2/X3DAudio/X3DAudio17.cs +++ b/Source/SharpDX.XAudio2/X3DAudio/X3DAudio17.cs @@ -41,7 +41,7 @@ namespace SharpDX.X3DAudio { /// /// Functions /// - /// + /// internal class X3DAudio17 { /// @@ -55,7 +55,7 @@ internal class X3DAudio17 { /// ///

You typically call once for each pair of emitting objects and listeners in the scene. After each call, to apply the 3D effects, the app manually applies the calculation results at pDSPSettings to the XAUDIO2 graph. For more info, see How to: Integrate X3DAudio with XAudio2.

Important?? The listener and emitter values must be valid. Floating-point specials (NaN, QNaN, +INF, -INF) can cause the entire audio output to go silent if introduced into a running audio graph.

/// - /// + /// /// microsoft.directx_sdk.x3daudio.x3daudiocalculate /// void X3DAudioCalculate([In] const X3DAUDIOHANDLE* Instance,[In] const X3DAUDIO_LISTENER* pListener,[In] const X3DAUDIO_EMITTER* pEmitter,[In] X3DAudioCalculateFlags Flags,[In] void* pDSPSettings) /// X3DAudioCalculate @@ -84,7 +84,7 @@ public static void X3DAudioCalculate(ref SharpDX.X3DAudio.X3DAudioHandle instanc /// ///

X3DAUDIO_HANDLE is an opaque data structure. Because the operating system doesn't allocate any additional storage for the 3D audio instance handle, you don't need to free or close it.

/// - /// + /// /// microsoft.directx_sdk.x3daudio.x3daudioinitialize /// HRESULT X3DAudioInitialize([In] SPEAKER_FLAGS SpeakerChannelMask,[In] float SpeedOfSound,[Out] X3DAUDIOHANDLE* Instance) /// X3DAudioInitialize diff --git a/Source/SharpDX.XAudio2/X3DAudio/X3DAudio28.cs b/Source/SharpDX.XAudio2/X3DAudio/X3DAudio28.cs index 9d9d3d1fc..bdbfcbad2 100644 --- a/Source/SharpDX.XAudio2/X3DAudio/X3DAudio28.cs +++ b/Source/SharpDX.XAudio2/X3DAudio/X3DAudio28.cs @@ -40,7 +40,7 @@ namespace SharpDX.X3DAudio { /// /// Functions /// - /// + /// internal class X3DAudio28 { /// @@ -54,7 +54,7 @@ internal class X3DAudio28 { /// ///

You typically call once for each pair of emitting objects and listeners in the scene. After each call, to apply the 3D effects, the app manually applies the calculation results at pDSPSettings to the XAUDIO2 graph. For more info, see How to: Integrate X3DAudio with XAudio2.

Important?? The listener and emitter values must be valid. Floating-point specials (NaN, QNaN, +INF, -INF) can cause the entire audio output to go silent if introduced into a running audio graph.

/// - /// + /// /// microsoft.directx_sdk.x3daudio.x3daudiocalculate /// void X3DAudioCalculate([In] const X3DAUDIOHANDLE* Instance,[In] const X3DAUDIO_LISTENER* pListener,[In] const X3DAUDIO_EMITTER* pEmitter,[In] X3DAudioCalculateFlags Flags,[In] void* pDSPSettings) /// X3DAudioCalculate @@ -83,7 +83,7 @@ public static void X3DAudioCalculate(ref SharpDX.X3DAudio.X3DAudioHandle instanc /// ///

X3DAUDIO_HANDLE is an opaque data structure. Because the operating system doesn't allocate any additional storage for the 3D audio instance handle, you don't need to free or close it.

/// - /// + /// /// microsoft.directx_sdk.x3daudio.x3daudioinitialize /// HRESULT X3DAudioInitialize([In] SPEAKER_FLAGS SpeakerChannelMask,[In] float SpeedOfSound,[Out] X3DAUDIOHANDLE* Instance) /// X3DAudioInitialize diff --git a/Source/SharpDX.XAudio2/XAudio2.cs b/Source/SharpDX.XAudio2/XAudio2.cs index 97f59d60e..a3ce277fa 100644 --- a/Source/SharpDX.XAudio2/XAudio2.cs +++ b/Source/SharpDX.XAudio2/XAudio2.cs @@ -177,7 +177,7 @@ private void CheckVersion27() /// /// No documentation. /// - /// + /// /// GetDeviceCount /// GetDeviceCount /// HRESULT IXAudio2::GetDeviceCount([Out] unsigned int* pCount) @@ -197,7 +197,7 @@ public int DeviceCount /// /// No documentation. /// No documentation. - /// + /// /// HRESULT IXAudio2::GetDeviceCount([Out] unsigned int* pCount) /// IXAudio2::GetDeviceCount private unsafe void GetDeviceCount(out int countRef) diff --git a/Source/SharpDX.XAudio2/XAudio28Functions.cs b/Source/SharpDX.XAudio2/XAudio28Functions.cs index c1fe4ac87..4f51cbc3b 100644 --- a/Source/SharpDX.XAudio2/XAudio28Functions.cs +++ b/Source/SharpDX.XAudio2/XAudio28Functions.cs @@ -6,7 +6,7 @@ namespace SharpDX.XAudio2 /// /// Functions /// - /// + /// static partial class XAudio28Functions { /// @@ -19,7 +19,7 @@ static partial class XAudio28Functions { /// ///

The DirectX SDK versions of XAUDIO2 supported a flag to select between the release and 'checked' version. This flag is not supported or defined in the Windows 8 version of XAUDIO2.

Note??No versions of the DirectX SDK contain the xaudio2.lib import library. DirectX SDK versions use COM to create a new XAudio2 object.

/// - /// + /// /// microsoft.directx_sdk.xaudio2.xaudio2create /// HRESULT XAudio2Create([Out, Fast] IXAudio2** ppXAudio2,[In] unsigned int Flags,[In] unsigned int XAudio2Processor) /// XAudio2Create @@ -58,7 +58,7 @@ public static void XAudio2Create(SharpDX.XAudio2.XAudio2 xAudio2Out, int flags, /// } /// /// - /// + /// /// microsoft.directx_sdk.xaudio2.xaudio2createreverb /// HRESULT CreateAudioReverb([Out, Fast] IUnknown** ppApo) /// CreateAudioReverb @@ -97,7 +97,7 @@ public static void CreateAudioReverb(SharpDX.ComObject apoOut) { /// } /// /// - /// + /// /// microsoft.directx_sdk.xaudio2.xaudio2createvolumemeter /// HRESULT CreateAudioVolumeMeter([Out, Fast] IUnknown** ppApo) /// CreateAudioVolumeMeter diff --git a/Source/SharpDX.XInput/XInput13.cs b/Source/SharpDX.XInput/XInput13.cs index 2eca978d8..17ca5ce4f 100644 --- a/Source/SharpDX.XInput/XInput13.cs +++ b/Source/SharpDX.XInput/XInput13.cs @@ -28,7 +28,7 @@ namespace SharpDX.XInput /// /// Functions /// - /// + /// internal class XInput13 : IXInput { public int XInputSetState(int dwUserIndex, Vibration vibrationRef)