Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Mar 30, 2019. It is now read-only.
/SharpDXPublic archive

Commitbe1c541

Browse files
authored
Merge pull request#884 from mrvux/codecomments
Codecomments
2 parents5bb955f +80b7e64 commitbe1c541

File tree

58 files changed

+168
-137
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+168
-137
lines changed

‎Source/SharpDX.Animation/PriorityComparison.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ internal partial interface PriorityComparison
3030
/// <param name="newStoryboard">No documentation.</param>
3131
/// <param name="priorityEffect">No documentation.</param>
3232
/// <returns>No documentation.</returns>
33-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IUIAnimationPriorityComparison::HasPriority']/*"/>
33+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IUIAnimationPriorityComparison::HasPriority']/*"/>
3434
/// <unmanaged>HRESULT IUIAnimationPriorityComparison::HasPriority([In] IUIAnimationStoryboard* scheduledStoryboard,[In] IUIAnimationStoryboard* newStoryboard,[In] UI_ANIMATION_PRIORITY_EFFECT priorityEffect)</unmanaged>
3535
boolHasPriority(SharpDX.Animation.StoryboardscheduledStoryboard,SharpDX.Animation.StoryboardnewStoryboard,SharpDX.Animation.PriorityEffectpriorityEffect);
3636
}

‎Source/SharpDX.Animation/Storyboard.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public Storyboard(Manager manager)
3535
manager.CreateStoryboard(this);
3636
}
3737

38-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IUIAnimationStoryboard::RepeatBetweenKeyframes']/*"/>
38+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IUIAnimationStoryboard::RepeatBetweenKeyframes']/*"/>
3939
/// <unmanaged>HRESULT IUIAnimationStoryboard::RepeatBetweenKeyframes([In] __MIDL___MIDL_itf_UIAnimation_0000_0002_0003* startKeyframe,[In] __MIDL___MIDL_itf_UIAnimation_0000_0002_0003* endKeyframe,[In] int repetitionCount)</unmanaged>
4040
publicvoidRepeatBetweenKeyframes(SharpDX.Animation.KeyFramestartKeyframe,SharpDX.Animation.KeyFrameendKeyframe,RepeatCountrepetitionCount)
4141
{

‎Source/SharpDX.D3DCompiler/FunctionReflection.cs‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ public FunctionParameterReflection[] Parameters
5858
}
5959
}
6060

61+
/// <summary>
62+
/// Returns reflection for function return parameter
63+
/// </summary>
64+
/// <exception cref="System.ArgumentException">Thrown if function has no return value (void)</exception>
6165
publicFunctionParameterReflectionReturnParameter
6266
{
6367
get
@@ -74,11 +78,11 @@ public FunctionParameterReflection ReturnParameter
7478
/// <p>Gets a description of how a resource is bound to a function. </p>
7579
/// </summary>
7680
/// <param name="resourceIndex"><dd> <p>A zero-based resource index.</p> </dd></param>
77-
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p> </dd></returns>
81+
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p></returns>
7882
/// <remarks>
7983
/// <p>A shader consists of executable code (the compiled HLSL functions) and a set of resources that supply the shader with input data. <strong>GetResourceBindingDesc</strong> gets info about how one resource in the set is bound as an input to the shader. The <em>ResourceIndex</em> parameter specifies the index for the resource.</p>
8084
/// </remarks>
81-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
85+
/// <include file='..\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
8286
/// <msdn-id>dn280551</msdn-id>
8387
/// <unmanaged>HRESULT ID3D11FunctionReflection::GetResourceBindingDesc([In] unsigned int ResourceIndex,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc)</unmanaged>
8488
/// <unmanaged-short>ID3D11FunctionReflection::GetResourceBindingDesc</unmanaged-short>
@@ -93,11 +97,11 @@ public InputBindingDescription GetResourceBindingDescription(int index)
9397
/// <p>Gets a description of how a resource is bound to a function. </p>
9498
/// </summary>
9599
/// <param name="name"><dd> <p>Resource name.</p> </dd></param>
96-
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p> </dd></returns>
100+
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p></returns>
97101
/// <remarks>
98102
/// <p>A shader consists of executable code (the compiled HLSL functions) and a set of resources that supply the shader with input data. <strong>GetResourceBindingDesc</strong> gets info about how one resource in the set is bound as an input to the shader. The <em>ResourceIndex</em> parameter specifies the index for the resource.</p>
99103
/// </remarks>
100-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
104+
/// <include file='..\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
101105
/// <msdn-id>dn280551</msdn-id>
102106
/// <unmanaged>HRESULT ID3D11FunctionReflection::GetResourceBindingDesc([In] unsigned int ResourceIndex,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc)</unmanaged>
103107
/// <unmanaged-short>ID3D11FunctionReflection::GetResourceBindingDesc</unmanaged-short>

‎Source/SharpDX.D3DCompiler/ShaderBytecode.cs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -957,6 +957,10 @@ internal static ShaderMacro[] PrepareMacros(ShaderMacro[] macros)
957957
returnmacroArray;
958958
}
959959

