2
0
mirror of https://github.com/raylib-cs/raylib-cs synced 2025-09-09 03:01:41 -04:00

Update XmlDoc comments

This commit is contained in:
2021-11-11 12:00:42 +00:00
parent 5014ebbfe0
commit de6caec6f1
8 changed files with 67 additions and 63 deletions

View File

@@ -22,14 +22,14 @@ namespace Raylib_cs
// WARNING: These callbacks are intended for advance users // WARNING: These callbacks are intended for advance users
/// <summary> /// <summary>
/// Logging: Redirect trace log messages /// Logging: Redirect trace log messages<br/>
/// WARNING: This callback is intended for advance users /// WARNING: This callback is intended for advance users
/// </summary> /// </summary>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate void TraceLogCallback(TraceLogLevel logLevel, string text, IntPtr args); public delegate void TraceLogCallback(TraceLogLevel logLevel, string text, IntPtr args);
/// <summary> /// <summary>
/// FileIO: Load binary data /// FileIO: Load binary data<br/>
/// WARNING: This callback is intended for advance users /// WARNING: This callback is intended for advance users
/// </summary> /// </summary>
/// <returns><see cref="IntPtr"/> refers to a unsigned char *</returns> /// <returns><see cref="IntPtr"/> refers to a unsigned char *</returns>
@@ -37,29 +37,29 @@ namespace Raylib_cs
public delegate IntPtr LoadFileDataCallback(string fileName, ref int bytesRead); public delegate IntPtr LoadFileDataCallback(string fileName, ref int bytesRead);
/// <summary> /// <summary>
/// FileIO: Save binary data /// FileIO: Save binary data<br/>
/// WARNING: This callback is intended for advance users /// WARNING: This callback is intended for advance users
/// </summary> /// </summary>
/// <returns><see cref="IntPtr"/> refers to a void *</returns>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate CBool SaveFileDataCallback(string fileName, IntPtr data, ref int bytesToWrite); public delegate CBool SaveFileDataCallback(string fileName, IntPtr data, ref int bytesToWrite);
/// <summary> /// <summary>
/// FileIO: Load text data /// FileIO: Load text data<br/>
/// WARNING: This callback is intended for advance users /// WARNING: This callback is intended for advance users
/// </summary> /// </summary>
/// <returns><see cref="IntPtr"/> refers to a char *</returns>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate string LoadFileTextCallback(string fileName); public delegate IntPtr LoadFileTextCallback(string fileName);
/// <summary> /// <summary>
/// FileIO: Save text data /// FileIO: Save text data<br/>
/// WARNING: This callback is intended for advance users /// WARNING: This callback is intended for advance users
/// </summary> /// </summary>
[UnmanagedFunctionPointer(CallingConvention.Cdecl)] [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate CBool SaveFileTextCallback(string fileName, string text); public delegate CBool SaveFileTextCallback(string fileName, string text);
/// <summary> /// <summary>
/// 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<br/>
/// NOTE: Added for compatability with previous versions /// NOTE: Added for compatability with previous versions
/// </summary> /// </summary>
public static Color Fade(Color color, float alpha) => ColorAlpha(color, alpha); public static Color Fade(Color color, float alpha) => ColorAlpha(color, alpha);
@@ -71,9 +71,7 @@ namespace Raylib_cs
// Window-related functions // Window-related functions
/// <summary> /// <summary>Initialize window and OpenGL context</summary>
/// Initialize window and OpenGL context
/// </summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void InitWindow(int width, int height, [MarshalAs(UnmanagedType.LPUTF8Str)] string title); 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)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void SetWindowSize(int width, int height); public static extern void SetWindowSize(int width, int height);
/// <summary>Get native window handle /// <summary>Get native window handle<br/>
/// IntPtr refers to a void *</summary> /// IntPtr refers to a void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr GetWindowHandle(); public static extern IntPtr GetWindowHandle();
@@ -386,12 +384,12 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern int GetShaderLocationAttrib(Shader shader, string attribName); public static extern int GetShaderLocationAttrib(Shader shader, string attribName);
/// <summary>Set shader uniform value /// <summary>Set shader uniform value<br/>
/// value refers to a const void *</summary> /// refers to a const void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void SetShaderValue(Shader shader, int uniformLoc, IntPtr value, ShaderUniformDataType uniformType); public static extern void SetShaderValue(Shader shader, int uniformLoc, IntPtr value, ShaderUniformDataType uniformType);
/// <summary>Set shader uniform value vector /// <summary>Set shader uniform value vector<br/>
/// value refers to a const void *</summary> /// value refers to a const void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void SetShaderValueV(Shader shader, int uniformLoc, IntPtr value, ShaderUniformDataType uniformType, int count); 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 // Files management functions
/// <summary>Load file data as byte array (read) /// <summary>Load file data as byte array (read)<br/>
/// IntPtr refers to unsigned char *</summary> /// IntPtr refers to unsigned char *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr LoadFileData(string fileName, ref int bytesRead); public static extern IntPtr LoadFileData(string fileName, ref int bytesRead);
/// <summary>Unload file data allocated by LoadFileData() /// <summary>Unload file data allocated by LoadFileData()<br/>
/// data refers to a unsigned char *</summary> /// data refers to a unsigned char *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UnloadFileData(IntPtr data); public static extern void UnloadFileData(IntPtr data);
@@ -548,7 +546,7 @@ namespace Raylib_cs
/// <summary>Get dropped files names (memory should be freed)</summary> /// <summary>Get dropped files names (memory should be freed)</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static unsafe extern byte** GetDroppedFiles(int* count); public static extern unsafe byte** GetDroppedFiles(int* count);
/// <summary>Clear dropped files paths buffer (free memory)</summary> /// <summary>Clear dropped files paths buffer (free memory)</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
@@ -814,9 +812,9 @@ namespace Raylib_cs
// Basic Shapes Drawing Functions (Module: shapes) // Basic Shapes Drawing Functions (Module: shapes)
//------------------------------------------------------------------------------------ //------------------------------------------------------------------------------------
/// <summary>Set texture and rectangle to be used on shapes drawing /// <summary>Set texture and rectangle to be used on shapes drawing<br/>
/// NOTE: It can be useful when using basic shapes and one single font, /// NOTE: It can be useful when using basic shapes and one single font.<br/>
/// defining a font char white rectangle would allow drawing everything in a single draw call</summary> /// Defining a white rectangle would allow drawing everything in a single draw call.</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void SetShapesTexture(Texture2D texture, Rectangle source); public static extern void SetShapesTexture(Texture2D texture, Rectangle source);
@@ -1029,7 +1027,7 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Image LoadImageAnim(string fileName, ref int frames); public static extern Image LoadImageAnim(string fileName, ref int frames);
/// <summary>Load image from memory buffer, fileType refers to extension: i.e. "png" /// <summary>Load image from memory buffer, fileType refers to extension: i.e. "png"<br/>
/// fileData refers to const unsigned char *</summary> /// fileData refers to const unsigned char *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Image LoadImageFromMemory(string fileType, IntPtr fileData, int dataSize); public static extern Image LoadImageFromMemory(string fileType, IntPtr fileData, int dataSize);
@@ -1192,17 +1190,17 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void ImageColorReplace(ref Image image, Color color, Color replace); public static extern void ImageColorReplace(ref Image image, Color color, Color replace);
/// <summary>Load color data from image as a Color array (RGBA - 32bit) /// <summary>Load color data from image as a Color array (RGBA - 32bit)<br/>
/// IntPtr refers to Color *</summary> /// IntPtr refers to Color *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr LoadImageColors(Image image); public static extern IntPtr LoadImageColors(Image image);
/// <summary>Load colors palette from image as a Color array (RGBA - 32bit) /// <summary>Load colors palette from image as a Color array (RGBA - 32bit)<br/>
/// IntPtr refers to Color *</summary> /// IntPtr refers to Color *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr LoadImagePaletee(Image image, int maxPaletteSize, ref int colorsCount); public static extern IntPtr LoadImagePaletee(Image image, int maxPaletteSize, ref int colorsCount);
/// <summary>Unload color data loaded with LoadImageColors() /// <summary>Unload color data loaded with LoadImageColors()<br/>
/// colors refers to Color *</summary> /// colors refers to Color *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UnloadImageColors(IntPtr colors); public static extern void UnloadImageColors(IntPtr colors);
@@ -1308,7 +1306,7 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UnloadRenderTexture(RenderTexture2D target); public static extern void UnloadRenderTexture(RenderTexture2D target);
/// <summary>Update GPU texture with new data /// <summary>Update GPU texture with new data<br/>
/// pixels refers to a const void *</summary> /// pixels refers to a const void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UpdateTexture(Texture2D texture, IntPtr pixels); public static extern void UpdateTexture(Texture2D texture, IntPtr pixels);
@@ -1442,13 +1440,13 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Font LoadFontFromImage(Image image, Color key, int firstChar); public static extern Font LoadFontFromImage(Image image, Color key, int firstChar);
/// <summary>Load font from memory buffer, fileType refers to extension: i.e. "ttf" /// <summary>Load font from memory buffer, fileType refers to extension: i.e. "ttf"<br/>
/// fileData refers to const unsigned char *</summary> /// fileData refers to const unsigned char *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Font LoadFontFromMemory(string fileType, IntPtr fileData, int dataSize, int fontSize, int[] fontChars, int charsCount); public static extern Font LoadFontFromMemory(string fileType, IntPtr fileData, int dataSize, int fontSize, int[] fontChars, int charsCount);
/// <summary>Load font data for further use /// <summary>Load font data for further use<br/>
/// fileData refers to const unsigned char * /// fileData refers to const unsigned char *<br/>
/// IntPtr refers to GlyphInfo *</summary> /// IntPtr refers to GlyphInfo *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr LoadFontData(IntPtr fileData, int dataSize, int fontSize, int[] fontChars, int charsCount, FontType type); 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)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Image GenImageFontAtlas(IntPtr chars, ref IntPtr recs, int charsCount, int fontSize, int padding, int packMethod); public static extern Image GenImageFontAtlas(IntPtr chars, ref IntPtr recs, int charsCount, int fontSize, int padding, int packMethod);
/// <summary>Unload font chars info data (RAM) /// <summary>Unload font chars info data (RAM)<br/>
/// chars refers to GlpyhInfo *</summary> /// chars refers to GlpyhInfo *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UnloadFontData(IntPtr chars, int charsCount); public static extern void UnloadFontData(IntPtr chars, int charsCount);
@@ -1542,7 +1540,7 @@ namespace Raylib_cs
// UTF8 text strings management functions // UTF8 text strings management functions
/// <summary>Get all codepoints in a string, codepoints count returned by parameters /// <summary>Get all codepoints in a string, codepoints count returned by parameters<br/>
/// IntPtr refers to a int *</summary> /// IntPtr refers to a int *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr GetCodepoints(string text, ref int count); public static extern IntPtr GetCodepoints(string text, ref int count);
@@ -1683,8 +1681,8 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UploadMesh(ref Mesh mesh, CBool dynamic); public static extern void UploadMesh(ref Mesh mesh, CBool dynamic);
/// <summary>Update mesh vertex data in GPU for a specific buffer index</summary> /// <summary>Update mesh vertex data in GPU for a specific buffer index<br/>
/// <summary>data refers to a void *</summary> /// data refers to a void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UpdateMeshBuffer(Mesh mesh, int index, IntPtr data, int dataSize, int offset); 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 // Material loading/unloading functions
/// <summary>Load materials from model file /// <summary>Load materials from model file<br/>
/// IntPtr refers to Material *</summary> /// IntPtr refers to Material *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr LoadMaterials(string fileName, ref int materialCount); public static extern IntPtr LoadMaterials(string fileName, ref int materialCount);
@@ -1823,7 +1821,7 @@ namespace Raylib_cs
// Model animations loading/unloading functions // Model animations loading/unloading functions
/// <summary>Load model animations from file /// <summary>Load model animations from file<br/>
/// IntPtr refers to ModelAnimation *</summary> /// IntPtr refers to ModelAnimation *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr LoadModelAnimations(string fileName, ref int animsCount); public static extern IntPtr LoadModelAnimations(string fileName, ref int animsCount);
@@ -1912,7 +1910,7 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Wave LoadWave(string fileName); public static extern Wave LoadWave(string fileName);
/// <summary>Load wave from memory buffer, fileType refers to extension: i.e. "wav" /// <summary>Load wave from memory buffer, fileType refers to extension: i.e. "wav"<br/>
/// fileData refers to a const unsigned char *</summary> /// fileData refers to a const unsigned char *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Wave LoadWaveFromMemory(string fileType, IntPtr fileData, int dataSize); public static extern Wave LoadWaveFromMemory(string fileType, IntPtr fileData, int dataSize);
@@ -1925,8 +1923,8 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern Sound LoadSoundFromWave(Wave wave); public static extern Sound LoadSoundFromWave(Wave wave);
/// <summary>Update sound buffer with new data</summary> /// <summary>Update sound buffer with new data<br/>
/// <summary>data refers to a const void *</summary> /// refers to a const void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UpdateSound(Sound sound, IntPtr data, int samplesCount); public static extern void UpdateSound(Sound sound, IntPtr data, int samplesCount);
@@ -2001,12 +1999,12 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void WaveCrop(ref Wave wave, int initSample, int finalSample); public static extern void WaveCrop(ref Wave wave, int initSample, int finalSample);
/// <summary>Get samples data from wave as a floats array /// <summary>Get samples data from wave as a floats array<br/>
/// IntPtr refers to float *</summary> /// IntPtr refers to float *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr LoadWaveSamples(Wave wave); public static extern IntPtr LoadWaveSamples(Wave wave);
/// <summary>Unload samples data loaded with LoadWaveSamples() /// <summary>Unload samples data loaded with LoadWaveSamples()<br/>
/// samples refers to float *</summary> /// samples refers to float *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UnloadWaveSamples(IntPtr samples); public static extern void UnloadWaveSamples(IntPtr samples);
@@ -2080,7 +2078,7 @@ namespace Raylib_cs
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UnloadAudioStream(AudioStream stream); public static extern void UnloadAudioStream(AudioStream stream);
/// <summary>Update audio stream buffers with data /// <summary>Update audio stream buffers with data<br/>
/// data refers to a const void *</summary> /// data refers to a const void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void UpdateAudioStream(AudioStream stream, IntPtr data, int samplesCount); public static extern void UpdateAudioStream(AudioStream stream, IntPtr data, int samplesCount);

View File

@@ -493,7 +493,7 @@ namespace Raylib_cs
// Textures data management // Textures data management
/// <summary>Load texture in GPU /// <summary>Load texture in GPU<br/>
/// data refers to a void *</summary> /// data refers to a void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern uint rlLoadTexture(IntPtr data, int width, int height, PixelFormat format, int mipmapCount); 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)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern uint rlLoadTextureDepth(int width, int height, CBool useRenderBuffer); public static extern uint rlLoadTextureDepth(int width, int height, CBool useRenderBuffer);
/// <summary>Load texture cubemap /// <summary>Load texture cubemap<br/>
/// data refers to a void *</summary> /// data refers to a void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern uint rlLoadTextureCubemap(IntPtr data, int size, PixelFormat format); public static extern uint rlLoadTextureCubemap(IntPtr data, int size, PixelFormat format);
/// <summary>Update GPU texture with new data /// <summary>Update GPU texture with new data<br/>
/// data refers to a const void *</summary> /// data refers to a const void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void rlUpdateTexture(uint id, int width, int height, PixelFormat format, IntPtr data); 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)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern void rlGenerateMipmaps(ref Texture2D texture); public static extern void rlGenerateMipmaps(ref Texture2D texture);
/// <summary>Read texture pixel data /// <summary>Read texture pixel data<br/>
/// IntPtr refers to a void *</summary> /// IntPtr refers to a void *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr rlReadTexturePixels(Texture2D texture); public static extern IntPtr rlReadTexturePixels(Texture2D texture);
/// <summary>Read screen pixel data (color buffer) /// <summary>Read screen pixel data (color buffer)<br/>
/// IntPtr refers to a unsigned char *</summary> /// IntPtr refers to a unsigned char *</summary>
[DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)] [DllImport(nativeLibName, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr rlReadScreenPixels(int width, int height); public static extern IntPtr rlReadScreenPixels(int width, int height);

View File

@@ -36,7 +36,7 @@ namespace Raylib_cs
} }
/// <summary> /// <summary>
/// Audio stream type /// Audio stream type<br/>
/// NOTE: Useful to create custom audio streams not bound to a specific file /// NOTE: Useful to create custom audio streams not bound to a specific file
/// </summary> /// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
@@ -81,7 +81,7 @@ namespace Raylib_cs
} }
/// <summary> /// <summary>
/// Music stream type (audio file streaming from memory) /// Music stream type (audio file streaming from memory)<br/>
/// NOTE: Anything longer than ~10 seconds should be streamed /// NOTE: Anything longer than ~10 seconds should be streamed
/// </summary> /// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]

