GtkSharp/doc/en/Art/SVP.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

371 lines
14 KiB
XML

<Type Name="SVP" FullName="Art.SVP">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct SVP" />
<AssemblyInfo>
<AssemblyName>art-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Sorted Vector Path</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Art.SVP Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Art.SVP New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FromVpath">
<MemberSignature Language="C#" Value="public static Art.SVP FromVpath (Art.Vpath vpath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="vpath" Type="Art.Vpath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="vpath">a <see cref="T:Art.Vpath" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="VpathStrokeRaw">
<MemberSignature Language="C#" Value="public static Art.Vpath VpathStrokeRaw (Art.Vpath vpath, Art.PathStrokeJoinType join, Art.PathStrokeCapType cap, double line_width, double miter_limit, double flatness);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.Vpath</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="vpath" Type="Art.Vpath" />
<Parameter Name="join" Type="Art.PathStrokeJoinType" />
<Parameter Name="cap" Type="Art.PathStrokeCapType" />
<Parameter Name="line_width" Type="System.Double" />
<Parameter Name="miter_limit" Type="System.Double" />
<Parameter Name="flatness" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="vpath">a <see cref="T:Art.Vpath" /></param>
<param name="join">a <see cref="T:Art.PathStrokeJoinType" /></param>
<param name="cap">a <see cref="T:Art.PathStrokeCapType" /></param>
<param name="line_width">a <see cref="T:System.Double" /></param>
<param name="miter_limit">a <see cref="T:System.Double" /></param>
<param name="flatness">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Art.Vpath" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="VpathStroke">
<MemberSignature Language="C#" Value="public static Art.SVP VpathStroke (Art.Vpath vpath, Art.PathStrokeJoinType join, Art.PathStrokeCapType cap, double line_width, double miter_limit, double flatness);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="vpath" Type="Art.Vpath" />
<Parameter Name="join" Type="Art.PathStrokeJoinType" />
<Parameter Name="cap" Type="Art.PathStrokeCapType" />
<Parameter Name="line_width" Type="System.Double" />
<Parameter Name="miter_limit" Type="System.Double" />
<Parameter Name="flatness" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="vpath">a <see cref="T:Art.Vpath" /></param>
<param name="join">a <see cref="T:Art.PathStrokeJoinType" /></param>
<param name="cap">a <see cref="T:Art.PathStrokeCapType" /></param>
<param name="line_width">a <see cref="T:System.Double" /></param>
<param name="miter_limit">a <see cref="T:System.Double" /></param>
<param name="flatness">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PointWind">
<MemberSignature Language="C#" Value="public int PointWind (double x, double y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">a <see cref="T:System.Double" /></param>
<param name="y">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Uncross">
<MemberSignature Language="C#" Value="public Art.SVP Uncross ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PointDist">
<MemberSignature Language="C#" Value="public double PointDist (double x, double y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">a <see cref="T:System.Double" /></param>
<param name="y">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Minus">
<MemberSignature Language="C#" Value="public Art.SVP Minus (Art.SVP svp2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="svp2" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="svp2">a <see cref="T:Art.SVP" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Union">
<MemberSignature Language="C#" Value="public Art.SVP Union (Art.SVP svp2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="svp2" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="svp2">a <see cref="T:Art.SVP" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Intersect">
<MemberSignature Language="C#" Value="public Art.SVP Intersect (Art.SVP svp2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="svp2" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="svp2">a <see cref="T:Art.SVP" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Diff">
<MemberSignature Language="C#" Value="public Art.SVP Diff (Art.SVP svp2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="svp2" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="svp2">a <see cref="T:Art.SVP" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RenderAaIter">
<MemberSignature Language="C#" Value="public Art.SVPRenderAAIter RenderAaIter (int x0, int y0, int x1, int y1);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVPRenderAAIter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x0" Type="System.Int32" />
<Parameter Name="y0" Type="System.Int32" />
<Parameter Name="x1" Type="System.Int32" />
<Parameter Name="y1" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x0">a <see cref="T:System.Int32" /></param>
<param name="y0">a <see cref="T:System.Int32" /></param>
<param name="x1">a <see cref="T:System.Int32" /></param>
<param name="y1">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Art.SVPRenderAAIter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Intersector">
<MemberSignature Language="C#" Value="public void Intersector (Art.SvpWriter out_param);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="out_param" Type="Art.SvpWriter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="out_param">a <see cref="T:Art.SvpWriter" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public void Free ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RewindUncrossed">
<MemberSignature Language="C#" Value="public Art.SVP RewindUncrossed (Art.WindRule rule);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.SVP</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="rule" Type="Art.WindRule" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="rule">a <see cref="T:Art.WindRule" /></param>
<returns>a <see cref="T:Art.SVP" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RenderAa">
<MemberSignature Language="C#" Value="public void RenderAa (int x0, int y0, int x1, int y1, Art.RenderAaCallback cb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x0" Type="System.Int32" />
<Parameter Name="y0" Type="System.Int32" />
<Parameter Name="x1" Type="System.Int32" />
<Parameter Name="y1" Type="System.Int32" />
<Parameter Name="cb" Type="Art.RenderAaCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x0">a <see cref="T:System.Int32" /></param>
<param name="y0">a <see cref="T:System.Int32" /></param>
<param name="x1">a <see cref="T:System.Int32" /></param>
<param name="y1">a <see cref="T:System.Int32" /></param>
<param name="cb">a <see cref="T:Art.RenderAaCallback" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AddSegment">
<MemberSignature Language="C#" Value="public int AddSegment (out int pn_segs_max, out int pn_points_max, int n_points, int dir, Art.Point points, Art.DRect bbox);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pn_segs_max" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="pn_points_max" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="n_points" Type="System.Int32" />
<Parameter Name="dir" Type="System.Int32" />
<Parameter Name="points" Type="Art.Point" />
<Parameter Name="bbox" Type="Art.DRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pn_segs_max">a <see cref="T:System.Int32&amp;" /></param>
<param name="pn_points_max">a <see cref="T:System.Int32&amp;" /></param>
<param name="n_points">a <see cref="T:System.Int32" /></param>
<param name="dir">a <see cref="T:System.Int32" /></param>
<param name="points">a <see cref="T:Art.Point" /></param>
<param name="bbox">a <see cref="T:Art.DRect" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NSegs">
<MemberSignature Language="C#" Value="public int NSegs;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Segs">
<MemberSignature Language="C#" Value="public Art.SVPSeg[] Segs;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Art.SVPSeg[]</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>