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

More XmlDoc comments

This commit is contained in:
2021-11-11 12:00:42 +00:00
parent 88c14c6350
commit f9e39d3226
8 changed files with 63 additions and 27 deletions

View File

@@ -38,7 +38,9 @@ namespace Raylib_cs
}
}
/// <summary>Camera system modes</summary>
/// <summary>
/// Camera system modes
/// </summary>
public enum CameraMode
{
CAMERA_CUSTOM = 0,
@@ -48,7 +50,9 @@ namespace Raylib_cs
CAMERA_THIRD_PERSON
}
/// <summary>Camera projection</summary>
/// <summary>
/// Camera projection
/// </summary>
public enum CameraProjection
{
CAMERA_PERSPECTIVE = 0,

View File

@@ -2,9 +2,11 @@ using System;
namespace Raylib_cs
{
/// <summary>System config flags
/// NOTE: Every bit registers one state (use it with bit masks)
/// By default all flags are set to 0</summary>
/// <summary>
/// System config flags<br/>
/// NOTE: Every bit registers one state (use it with bit masks)<br/>
/// By default all flags are set to 0
/// </summary>
[Flags]
public enum ConfigFlags
{
@@ -79,8 +81,10 @@ namespace Raylib_cs
FLAG_INTERLACED_HINT = 0x00010000,
}
/// <summary>Trace log level
/// NOTE: Organized by priority level</summary>
/// <summary>
/// Trace log level<br/>
/// NOTE: Organized by priority level
/// </summary>
public enum TraceLogLevel
{
/// <summary>
@@ -124,7 +128,9 @@ namespace Raylib_cs
LOG_NONE
}
/// <summary>Color blending modes (pre-defined)</summary>
/// <summary>
/// Color blending modes (pre-defined)
/// </summary>
public enum BlendMode
{
/// <summary>

View File

@@ -3,7 +3,9 @@ using System.Runtime.InteropServices;
namespace Raylib_cs
{
/// <summary>Font type, defines generation method</summary>
/// <summary>
/// Font type, defines generation method
/// </summary>
public enum FontType
{
/// <summary>

View File

@@ -133,7 +133,9 @@ namespace Raylib_cs
KEY_VOLUME_DOWN = 25
}
/// <summary>Mouse buttons</summary>
/// <summary>
/// Mouse buttons
/// </summary>
public enum MouseButton
{
/// <summary>
@@ -176,7 +178,9 @@ namespace Raylib_cs
MOUSE_MIDDLE_BUTTON = MOUSE_BUTTON_MIDDLE,
}
/// <summary>Mouse cursor</summary>
/// <summary>
/// Mouse cursor
/// </summary>
public enum MouseCursor
{
/// <summary>
@@ -269,7 +273,9 @@ namespace Raylib_cs
GAMEPAD_AXIS_RIGHT_TRIGGER = 5
}
/// <summary>Gamepad buttons</summary>
/// <summary>
/// Gamepad buttons
/// </summary>
public enum GamepadButton
{
/// <summary>
@@ -371,7 +377,9 @@ namespace Raylib_cs
GESTURE_PINCH_OUT = 512
}
/// <summary>Head-Mounted-Display device parameters</summary>
/// <summary>
/// Head-Mounted-Display device parameters
/// </summary>
[StructLayout(LayoutKind.Sequential)]
public unsafe struct VrDeviceInfo
{
@@ -426,7 +434,9 @@ namespace Raylib_cs
public fixed float chromaAbCorrection[4];
}
/// <summary>VR Stereo rendering configuration for simulator</summary>
/// <summary>
/// VR Stereo rendering configuration for simulator
/// </summary>
[StructLayout(LayoutKind.Sequential)]
public struct VrStereoConfig
{

View File

@@ -3,21 +3,23 @@ using System.Runtime.InteropServices;
namespace Raylib_cs
{
/// <summary>Material map index</summary>
/// <summary>
/// Material map index
/// </summary>
public enum MaterialMapIndex
{
/// <summary>
/// MAP_DIFFUSE
/// NOTE: Same as MATERIAL_MAP_DIFFUSE
/// </summary>
MATERIAL_MAP_ALBEDO = 0,
/// <summary>
/// MAP_SPECULAR
/// NOTE: Same as MATERIAL_MAP_SPECULAR
/// </summary>
MATERIAL_MAP_METALNESS = 1,
MATERIAL_MAP_METALNESS,
MATERIAL_MAP_NORMAL = 2,
MATERIAL_MAP_ROUGHNESS = 3,
MATERIAL_MAP_NORMAL,
MATERIAL_MAP_ROUGHNESS,
MATERIAL_MAP_OCCLUSION,
MATERIAL_MAP_EMISSION,
MATERIAL_MAP_HEIGHT,

View File

@@ -2,7 +2,9 @@ using System.Runtime.InteropServices;
namespace Raylib_cs
{
/// <summary>N-patch layout</summary>
/// <summary>
/// N-patch layout
/// </summary>
public enum NPatchLayout
{
/// <summary>

View File

@@ -3,7 +3,9 @@ using System.Runtime.InteropServices;
namespace Raylib_cs
{
/// <summary>Shader location index</summary>
/// <summary>
/// Shader location index
/// </summary>
public enum ShaderLocationIndex
{
SHADER_LOC_VERTEX_POSITION = 0,
@@ -37,7 +39,9 @@ namespace Raylib_cs
SHADER_LOC_MAP_SPECULAR = SHADER_LOC_MAP_METALNESS,
}
// Shader attribute data types
/// <summary>
/// Shader attribute data types
/// </summary>
public enum ShaderAttributeDataType
{
SHADER_ATTRIB_FLOAT = 0,
@@ -46,7 +50,9 @@ namespace Raylib_cs
SHADER_ATTRIB_VEC4
}
/// <summary>Shader uniform data type</summary>
/// <summary>
/// Shader uniform data type
/// </summary>
public enum ShaderUniformDataType
{
SHADER_UNIFORM_FLOAT = 0,

View File

@@ -40,7 +40,9 @@ namespace Raylib_cs
TEXTURE_FILTER_ANISOTROPIC_16X,
}
/// <summary>Texture parameters: wrap mode</summary>
/// <summary>
/// Texture parameters: wrap mode
/// </summary>
public enum TextureWrap
{
/// <summary>
@@ -64,7 +66,9 @@ namespace Raylib_cs
TEXTURE_WRAP_MIRROR_CLAMP
}
/// <summary>Cubemap layouts</summary>
/// <summary>
/// Cubemap layouts
/// </summary>
public enum CubemapLayout
{
/// <summary>
@@ -99,7 +103,7 @@ namespace Raylib_cs
}
/// <summary>
/// Texture2D type<br />
/// Texture2D type<br/>
/// NOTE: Data stored in GPU memory
/// </summary>
[StructLayout(LayoutKind.Sequential)]