View File

@@ -3,8 +3,10 @@ using System.Runtime.InteropServices;
namespace Raylib_cs namespace Raylib_cs
{ {
/// <summary>Pixel formats /// <summary>
/// NOTE: Support depends on OpenGL version and platform</summary> /// Pixel formats<br/>
/// NOTE: Support depends on OpenGL version and platform
/// </summary>
public enum PixelFormat public enum PixelFormat
{ {
/// <summary> /// <summary>

View File

@@ -4,9 +4,10 @@ using System.Runtime.InteropServices;
namespace Raylib_cs namespace Raylib_cs
{ {
/// <summary>Keyboard keys (US keyboard layout) /// <summary>
/// NOTE: Use GetKeyPressed() to allow redefining /// Keyboard keys (US keyboard layout)<br/>
/// required keys for alternative layouts</summary> /// NOTE: Use GetKeyPressed() to allow redefining required keys for alternative layouts
/// </summary>
public enum KeyboardKey public enum KeyboardKey
{ {
/// <summary> /// <summary>
@@ -350,8 +351,10 @@ namespace Raylib_cs
GAMEPAD_BUTTON_RIGHT_THUMB GAMEPAD_BUTTON_RIGHT_THUMB
} }
/// <summary>Gesture /// <summary>
/// NOTE: It could be used as flags to enable only some gestures</summary> /// Gesture<br/>
/// NOTE: It could be used as flags to enable only some gestures
/// </summary>
[Flags] [Flags]
public enum Gesture public enum Gesture
{ {

View File

@@ -27,7 +27,7 @@ namespace Raylib_cs
} }
/// <summary> /// <summary>
/// Vertex data definning a mesh /// Vertex data definning a mesh<br/>
/// NOTE: Data stored in CPU memory (and GPU) /// NOTE: Data stored in CPU memory (and GPU)
/// </summary> /// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]

View File

@@ -2,9 +2,11 @@ using System.Runtime.InteropServices;
namespace Raylib_cs namespace Raylib_cs
{ {
/// <summary>Texture parameters: filter mode /// <summary>
/// NOTE 1: Filtering considers mipmaps if available in the texture /// Texture parameters: filter mode<br/>
/// NOTE 2: Filter is accordingly set for minification and magnification</summary> /// NOTE 1: Filtering considers mipmaps if available in the texture<br/>
/// NOTE 2: Filter is accordingly set for minification and magnification
/// </summary>
public enum TextureFilter public enum TextureFilter
{ {
/// <summary> /// <summary>
@@ -97,8 +99,7 @@ namespace Raylib_cs
} }
/// <summary> /// <summary>
/// Texture2D type /// Texture2D type<br />
/// <br />
/// NOTE: Data stored in GPU memory /// NOTE: Data stored in GPU memory
/// </summary> /// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]