960+
/// <summary>
961+
/// Disposes all resource for the allocated object
962+
/// </summary>
963+
/// <remarks>This is kept for backwards compatibility only, this actually does nothing in that case</remarks>
960964
publicvoidDispose()
961965
{
962966
// Just to keep backward compatibility
@@ -965,9 +969,7 @@ public void Dispose()
965969
/// <summary>
966970
/// Gets the shader type and version string from the provided bytecode.
967971
/// </summary>
968-
/// <param name="shaderBytecode">The shader bytecode data.</param>
969972
/// <returns>The type and version string of the provided shader bytecode.</returns>
970-
/// <exception cref="ArgumentNullException">Is thrown when <paramref name="shaderBytecode"/> is null.</exception>
971973
/// <exception cref="ArgumentException">Is thrown when bytecode contains invalid data or the version could not be read.</exception>
972974
/// <exception cref="IndexOutOfRangeException">Is thrown when bytecode contains invalid data.</exception>
973975
publicShaderProfileGetVersion()

‎Source/SharpDX.DXGI/SwapChain.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public T GetBackBuffer<T>(int index) where T : ComObject
6767
/// <remarks>
6868
/// <p>You cannot use <strong>GetFrameStatistics</strong> for swap chains that both use the bit-block transfer (bitblt) presentation model and draw in windowed mode.</p><p>You can only use <strong>GetFrameStatistics</strong> for swap chains that either use the flip presentation model or draw in full-screen mode. You set the <strong><see cref="SharpDX.DXGI.SwapEffect.FlipSequential"/></strong> value in the <strong>SwapEffect</strong> member of the <strong><see cref="SharpDX.DXGI.SwapChainDescription1"/></strong> structure to specify that the swap chain uses the flip presentation model.</p>
6969
/// </remarks>
70-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IDXGISwapChain::GetFrameStatistics']/*"/>
70+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IDXGISwapChain::GetFrameStatistics']/*"/>
7171
/// <msdn-id>bb174573</msdn-id>
7272
/// <unmanaged>GetFrameStatistics</unmanaged>
7373
/// <unmanaged-short>GetFrameStatistics</unmanaged-short>
@@ -119,7 +119,7 @@ public bool IsFullScreen
119119
/// <remarks>
120120
/// <p>Starting with Direct3D 11.1, we recommend to instead use <strong><see cref="SharpDX.DXGI.SwapChain1.Present1"/></strong> 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.</p><p>For the best performance when flipping swap-chain buffers in a full-screen application, see Full-Screen Application Performance Hints.</p><p>Because calling <strong>Present</strong> 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.</p><table> <tr><td> <p>Differences between Direct3D 9 and Direct3D 10:</p> <p>Specifying <strong><see cref="SharpDX.DXGI.PresentFlags.Test"/></strong> in the <em>Flags</em> parameter is analogous to <strong>IDirect3DDevice9::TestCooperativeLevel</strong> in Direct3D 9.</p> </td></tr> </table><p>?</p><p>For flip presentation model swap chains that you create with the <strong><see cref="SharpDX.DXGI.SwapEffect.FlipSequential"/></strong> value set, a successful presentation unbinds back buffer 0 from the graphics pipeline, except for when you pass the <strong><see cref="SharpDX.DXGI.PresentFlags.DoNotSequence"/></strong> flag in the <em>Flags</em> parameter.</p><p>For info about how data values change when you present content to the screen, see Converting data for the color space.</p>
121121
/// </remarks>
122-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IDXGISwapChain::Present']/*"/>
122+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IDXGISwapChain::Present']/*"/>
123123
/// <msdn-id>bb174576</msdn-id>
124124
/// <unmanaged>HRESULT IDXGISwapChain::Present([In] unsigned int SyncInterval,[In] DXGI_PRESENT_FLAGS Flags)</unmanaged>
125125
/// <unmanaged-short>IDXGISwapChain::Present</unmanaged-short>

‎Source/SharpDX.DXGI/SwapChain1.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public SwapChain1(Factory2 factory, ComObject device, ref SwapChainDescription1
7777
/// <remarks>
7878
/// 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 <see cref="SharpDX.DXGI.SwapEffect.FlipSequential"/> value set, a successful presentation results in an unbind of back buffer 0 from the graphics pipeline, except for when you pass the <see cref="SharpDX.DXGI.PresentFlags.DoNotSequence"/> 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.
7979
/// </remarks>
80-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IDXGISwapChain1::Present1']/*"/>
80+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IDXGISwapChain1::Present1']/*"/>
8181
/// <unmanaged>HRESULT IDXGISwapChain1::Present1([In] unsigned int SyncInterval,[In] unsigned int PresentFlags,[In] const void* pPresentParameters)</unmanaged>
8282
publicunsafeResultPresent(intsyncInterval,PresentFlagspresentFlags,PresentParameterspresentParameters)
8383
{

‎Source/SharpDX.DXGI/SwapChain2.cs‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ public partial class SwapChain2
2424
/// <summary>
2525
/// <p>[This documentation is preliminary and is subject to change.]</p><p>Gets the source region used for the swap chain.</p><p>Use <strong>GetSourceSize</strong> 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 <strong>SetSourceSize</strong> to set this portion of the swap chain. </p>
2626
/// </summary>
27-
/// <param name="widthRef">No documentation.</param>
28-
/// <param name="heightRef">No documentation.</param>
2927
/// <returns><p> This method can return error codes that are described in the DXGI_ERROR topic.</p></returns>
3028
/// <include file='.\Documentation\CodeComments.xml' path="/comments/comment[@id='IDXGISwapChain2::GetSourceSize']/*"/>
3129
/// <msdn-id>dn280408</msdn-id>

‎Source/SharpDX.Direct2D1/DirectWrite/BitmapRenderTarget.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public partial class BitmapRenderTarget
4343
/// }
4444
/// </pre><p>The <em>baselineOriginX</em>, <em>baslineOriginY</em>, <em>measuringMethod</em>, and <em>glyphRun</em> parameters are provided (as arguments) when the callback method is invoked. The <em>renderingParams</em>, <em>textColor</em> and <em>blackBoxRect</em> are not.</p><p>Default rendering params can be retrieved by using the <strong><see cref="SharpDX.DirectWrite.Factory.CreateMonitorRenderingParams"/></strong> method.</p><p></p>
4545
/// </remarks>
46-
/// <include file='..\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IDWriteBitmapRenderTarget::DrawGlyphRun']/*"/>
46+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IDWriteBitmapRenderTarget::DrawGlyphRun']/*"/>
4747
/// <msdn-id>dd368167</msdn-id>
4848
/// <unmanaged>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)</unmanaged>
4949
/// <unmanaged-short>IDWriteBitmapRenderTarget::DrawGlyphRun</unmanaged-short>

‎Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSink1.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public partial interface TextAnalysisSink1
3535
/// <param name="isSideways"><dd> <p>Whether the glyphs are rotated on their side, which is the default case for CJK and the case stacked Latin</p> </dd></param>
3636
/// <param name="isRightToLeft"><dd> <p>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.</p> </dd></param>
3737
/// <returns><p>Returns a successful code or an error code to abort analysis.</p></returns>
38-
/// <include file='..\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IDWriteTextAnalysisSink1::SetGlyphOrientation']/*"/>
38+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IDWriteTextAnalysisSink1::SetGlyphOrientation']/*"/>
3939
/// <msdn-id>Hh780425</msdn-id>
4040
/// <unmanaged>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)</unmanaged>
4141
/// <unmanaged-short>IDWriteTextAnalysisSink1::SetGlyphOrientation</unmanaged-short>

‎Source/SharpDX.Direct2D1/DirectWrite/TextAnalysisSource1.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public partial interface TextAnalysisSource1
3535
/// <remarks>
3636
/// <p>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.</p>
3737
/// </remarks>
38-
/// <include file='..\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IDWriteTextAnalysisSource1::GetVerticalGlyphOrientation']/*"/>
38+
/// <include file='Documentation\CodeComments.xml' path="/comments/comment[@id='IDWriteTextAnalysisSource1::GetVerticalGlyphOrientation']/*"/>
3939
/// <msdn-id>Hh780427</msdn-id>
4040
/// <unmanaged>HRESULT IDWriteTextAnalysisSource1::GetVerticalGlyphOrientation([In] unsigned int textPosition,[Out] unsigned int* textLength,[Out] DWRITE_VERTICAL_GLYPH_ORIENTATION* glyphOrientation,[Out] unsigned char* bidiLevel)</unmanaged>
4141
/// <unmanaged-short>IDWriteTextAnalysisSource1::GetVerticalGlyphOrientation</unmanaged-short>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp