SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp.Views.iOS/SKGLView.xml at main · mono/SkiaSharp-API-docs · GitHub

History

302 lines (288 loc) · 13 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<Base>

<BaseTypeName>GLKit.GLKView</BaseTypeName>

</Base>

<InterfaceName>GLKit.IGLKViewDelegate</InterfaceName>

</Interface>

<InterfaceName>ObjCRuntime.INativeObject</InterfaceName>

</Interface>

<InterfaceName>System.ComponentModel.IComponent</InterfaceName>

</Interface>

<InterfaceName>System.IDisposable</InterfaceName>

</Interface>

</Interfaces>

<AttributeName Language="C#">[Foundation.Register("SKGLView")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.ComponentModel.DesignTimeVisible(true)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.Versioning.ObsoletedOSPlatform("ios12.0", "Use 'Metal' instead.")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.Versioning.ObsoletedOSPlatform("tvos12.0", "Use 'Metal' instead.")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("ios")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("tvos")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.Versioning.UnsupportedOSPlatform("macos")]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>A hardware-accelerated view that can be drawn on using SkiaSharp drawing commands.</summary>

</Docs>

<MemberType>Constructor</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:SkiaSharp.Views.iOS.SKGLView" /> class.</summary>

</Docs>

</Member>

<MemberType>Constructor</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="frame">The frame used by the view, expressed in iOS points.</param>

<summary>Initializes the <see cref="T:SkiaSharp.Views.iOS.SKGLView" /> with the specified frame.</summary>

</Docs>

</Member>

<MemberType>Constructor</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="p">The pointer (handle) to the unmanaged object.</param>

<summary>Initializes a new instance of the <see cref="T:SkiaSharp.Views.iOS.SKGLView" /> class from a native handle.</summary>

<remarks>This constructor is used by the Xamarin.iOS runtime when creating managed representations of unmanaged objects. It is not intended to be called directly from user code.</remarks>

</Docs>

</Member>

<MemberType>Method</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Docs>

<summary>Called after the object has been loaded from the nib file. Overriders must call the base method.</summary>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<ReturnType>SkiaSharp.SKSize</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the current canvas size.</summary>

<value>The current canvas size in pixels.</value>

<remarks>The canvas size may be different to the view size as a result of the current device's pixel density.</remarks>

</Docs>

</Member>

<MemberType>Method</MemberType>

<InterfaceMember>M:GLKit.IGLKViewDelegate.DrawInRect(GLKit.GLKView,CoreGraphics.CGRect)</InterfaceMember>

</Implements>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="rect">The rectangle to draw.</param>

<summary>Draws the view within the passed-in rectangle.</summary>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<ReturnType>CoreGraphics.CGRect</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets or sets the view's frame rectangle.</summary>

<value>The view's frame rectangle.</value>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<ReturnType>SkiaSharp.GRContext</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the current GPU context.</summary>

<value>The current GPU context.</value>

</Docs>

</Member>

<MemberType>Method</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="e">The event arguments that contain the drawing surface and information.</param>

<summary>Implement this to draw on the canvas.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

There are two ways to draw on this surface: by overriding the

<xref:SkiaSharp.Views.iOS.SKGLView.OnPaintSurface(SkiaSharp.Views.iOS.SKPaintGLSurfaceEventArgs)>

method, or by attaching a handler to the

<xref:SkiaSharp.Views.iOS.SKGLView.PaintSurface>

event.

> [!IMPORTANT]

> If this method is overridden, then the base must be called, otherwise the

> event will not be fired.

## Examples

```csharp

protected override void OnPaintSurface (SKPaintGLSurfaceEventArgs e)

{

// call the base method

base.OnPaintSurface (e);

var surface = e.Surface;

var surfaceWidth = e.BackendRenderTarget.Width;

var surfaceHeight = e.BackendRenderTarget.Height;

var canvas = surface.Canvas;

// draw on the canvas

canvas.Flush ();

}

```

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="C#" Value="public event EventHandler<SkiaSharp.Views.iOS.SKPaintGLSurfaceEventArgs> PaintSurface;" />

<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class SkiaSharp.Views.iOS.SKPaintGLSurfaceEventArgs> PaintSurface" />

<MemberType>Event</MemberType>

<AssemblyName>SkiaSharp.Views.iOS</AssemblyName>

</AssemblyInfo>

<ReturnType>System.EventHandler<SkiaSharp.Views.iOS.SKPaintGLSurfaceEventArgs></ReturnType>

</ReturnValue>

<Docs>

<summary>Occurs when the surface needs to be redrawn.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

There are two ways to draw on this surface: by overriding the

<xref:SkiaSharp.Views.iOS.SKGLView.OnPaintSurface(SkiaSharp.Views.iOS.SKPaintGLSurfaceEventArgs)>

method, or by attaching a handler to the

<xref:SkiaSharp.Views.iOS.SKGLView.PaintSurface>

event.

## Examples

```csharp

myView.PaintSurface += (sender, e) => {

var surface = e.Surface;

var surfaceWidth = e.BackendRenderTarget.Width;

var surfaceHeight = e.BackendRenderTarget.Height;

var canvas = surface.Canvas;

// draw on the canvas

canvas.Flush ();

};

```

]]></format>

</remarks>

</Docs>

</Member>

</Members>

</Type>

SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp.Views.iOS/SKGLView.xml at main · mono/SkiaSharp-API-docs · GitHub

Uh oh!

Expand file tree

Breadcrumbs

SKGLView.xml

Latest commit

History

Breadcrumbs

SKGLView.xml

File metadata and controls