~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreImage/CIContext.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
ImportĀ upstreamĀ versionĀ 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
        various Draw methods, into a CoreVideo CVPixelBuffer or into a CoreGraphics context.
29
29
      </para>
30
30
    </remarks>
 
31
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=e2a0ccca-ab10-4e41-9c09-11831a8c1380">coreimage</related>
31
32
  </Docs>
32
33
  <Members>
33
34
    <Member MemberName=".ctor">
34
 
      <MemberSignature Language="C#" Value="public CIContext ();" />
35
 
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
36
 
      <MemberType>Constructor</MemberType>
37
 
      <AssemblyInfo>
38
 
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
39
 
      </AssemblyInfo>
40
 
      <Attributes>
41
 
        <Attribute>
42
 
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
43
 
        </Attribute>
44
 
      </Attributes>
45
 
      <Parameters />
46
 
      <Docs>
47
 
        <summary>Default constructor that initializes a new instance of this class with no parameters.</summary>
48
 
        <remarks>
49
 
        </remarks>
50
 
      </Docs>
51
 
    </Member>
52
 
    <Member MemberName=".ctor">
53
35
      <MemberSignature Language="C#" Value="public CIContext (MonoMac.Foundation.NSCoder coder);" />
54
36
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.Foundation.NSCoder coder) cil managed" />
55
37
      <MemberType>Constructor</MemberType>
60
42
        <Attribute>
61
43
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
62
44
        </Attribute>
 
45
        <Attribute>
 
46
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
47
        </Attribute>
63
48
      </Attributes>
64
49
      <Parameters>
65
50
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
77
62
      <AssemblyInfo>
78
63
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
79
64
      </AssemblyInfo>
 
65
      <Attributes>
 
66
        <Attribute>
 
67
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
68
        </Attribute>
 
69
      </Attributes>
80
70
      <Parameters>
81
71
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
82
72
      </Parameters>
83
73
      <Docs>
84
74
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
85
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
75
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
86
76
        <remarks>
87
 
          <para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject.   This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object.   When you invoke the constructor that takes the NSObjectFlag.Empty you taking advatnage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together.    The actual initialization of the object is up to you.</para>
88
 
          <para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place.   Once the allocation has taken place, the constructor has to initialize the object.   With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
89
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
90
 
          <para>In general, if your constructors invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method.   If this is not the case, you should instead chain to the proper constructor in your class. </para>
91
 
          <para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration.  Typically the chaining would look like this:</para>
 
77
          <para>This constructor should be called by derived classes when they are initialized using an [Export] attribute. The argument value is ignore, typically the chaining would look like this:</para>
92
78
          <example>
93
79
            <code lang="C#">
94
 
//
95
 
// The NSObjectFlag merely allocates the object and registers the
96
 
// C# class with the Objective-C runtime if necessary, but no actual
97
 
// initXxx method is invoked, that is done later in the constructor
98
 
//
99
 
// This is taken from MonoMac's source code:
100
 
//
101
 
[Export ("initWithFrame:")]
102
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
103
 
{
104
 
// Invoke the init method now.
105
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
106
 
        if (IsDirectBinding)
107
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
108
 
        else
109
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
110
 
}
 
80
public class MyClass : BaseClass {
 
81
    [Export ("initWithFoo:")]
 
82
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
83
    {
 
84
        ...
 
85
    }
111
86
</code>
112
87
          </example>
113
88
        </remarks>
120
95
      <AssemblyInfo>
121
96
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
122
97
      </AssemblyInfo>
 
98
      <Attributes>
 
99
        <Attribute>
 
100
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
101
        </Attribute>
 
102
      </Attributes>
123
103
      <Parameters>
124
104
        <Parameter Name="handle" Type="System.IntPtr" />
125
105
      </Parameters>
220
200
        <param name="image">To be added.</param>
221
201
        <param name="fromRect">To be added.</param>
222
202
        <param name="ciImageFormat">To be added.</param>
223
 
        <param name="colorSpace">To be added.</param>
 
203
        <param name="colorSpace">
 
204
          <para>To be added.</para>
 
205
          <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
 
206
        </param>
224
207
        <summary>To be added.</summary>
225
208
        <returns>To be added.</returns>
226
209
        <remarks>To be added.</remarks>
257
240
        <Attribute>
258
241
          <AttributeName>MonoMac.Foundation.Export("drawImage:atPoint:fromRect:")</AttributeName>
259
242
        </Attribute>
 
243
        <Attribute>
 
244
          <AttributeName>System.Obsolete("Use DrawImage (CIImage, RectangleF, RectangleF) instead", false)</AttributeName>
 
245
        </Attribute>
260
246
      </Attributes>
261
247
      <ReturnValue>
262
248
        <ReturnType>System.Void</ReturnType>