Skip to content

Commit

Permalink
Update to 4.8.2 and tutorial fix
Browse files Browse the repository at this point in the history
  • Loading branch information
NogginBops committed Mar 5, 2024
1 parent ce29de8 commit 0bd7daa
Show file tree
Hide file tree
Showing 19 changed files with 930 additions and 4,489 deletions.
25 changes: 25 additions & 0 deletions api/OpenTK.Audio.OpenAL.OpenALLibraryNameContainer.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,31 @@ <h5 class="propertyValue">Property Value</h5>
</tr>
</tbody>
</table>
<a id="OpenTK_Audio_OpenAL_OpenALLibraryNameContainer_OverridePath_" data-uid="OpenTK.Audio.OpenAL.OpenALLibraryNameContainer.OverridePath*"></a>
<h4 id="OpenTK_Audio_OpenAL_OpenALLibraryNameContainer_OverridePath" data-uid="OpenTK.Audio.OpenAL.OpenALLibraryNameContainer.OverridePath">OverridePath</h4>
<div class="markdown level1 summary"><p>Overrides any platform detection logic and directly searches for the OpenAL library using the provided path.
If this is <code>null</code> then no override will happen.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string OverridePath { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenTK_Audio_OpenAL_OpenALLibraryNameContainer_Windows_" data-uid="OpenTK.Audio.OpenAL.OpenALLibraryNameContainer.Windows*"></a>
<h4 id="OpenTK_Audio_OpenAL_OpenALLibraryNameContainer_Windows" data-uid="OpenTK.Audio.OpenAL.OpenALLibraryNameContainer.Windows">Windows</h4>
<div class="markdown level1 summary"><p>Gets the library name to use on Windows.</p>
Expand Down
25 changes: 25 additions & 0 deletions api/OpenTK.Compute.OpenCL.OpenCLLibraryNameContainer.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,31 @@ <h5 class="propertyValue">Property Value</h5>
</tr>
</tbody>
</table>
<a id="OpenTK_Compute_OpenCL_OpenCLLibraryNameContainer_OverridePath_" data-uid="OpenTK.Compute.OpenCL.OpenCLLibraryNameContainer.OverridePath*"></a>
<h4 id="OpenTK_Compute_OpenCL_OpenCLLibraryNameContainer_OverridePath" data-uid="OpenTK.Compute.OpenCL.OpenCLLibraryNameContainer.OverridePath">OverridePath</h4>
<div class="markdown level1 summary"><p>Overrides any platform detection logic and directly searches for the OpenCL library using the provided path.
If this is <code>null</code> then no override will happen.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string OverridePath { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenTK_Compute_OpenCL_OpenCLLibraryNameContainer_Windows_" data-uid="OpenTK.Compute.OpenCL.OpenCLLibraryNameContainer.Windows*"></a>
<h4 id="OpenTK_Compute_OpenCL_OpenCLLibraryNameContainer_Windows" data-uid="OpenTK.Compute.OpenCL.OpenCLLibraryNameContainer.Windows">Windows</h4>
<div class="markdown level1 summary"></div>
Expand Down
34 changes: 34 additions & 0 deletions api/OpenTK.IBindingsContext.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,40 @@ <h5 id="OpenTK_IBindingsContext_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IBindingsContext</code></pre>
</div>
<h5 id="OpenTK_IBindingsContext_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>If you wish to use OpenTK OpenGL bindings in a custom environment see
the example for a tutorial on its usage.</p>
</div>
<h5 id="OpenTK_IBindingsContext_examples"><strong>Examples</strong></h5>
<p>In order to use this interface, you need to figure out how to load OpenGL
function pointers in your custom environment. For example, if you are
providing a custom window using SDL, you would use the C function
<code>SDL_GL_GetProcAddress</code> to implement this interface.</p>
<pre><code class="lang-csharp">using System;
using System.Runtime.InteropServices;
using OpenTK;
using OpenTK.Graphics.OpenGL4;

public class MySDLBindingsContext : IBindingsContext
{
public IntPtr GetProcAddress(string procName)
{
[DllImport("SDL2")]
extern static IntPtr SDL_GL_GetProcAddress([MarshalAs(UnmanagedType.LPStr)] string procName);

return SDL_GL_GetProcAddress(procName);
}
}

/// ...

// In order to load the bindings, call the following function with this
// new class you implemented.
GL.LoadBindings(new MySDLBindingsContext());</code></pre>
<p>Do note that every OpenTK.Graphics.XXX namespace has its own pointer table.
If you have mixed and matched the namespaces used in your project, you might
run into exceptions telling you that the bindings are not loaded.</p>

<h3 id="methods">Methods
</h3>
<a id="OpenTK_IBindingsContext_GetProcAddress_" data-uid="OpenTK.IBindingsContext.GetProcAddress*"></a>
Expand Down
20 changes: 10 additions & 10 deletions api/OpenTK.Mathematics.Box2.html
Original file line number Diff line number Diff line change
Expand Up @@ -764,13 +764,13 @@ <h5 class="overrides">Overrides</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode">ValueType.GetHashCode()</a></div>
<a id="OpenTK_Mathematics_Box2_Inflate_" data-uid="OpenTK.Mathematics.Box2.Inflate*"></a>
<h4 id="OpenTK_Mathematics_Box2_Inflate_OpenTK_Mathematics_Vector2_" data-uid="OpenTK.Mathematics.Box2.Inflate(OpenTK.Mathematics.Vector2)">Inflate(Vector2)</h4>
<div class="markdown level1 summary"><p>Inflate this Box2 to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box2 by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box2.html#OpenTK_Mathematics_Box2_Extend_OpenTK_Mathematics_Vector2_">Extend(Vector2)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use Extend instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public void Inflate(Vector2 point)</code></pre>
<pre><code class="lang-csharp hljs">public void Inflate(Vector2 size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -784,22 +784,22 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector2.html">Vector2</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to inflate to.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
</table>
<a id="OpenTK_Mathematics_Box2_Inflated_" data-uid="OpenTK.Mathematics.Box2.Inflated*"></a>
<h4 id="OpenTK_Mathematics_Box2_Inflated_OpenTK_Mathematics_Vector2_" data-uid="OpenTK.Mathematics.Box2.Inflated(OpenTK.Mathematics.Vector2)">Inflated(Vector2)</h4>
<div class="markdown level1 summary"><p>Inflate this Box2 to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box2 by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box2.html#OpenTK_Mathematics_Box2_Extended_OpenTK_Mathematics_Vector2_">Extended(Vector2)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Pure]
[Obsolete(&quot;Use Extended instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public Box2 Inflated(Vector2 point)</code></pre>
public Box2 Inflated(Vector2 size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -813,8 +813,8 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector2.html">Vector2</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to inflate to.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
Expand Down
20 changes: 10 additions & 10 deletions api/OpenTK.Mathematics.Box2d.html
Original file line number Diff line number Diff line change
Expand Up @@ -764,13 +764,13 @@ <h5 class="overrides">Overrides</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode">ValueType.GetHashCode()</a></div>
<a id="OpenTK_Mathematics_Box2d_Inflate_" data-uid="OpenTK.Mathematics.Box2d.Inflate*"></a>
<h4 id="OpenTK_Mathematics_Box2d_Inflate_OpenTK_Mathematics_Vector2d_" data-uid="OpenTK.Mathematics.Box2d.Inflate(OpenTK.Mathematics.Vector2d)">Inflate(Vector2d)</h4>
<div class="markdown level1 summary"><p>Inflate this Box2d to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box2d by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box2d.html#OpenTK_Mathematics_Box2d_Extend_OpenTK_Mathematics_Vector2d_">Extend(Vector2d)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use Extend instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public void Inflate(Vector2d point)</code></pre>
<pre><code class="lang-csharp hljs">public void Inflate(Vector2d size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -784,22 +784,22 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector2d.html">Vector2d</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to query.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
</table>
<a id="OpenTK_Mathematics_Box2d_Inflated_" data-uid="OpenTK.Mathematics.Box2d.Inflated*"></a>
<h4 id="OpenTK_Mathematics_Box2d_Inflated_OpenTK_Mathematics_Vector2d_" data-uid="OpenTK.Mathematics.Box2d.Inflated(OpenTK.Mathematics.Vector2d)">Inflated(Vector2d)</h4>
<div class="markdown level1 summary"><p>Inflate this Box2d to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box2d by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box2d.html#OpenTK_Mathematics_Box2d_Extended_OpenTK_Mathematics_Vector2d_">Extended(Vector2d)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Pure]
[Obsolete(&quot;Use Extended instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public Box2d Inflated(Vector2d point)</code></pre>
public Box2d Inflated(Vector2d size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -813,8 +813,8 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector2d.html">Vector2d</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to query.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
Expand Down
20 changes: 10 additions & 10 deletions api/OpenTK.Mathematics.Box2i.html
Original file line number Diff line number Diff line change
Expand Up @@ -789,13 +789,13 @@ <h5 class="overrides">Overrides</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode">ValueType.GetHashCode()</a></div>
<a id="OpenTK_Mathematics_Box2i_Inflate_" data-uid="OpenTK.Mathematics.Box2i.Inflate*"></a>
<h4 id="OpenTK_Mathematics_Box2i_Inflate_OpenTK_Mathematics_Vector2i_" data-uid="OpenTK.Mathematics.Box2i.Inflate(OpenTK.Mathematics.Vector2i)">Inflate(Vector2i)</h4>
<div class="markdown level1 summary"><p>Inflate this Box2i to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box2i by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box2i.html#OpenTK_Mathematics_Box2i_Extend_OpenTK_Mathematics_Vector2i_">Extend(Vector2i)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use Extend instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public void Inflate(Vector2i point)</code></pre>
<pre><code class="lang-csharp hljs">public void Inflate(Vector2i size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -809,22 +809,22 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector2i.html">Vector2i</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to query.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
</table>
<a id="OpenTK_Mathematics_Box2i_Inflated_" data-uid="OpenTK.Mathematics.Box2i.Inflated*"></a>
<h4 id="OpenTK_Mathematics_Box2i_Inflated_OpenTK_Mathematics_Vector2i_" data-uid="OpenTK.Mathematics.Box2i.Inflated(OpenTK.Mathematics.Vector2i)">Inflated(Vector2i)</h4>
<div class="markdown level1 summary"><p>Inflate this Box2i to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box2i by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box2i.html#OpenTK_Mathematics_Box2i_Extended_OpenTK_Mathematics_Vector2i_">Extended(Vector2i)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Pure]
[Obsolete(&quot;Use Extended instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public Box2i Inflated(Vector2i point)</code></pre>
public Box2i Inflated(Vector2i size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -838,8 +838,8 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector2i.html">Vector2i</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to query.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
Expand Down
20 changes: 10 additions & 10 deletions api/OpenTK.Mathematics.Box3.html
Original file line number Diff line number Diff line change
Expand Up @@ -776,13 +776,13 @@ <h5 class="overrides">Overrides</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode">ValueType.GetHashCode()</a></div>
<a id="OpenTK_Mathematics_Box3_Inflate_" data-uid="OpenTK.Mathematics.Box3.Inflate*"></a>
<h4 id="OpenTK_Mathematics_Box3_Inflate_OpenTK_Mathematics_Vector3_" data-uid="OpenTK.Mathematics.Box3.Inflate(OpenTK.Mathematics.Vector3)">Inflate(Vector3)</h4>
<div class="markdown level1 summary"><p>Inflate this Box3 to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box3 by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box3.html#OpenTK_Mathematics_Box3_Extend_OpenTK_Mathematics_Vector3_">Extend(Vector3)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use Extend instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public void Inflate(Vector3 point)</code></pre>
<pre><code class="lang-csharp hljs">public void Inflate(Vector3 size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -796,22 +796,22 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector3.html">Vector3</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to query.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
</table>
<a id="OpenTK_Mathematics_Box3_Inflated_" data-uid="OpenTK.Mathematics.Box3.Inflated*"></a>
<h4 id="OpenTK_Mathematics_Box3_Inflated_OpenTK_Mathematics_Vector3_" data-uid="OpenTK.Mathematics.Box3.Inflated(OpenTK.Mathematics.Vector3)">Inflated(Vector3)</h4>
<div class="markdown level1 summary"><p>Inflate this Box3 to encapsulate a given point.</p>
<div class="markdown level1 summary"><p>Inflates this Box3 by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.
Use the <a class="xref" href="OpenTK.Mathematics.Box3.html#OpenTK_Mathematics_Box3_Extended_OpenTK_Mathematics_Vector3_">Extended(Vector3)</a> method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Pure]
[Obsolete(&quot;Use Extended instead. This function will have it&#39;s implementation changed in the future.&quot;)]
public Box3 Inflated(Vector3 point)</code></pre>
public Box3 Inflated(Vector3 size)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -825,8 +825,8 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="OpenTK.Mathematics.Vector3.html">Vector3</a></td>
<td><span class="parametername">point</span></td>
<td><p>The point to query.</p>
<td><span class="parametername">size</span></td>
<td><p>The size to inflate by.</p>
</td>
</tr>
</tbody>
Expand Down
Loading

0 comments on commit 0bd7daa

Please sign in to comment.