diff --git a/Raylib-cs/Raylib.cs b/Raylib-cs/Raylib.cs index 1b65cd2..1c5094e 100644 --- a/Raylib-cs/Raylib.cs +++ b/Raylib-cs/Raylib.cs @@ -22,14 +22,14 @@ namespace Raylib_cs // WARNING: These callbacks are intended for advance users /// - /// Logging: Redirect trace log messages + /// Logging: Redirect trace log messages
/// WARNING: This callback is intended for advance users ///
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] public delegate void TraceLogCallback(TraceLogLevel logLevel, string text, IntPtr args); /// - /// FileIO: Load binary data + /// FileIO: Load binary data
/// WARNING: This callback is intended for advance users ///
/// refers to a unsigned char * @@ -37,29 +37,29 @@ namespace Raylib_cs public delegate IntPtr LoadFileDataCallback(string fileName, ref int bytesRead); /// - /// FileIO: Save binary data + /// FileIO: Save binary data
/// WARNING: This callback is intended for advance users ///
- /// refers to a void * [UnmanagedFunctionPointer(CallingConvention.Cdecl)] public delegate CBool SaveFileDataCallback(string fileName, IntPtr data, ref int bytesToWrite); /// - /// FileIO: Load text data + /// FileIO: Load text data
/// WARNING: This callback is intended for advance users ///
+ /// refers to a char * [UnmanagedFunctionPointer(CallingConvention.Cdecl)] - public delegate string LoadFileTextCallback(string fileName); + public delegate IntPtr LoadFileTextCallback(string fileName); /// - /// FileIO: Save text data + /// FileIO: Save text data
/// WARNING: This callback is intended for advance users ///
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] public delegate CBool SaveFileTextCallback(string fileName, string text); /// - /// Returns color with alpha applied, alpha goes from 0.0f to 1.0f + /// Returns color with alpha applied, alpha goes from 0.0f to 1.0f
/// NOTE: Added for compatability with previous versions ///
public static Color Fade(Color color, float alpha) => ColorAlpha(color, alpha); @@ -71,9 +71,7 @@ namespace Raylib_cs // Window-related functions - /// - /// Initialize window and OpenGL context - /// + /// Initialize window and OpenGL context [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void InitWindow(int width, int height, [MarshalAs(UnmanagedType.LPUTF8Str)] string title); @@ -165,7 +163,7 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void SetWindowSize(int width, int height); - /// Get native window handle + /// Get native window handle
/// IntPtr refers to a void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr GetWindowHandle(); @@ -386,12 +384,12 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern int GetShaderLocationAttrib(Shader shader, string attribName); - /// Set shader uniform value - /// value refers to a const void * + /// Set shader uniform value
+ /// refers to a const void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void SetShaderValue(Shader shader, int uniformLoc, IntPtr value, ShaderUniformDataType uniformType); - /// Set shader uniform value vector + /// Set shader uniform value vector
/// value refers to a const void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void SetShaderValueV(Shader shader, int uniformLoc, IntPtr value, ShaderUniformDataType uniformType, int count); @@ -524,12 +522,12 @@ namespace Raylib_cs // Files management functions - /// Load file data as byte array (read) + /// Load file data as byte array (read)
/// IntPtr refers to unsigned char *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr LoadFileData(string fileName, ref int bytesRead); - /// Unload file data allocated by LoadFileData() + /// Unload file data allocated by LoadFileData()
/// data refers to a unsigned char *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UnloadFileData(IntPtr data); @@ -548,7 +546,7 @@ namespace Raylib_cs /// Get dropped files names (memory should be freed) [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] - public static unsafe extern byte** GetDroppedFiles(int* count); + public static extern unsafe byte** GetDroppedFiles(int* count); /// Clear dropped files paths buffer (free memory) [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] @@ -814,9 +812,9 @@ namespace Raylib_cs // Basic Shapes Drawing Functions (Module: shapes) //------------------------------------------------------------------------------------ - /// Set texture and rectangle to be used on shapes drawing - /// NOTE: It can be useful when using basic shapes and one single font, - /// defining a font char white rectangle would allow drawing everything in a single draw call + /// Set texture and rectangle to be used on shapes drawing
+ /// NOTE: It can be useful when using basic shapes and one single font.
+ /// Defining a white rectangle would allow drawing everything in a single draw call.
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void SetShapesTexture(Texture2D texture, Rectangle source); @@ -1001,7 +999,7 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern CBool CheckCollisionLines(Vector2 startPos1, Vector2 endPos1, Vector2 startPos2, Vector2 endPos2, ref Vector2 collisionPoint); - /// Check if point belongs to line created between two points [p1] and [p2] with defined margin in pixels [threshold] + /// Check if point belongs to line created between two points [p1] and [p2] with defined margin in pixels [threshold] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern CBool CheckCollisionPointLine(Vector2 point, Vector2 p1, Vector2 p2, int threshold); @@ -1029,7 +1027,7 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Image LoadImageAnim(string fileName, ref int frames); - /// Load image from memory buffer, fileType refers to extension: i.e. "png" + /// Load image from memory buffer, fileType refers to extension: i.e. "png"
/// fileData refers to const unsigned char *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Image LoadImageFromMemory(string fileType, IntPtr fileData, int dataSize); @@ -1192,17 +1190,17 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void ImageColorReplace(ref Image image, Color color, Color replace); - /// Load color data from image as a Color array (RGBA - 32bit) + /// Load color data from image as a Color array (RGBA - 32bit)
/// IntPtr refers to Color *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr LoadImageColors(Image image); - /// Load colors palette from image as a Color array (RGBA - 32bit) + /// Load colors palette from image as a Color array (RGBA - 32bit)
/// IntPtr refers to Color *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr LoadImagePaletee(Image image, int maxPaletteSize, ref int colorsCount); - /// Unload color data loaded with LoadImageColors() + /// Unload color data loaded with LoadImageColors()
/// colors refers to Color *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UnloadImageColors(IntPtr colors); @@ -1308,7 +1306,7 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UnloadRenderTexture(RenderTexture2D target); - /// Update GPU texture with new data + /// Update GPU texture with new data
/// pixels refers to a const void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UpdateTexture(Texture2D texture, IntPtr pixels); @@ -1442,13 +1440,13 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Font LoadFontFromImage(Image image, Color key, int firstChar); - /// Load font from memory buffer, fileType refers to extension: i.e. "ttf" + /// Load font from memory buffer, fileType refers to extension: i.e. "ttf"
/// fileData refers to const unsigned char *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Font LoadFontFromMemory(string fileType, IntPtr fileData, int dataSize, int fontSize, int[] fontChars, int charsCount); - /// Load font data for further use - /// fileData refers to const unsigned char * + /// Load font data for further use
+ /// fileData refers to const unsigned char *
/// IntPtr refers to GlyphInfo *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr LoadFontData(IntPtr fileData, int dataSize, int fontSize, int[] fontChars, int charsCount, FontType type); @@ -1457,7 +1455,7 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Image GenImageFontAtlas(IntPtr chars, ref IntPtr recs, int charsCount, int fontSize, int padding, int packMethod); - /// Unload font chars info data (RAM) + /// Unload font chars info data (RAM)
/// chars refers to GlpyhInfo *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UnloadFontData(IntPtr chars, int charsCount); @@ -1542,7 +1540,7 @@ namespace Raylib_cs // UTF8 text strings management functions - /// Get all codepoints in a string, codepoints count returned by parameters + /// Get all codepoints in a string, codepoints count returned by parameters
/// IntPtr refers to a int *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr GetCodepoints(string text, ref int count); @@ -1683,8 +1681,8 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UploadMesh(ref Mesh mesh, CBool dynamic); - /// Update mesh vertex data in GPU for a specific buffer index - /// data refers to a void * + /// Update mesh vertex data in GPU for a specific buffer index
+ /// data refers to a void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UpdateMeshBuffer(Mesh mesh, int index, IntPtr data, int dataSize, int offset); @@ -1719,7 +1717,7 @@ namespace Raylib_cs // Material loading/unloading functions - /// Load materials from model file + /// Load materials from model file
/// IntPtr refers to Material *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr LoadMaterials(string fileName, ref int materialCount); @@ -1823,7 +1821,7 @@ namespace Raylib_cs // Model animations loading/unloading functions - /// Load model animations from file + /// Load model animations from file
/// IntPtr refers to ModelAnimation *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr LoadModelAnimations(string fileName, ref int animsCount); @@ -1912,7 +1910,7 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Wave LoadWave(string fileName); - /// Load wave from memory buffer, fileType refers to extension: i.e. "wav" + /// Load wave from memory buffer, fileType refers to extension: i.e. "wav"
/// fileData refers to a const unsigned char *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Wave LoadWaveFromMemory(string fileType, IntPtr fileData, int dataSize); @@ -1925,8 +1923,8 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern Sound LoadSoundFromWave(Wave wave); - /// Update sound buffer with new data - /// data refers to a const void * + /// Update sound buffer with new data
+ /// refers to a const void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UpdateSound(Sound sound, IntPtr data, int samplesCount); @@ -2001,12 +1999,12 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void WaveCrop(ref Wave wave, int initSample, int finalSample); - /// Get samples data from wave as a floats array + /// Get samples data from wave as a floats array
/// IntPtr refers to float *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr LoadWaveSamples(Wave wave); - /// Unload samples data loaded with LoadWaveSamples() + /// Unload samples data loaded with LoadWaveSamples()
/// samples refers to float *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UnloadWaveSamples(IntPtr samples); @@ -2080,7 +2078,7 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UnloadAudioStream(AudioStream stream); - /// Update audio stream buffers with data + /// Update audio stream buffers with data
/// data refers to a const void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void UpdateAudioStream(AudioStream stream, IntPtr data, int samplesCount); diff --git a/Raylib-cs/RaylibUtils.cs b/Raylib-cs/RaylibUtils.cs index c065007..741b7a2 100644 --- a/Raylib-cs/RaylibUtils.cs +++ b/Raylib-cs/RaylibUtils.cs @@ -4,7 +4,7 @@ using Raylib_cs; namespace Raylib_cs { - [StructLayout(LayoutKind.Sequential)] + [StructLayout(LayoutKind.Sequential)] public readonly struct CBool { private readonly byte value; diff --git a/Raylib-cs/Rlgl.cs b/Raylib-cs/Rlgl.cs index d49264d..34587d3 100644 --- a/Raylib-cs/Rlgl.cs +++ b/Raylib-cs/Rlgl.cs @@ -493,7 +493,7 @@ namespace Raylib_cs // Textures data management - /// Load texture in GPU + /// Load texture in GPU
/// data refers to a void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern uint rlLoadTexture(IntPtr data, int width, int height, PixelFormat format, int mipmapCount); @@ -502,12 +502,12 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern uint rlLoadTextureDepth(int width, int height, CBool useRenderBuffer); - /// Load texture cubemap + /// Load texture cubemap
/// data refers to a void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern uint rlLoadTextureCubemap(IntPtr data, int size, PixelFormat format); - /// Update GPU texture with new data + /// Update GPU texture with new data
/// data refers to a const void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void rlUpdateTexture(uint id, int width, int height, PixelFormat format, IntPtr data); @@ -524,12 +524,12 @@ namespace Raylib_cs [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern void rlGenerateMipmaps(ref Texture2D texture); - /// Read texture pixel data + /// Read texture pixel data
/// IntPtr refers to a void *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr rlReadTexturePixels(Texture2D texture); - /// Read screen pixel data (color buffer) + /// Read screen pixel data (color buffer)
/// IntPtr refers to a unsigned char *
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] public static extern IntPtr rlReadScreenPixels(int width, int height); diff --git a/Raylib-cs/types/Audio.cs b/Raylib-cs/types/Audio.cs index 5709ee5..5f14236 100644 --- a/Raylib-cs/types/Audio.cs +++ b/Raylib-cs/types/Audio.cs @@ -36,7 +36,7 @@ namespace Raylib_cs } /// - /// Audio stream type + /// Audio stream type
/// NOTE: Useful to create custom audio streams not bound to a specific file ///
[StructLayout(LayoutKind.Sequential)] @@ -81,7 +81,7 @@ namespace Raylib_cs } /// - /// Music stream type (audio file streaming from memory) + /// Music stream type (audio file streaming from memory)
/// NOTE: Anything longer than ~10 seconds should be streamed ///
[StructLayout(LayoutKind.Sequential)] diff --git a/Raylib-cs/types/Image.cs b/Raylib-cs/types/Image.cs index e5e1f9f..271cc55 100644 --- a/Raylib-cs/types/Image.cs +++ b/Raylib-cs/types/Image.cs @@ -3,8 +3,10 @@ using System.Runtime.InteropServices; namespace Raylib_cs { - /// Pixel formats - /// NOTE: Support depends on OpenGL version and platform + /// + /// Pixel formats
+ /// NOTE: Support depends on OpenGL version and platform + ///
public enum PixelFormat { /// diff --git a/Raylib-cs/types/Input.cs b/Raylib-cs/types/Input.cs index cc1030b..fd032c7 100644 --- a/Raylib-cs/types/Input.cs +++ b/Raylib-cs/types/Input.cs @@ -4,9 +4,10 @@ using System.Runtime.InteropServices; namespace Raylib_cs { - /// Keyboard keys (US keyboard layout) - /// NOTE: Use GetKeyPressed() to allow redefining - /// required keys for alternative layouts + /// + /// Keyboard keys (US keyboard layout)
+ /// NOTE: Use GetKeyPressed() to allow redefining required keys for alternative layouts + ///
public enum KeyboardKey { /// @@ -350,8 +351,10 @@ namespace Raylib_cs GAMEPAD_BUTTON_RIGHT_THUMB } - /// Gesture - /// NOTE: It could be used as flags to enable only some gestures + /// + /// Gesture
+ /// NOTE: It could be used as flags to enable only some gestures + ///
[Flags] public enum Gesture { diff --git a/Raylib-cs/types/Mesh.cs b/Raylib-cs/types/Mesh.cs index c7746a2..6c29141 100644 --- a/Raylib-cs/types/Mesh.cs +++ b/Raylib-cs/types/Mesh.cs @@ -27,7 +27,7 @@ namespace Raylib_cs } /// - /// Vertex data definning a mesh + /// Vertex data definning a mesh
/// NOTE: Data stored in CPU memory (and GPU) ///
[StructLayout(LayoutKind.Sequential)] diff --git a/Raylib-cs/types/Texture2D.cs b/Raylib-cs/types/Texture2D.cs index f8c7f0d..7315b6a 100644 --- a/Raylib-cs/types/Texture2D.cs +++ b/Raylib-cs/types/Texture2D.cs @@ -2,9 +2,11 @@ using System.Runtime.InteropServices; namespace Raylib_cs { - /// Texture parameters: filter mode - /// NOTE 1: Filtering considers mipmaps if available in the texture - /// NOTE 2: Filter is accordingly set for minification and magnification + /// + /// Texture parameters: filter mode
+ /// NOTE 1: Filtering considers mipmaps if available in the texture
+ /// NOTE 2: Filter is accordingly set for minification and magnification + ///
public enum TextureFilter { /// @@ -97,8 +99,7 @@ namespace Raylib_cs } /// - /// Texture2D type - ///
+ /// Texture2D type
/// NOTE: Data stored in GPU memory ///
[StructLayout(LayoutKind.Sequential)]