Improved BlittableValueType API (Check, StrideOf methods).
Added AL.BufferData<T> method.
This commit is contained in:
parent
b19d7bf4c5
commit
3cc127ebbc
2 changed files with 223 additions and 35 deletions
|
@ -1412,7 +1412,7 @@ namespace OpenTK.Audio
|
||||||
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
|
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
|
||||||
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
|
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
|
||||||
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
|
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
|
||||||
/// <param name="buffer">Pointer to the audio buffer. YOU MUST PIN THIS MANUALLY.</param>
|
/// <param name="buffer">Pointer to a pinned audio buffer.</param>
|
||||||
/// <param name="size">The size of the audio buffer in bytes.</param>
|
/// <param name="size">The size of the audio buffer in bytes.</param>
|
||||||
/// <param name="freq">The frequency of the audio buffer.</param>
|
/// <param name="freq">The frequency of the audio buffer.</param>
|
||||||
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alBufferData", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
|
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alBufferData", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
|
||||||
|
@ -1422,7 +1422,7 @@ namespace OpenTK.Audio
|
||||||
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
|
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
|
||||||
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
|
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
|
||||||
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
|
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
|
||||||
/// <param name="buffer">Pointer to the audio buffer. YOU MUST PIN THIS MANUALLY.</param>
|
/// <param name="buffer">Pointer to a pinned audio buffer.</param>
|
||||||
/// <param name="size">The size of the audio buffer in bytes.</param>
|
/// <param name="size">The size of the audio buffer in bytes.</param>
|
||||||
/// <param name="freq">The frequency of the audio buffer.</param>
|
/// <param name="freq">The frequency of the audio buffer.</param>
|
||||||
[CLSCompliant(true)]
|
[CLSCompliant(true)]
|
||||||
|
@ -1431,10 +1431,28 @@ namespace OpenTK.Audio
|
||||||
BufferData((uint)bid, format, buffer, size, freq);
|
BufferData((uint)bid, format, buffer, size, freq);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
|
||||||
|
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
|
||||||
|
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
|
||||||
|
/// <param name="buffer">The audio buffer.</param>
|
||||||
|
/// <param name="size">The size of the audio buffer in bytes.</param>
|
||||||
|
/// <param name="freq">The frequency of the audio buffer.</param>
|
||||||
|
public static void BufferData<TBuffer>(int bid, ALFormat format, TBuffer[] buffer, int size, int freq)
|
||||||
|
where TBuffer : struct
|
||||||
|
{
|
||||||
|
if (!BlittableValueType.Check(buffer))
|
||||||
|
throw new ArgumentException("buffer");
|
||||||
|
|
||||||
|
GCHandle handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||||
|
try { BufferData(bid, format, handle.AddrOfPinnedObject(), size, freq); }
|
||||||
|
finally { handle.Free(); }
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>This function fills a buffer with audio buffer (PCM format).</summary>
|
/// <summary>This function fills a buffer with audio buffer (PCM format).</summary>
|
||||||
/// <param name="bid">Buffer Handle/Name to be filled with buffer.</param>
|
/// <param name="bid">Buffer Handle/Name to be filled with buffer.</param>
|
||||||
/// <param name="buffer">A SoundData object containing the buffer to upload.</param>
|
/// <param name="buffer">A SoundData object containing the buffer to upload.</param>
|
||||||
[CLSCompliant(false)]
|
[CLSCompliant(false)]
|
||||||
|
[Obsolete("Use BufferData<TBuffer> instead.")]
|
||||||
public static void BufferData(uint bid, SoundData buffer)
|
public static void BufferData(uint bid, SoundData buffer)
|
||||||
{
|
{
|
||||||
unsafe
|
unsafe
|
||||||
|
|
|
@ -34,6 +34,8 @@ using System.Reflection;
|
||||||
|
|
||||||
namespace OpenTK
|
namespace OpenTK
|
||||||
{
|
{
|
||||||
|
#region BlittableValueType<T>
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Checks whether the specified type parameter is a blittable value type.
|
/// Checks whether the specified type parameter is a blittable value type.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
@ -41,26 +43,58 @@ namespace OpenTK
|
||||||
/// A blittable value type is a struct that only references other value types recursively,
|
/// A blittable value type is a struct that only references other value types recursively,
|
||||||
/// which allows it to be passed to unmanaged code directly.
|
/// which allows it to be passed to unmanaged code directly.
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
/// <typeparam name="T">The struct to check.</typeparam>
|
public static class BlittableValueType<T> where T : struct
|
||||||
/// <exception cref="System.NotSupportedException">Raised when T is not a blittable value type.</exception>
|
|
||||||
public struct BlittableValueType<T> where T : struct
|
|
||||||
{
|
{
|
||||||
|
#region Fields
|
||||||
|
|
||||||
|
static readonly Type Type;
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
#region Constructors
|
||||||
|
|
||||||
|
static BlittableValueType()
|
||||||
|
{
|
||||||
|
Type = typeof(T);
|
||||||
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
#region Public Members
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets the size of the type in bytes.
|
/// Gets the size of the type in bytes.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public static readonly int Stride = Marshal.SizeOf(typeof(T));
|
public static readonly int Stride = Marshal.SizeOf(typeof(T));
|
||||||
|
|
||||||
static BlittableValueType()
|
#region Check
|
||||||
{
|
|
||||||
Type type = typeof(T);
|
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether the current typename T is blittable.
|
||||||
|
/// </summary>
|
||||||
|
public static bool Check()
|
||||||
|
{
|
||||||
|
return Check(Type);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether type is a blittable value type.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="type">A System.Type to check.</param>
|
||||||
|
public static bool Check(Type type)
|
||||||
|
{
|
||||||
if (!CheckStructLayoutAttribute(type))
|
if (!CheckStructLayoutAttribute(type))
|
||||||
Debug.Print("Warning: type {0} does not specify a StructLayoutAttribute with Pack=1. The memory layout of the struct may change between platforms.", type.Name);
|
Debug.Print("Warning: type {0} does not specify a StructLayoutAttribute with Pack=1. The memory layout of the struct may change between platforms.", type.Name);
|
||||||
|
|
||||||
if (!CheckType(type))
|
return CheckType(type);
|
||||||
throw new NotSupportedException(String.Format("Type {0} contains non-primitive fields.", type.Name));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
#region Private Members
|
||||||
|
|
||||||
// Checks whether the parameter is a primitive type or consists of primitive types recursively.
|
// Checks whether the parameter is a primitive type or consists of primitive types recursively.
|
||||||
// Throws a NotSupportedException if it is not.
|
// Throws a NotSupportedException if it is not.
|
||||||
static bool CheckType(Type type)
|
static bool CheckType(Type type)
|
||||||
|
@ -94,5 +128,141 @@ namespace OpenTK
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
#region BlittableValueType
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether the specified type parameter is a blittable value type.
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// A blittable value type is a struct that only references other value types recursively,
|
||||||
|
/// which allows it to be passed to unmanaged code directly.
|
||||||
|
/// </remarks>
|
||||||
|
public static class BlittableValueType
|
||||||
|
{
|
||||||
|
#region Check
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether type is a blittable value type.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="type">An instance of the type to check.</param>
|
||||||
|
public static bool Check<T>(T type) where T : struct
|
||||||
|
{
|
||||||
|
return BlittableValueType<T>.Check();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether type is a blittable value type.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="type">An instance of the type to check.</param>
|
||||||
|
public static bool Check<T>(T[] type) where T : struct
|
||||||
|
{
|
||||||
|
return BlittableValueType<T>.Check();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether type is a blittable value type.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="type">An instance of the type to check.</param>
|
||||||
|
public static bool Check<T>(T[,] type) where T : struct
|
||||||
|
{
|
||||||
|
return BlittableValueType<T>.Check();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether type is a blittable value type.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="type">An instance of the type to check.</param>
|
||||||
|
public static bool Check<T>(T[, ,] type) where T : struct
|
||||||
|
{
|
||||||
|
return BlittableValueType<T>.Check();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Checks whether type is a blittable value type.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="type">An instance of the type to check.</param>
|
||||||
|
[CLSCompliant(false)]
|
||||||
|
public static bool Check<T>(T[][] type) where T : struct
|
||||||
|
{
|
||||||
|
return BlittableValueType<T>.Check();
|
||||||
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
#region From
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Returns the size of the specified value type in bytes.
|
||||||
|
/// </summary>
|
||||||
|
/// <typeparam name="T">The value type. Must be blittable.</typeparam>
|
||||||
|
/// <param name="type">An instance of the value type.</param>
|
||||||
|
/// <returns>An integer, specifying the size of the type in bytes.</returns>
|
||||||
|
/// <exception cref="System.ArgumentException">Occurs when type is not blittable.</exception>
|
||||||
|
public static int StrideOf<T>(T type)
|
||||||
|
where T : struct
|
||||||
|
{
|
||||||
|
if (!Check(type))
|
||||||
|
throw new ArgumentException("type");
|
||||||
|
|
||||||
|
return BlittableValueType<T>.Stride;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Returns the size of a single array element in bytes.
|
||||||
|
/// </summary>
|
||||||
|
/// <typeparam name="T">The value type.</typeparam>
|
||||||
|
/// <param name="type">An instance of the value type.</param>
|
||||||
|
/// <returns>An integer, specifying the size of the type in bytes.</returns>
|
||||||
|
/// <exception cref="System.ArgumentException">Occurs when type is not blittable.</exception>
|
||||||
|
public static int StrideOf<T>(T[] type)
|
||||||
|
where T : struct
|
||||||
|
{
|
||||||
|
if (!Check(type))
|
||||||
|
throw new ArgumentException("type");
|
||||||
|
|
||||||
|
return BlittableValueType<T>.Stride;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Returns the size of a single array element in bytes.
|
||||||
|
/// </summary>
|
||||||
|
/// <typeparam name="T">The value type.</typeparam>
|
||||||
|
/// <param name="type">An instance of the value type.</param>
|
||||||
|
/// <returns>An integer, specifying the size of the type in bytes.</returns>
|
||||||
|
/// <exception cref="System.ArgumentException">Occurs when type is not blittable.</exception>
|
||||||
|
public static int StrideOf<T>(T[,] type)
|
||||||
|
where T : struct
|
||||||
|
{
|
||||||
|
if (!Check(type))
|
||||||
|
throw new ArgumentException("type");
|
||||||
|
|
||||||
|
return BlittableValueType<T>.Stride;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Returns the size of a single array element in bytes.
|
||||||
|
/// </summary>
|
||||||
|
/// <typeparam name="T">The value type.</typeparam>
|
||||||
|
/// <param name="type">An instance of the value type.</param>
|
||||||
|
/// <returns>An integer, specifying the size of the type in bytes.</returns>
|
||||||
|
/// <exception cref="System.ArgumentException">Occurs when type is not blittable.</exception>
|
||||||
|
public static int StrideOf<T>(T[, ,] type)
|
||||||
|
where T : struct
|
||||||
|
{
|
||||||
|
if (!Check(type))
|
||||||
|
throw new ArgumentException("type");
|
||||||
|
|
||||||
|
return BlittableValueType<T>.Stride;
|
||||||
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue