MrMonopoly/raylib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix: update API docs to use Is*Valid()

Browse Source
This commit is contained in:
RenzoRomeo 2024-04-28 18:55:28 -03:00
parent c14082d6da
commit 8da5fae783
4 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
parser/output/raylib_api.json
View File

@ -3739,7 +3739,7 @@
}, },
{ {
"name": "IsShaderValid", "name": "IsShaderValid",
"description": "Check if a shader is ready", "description": "Check if a shader is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -6839,7 +6839,7 @@
}, },
{ {
"name": "IsImageValid", "name": "IsImageValid",
"description": "Check if an image is ready", "description": "Check if an image is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -8126,7 +8126,7 @@
}, },
{ {
"name": "IsTextureValid", "name": "IsTextureValid",
"description": "Check if a texture is ready", "description": "Check if a texture is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -8148,7 +8148,7 @@
}, },
{ {
"name": "IsRenderTextureValid", "name": "IsRenderTextureValid",
"description": "Check if a render texture is ready", "description": "Check if a render texture is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -8724,7 +8724,7 @@
}, },
{ {
"name": "IsFontValid", "name": "IsFontValid",
"description": "Check if a font is ready", "description": "Check if a font is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -9994,7 +9994,7 @@
}, },
{ {
"name": "IsModelValid", "name": "IsModelValid",
"description": "Check if a model is ready", "description": "Check if a model is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -10627,7 +10627,7 @@
}, },
{ {
"name": "IsMaterialValid", "name": "IsMaterialValid",
"description": "Check if a material is ready", "description": "Check if a material is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -10983,7 +10983,7 @@
}, },
{ {
"name": "IsWaveValid", "name": "IsWaveValid",
"description": "Checks if wave data is ready", "description": "Checks if wave data is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -11027,7 +11027,7 @@
}, },
{ {
"name": "IsSoundValid", "name": "IsSoundValid",
"description": "Checks if a sound is ready", "description": "Checks if a sound is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -11325,7 +11325,7 @@
}, },
{ {
"name": "IsMusicValid", "name": "IsMusicValid",
"description": "Checks if a music stream is ready", "description": "Checks if a music stream is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {
@ -11514,7 +11514,7 @@
}, },
{ {
"name": "IsAudioStreamValid", "name": "IsAudioStreamValid",
"description": "Checks if an audio stream is ready", "description": "Checks if an audio stream is valid",
"returnType": "bool", "returnType": "bool",
"params": [ "params": [
{ {

22
parser/output/raylib_api.lua
View File

@ -3565,7 +3565,7 @@ return {
}, },
{ {
name = "IsShaderValid", name = "IsShaderValid",
description = "Check if a shader is ready", description = "Check if a shader is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Shader", name = "shader"} {type = "Shader", name = "shader"}
@ -5342,7 +5342,7 @@ return {
}, },
{ {
name = "IsImageValid", name = "IsImageValid",
description = "Check if an image is ready", description = "Check if an image is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Image", name = "image"} {type = "Image", name = "image"}
@ -6026,7 +6026,7 @@ return {
}, },
{ {
name = "IsTextureValid", name = "IsTextureValid",
description = "Check if a texture is ready", description = "Check if a texture is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Texture2D", name = "texture"} {type = "Texture2D", name = "texture"}
@ -6042,7 +6042,7 @@ return {
}, },
{ {
name = "IsRenderTextureValid", name = "IsRenderTextureValid",
description = "Check if a render texture is ready", description = "Check if a render texture is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "RenderTexture2D", name = "target"} {type = "RenderTexture2D", name = "target"}
@ -6363,7 +6363,7 @@ return {
}, },
{ {
name = "IsFontValid", name = "IsFontValid",
description = "Check if a font is ready", description = "Check if a font is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Font", name = "font"} {type = "Font", name = "font"}
@ -7027,7 +7027,7 @@ return {
}, },
{ {
name = "IsModelValid", name = "IsModelValid",
description = "Check if a model is ready", description = "Check if a model is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Model", name = "model"} {type = "Model", name = "model"}
@ -7357,7 +7357,7 @@ return {
}, },
{ {
name = "IsMaterialValid", name = "IsMaterialValid",
description = "Check if a material is ready", description = "Check if a material is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Material", name = "material"} {type = "Material", name = "material"}
@ -7566,7 +7566,7 @@ return {
}, },
{ {
name = "IsWaveValid", name = "IsWaveValid",
description = "Checks if wave data is ready", description = "Checks if wave data is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Wave", name = "wave"} {type = "Wave", name = "wave"}
@ -7598,7 +7598,7 @@ return {
}, },
{ {
name = "IsSoundValid", name = "IsSoundValid",
description = "Checks if a sound is ready", description = "Checks if a sound is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Sound", name = "sound"} {type = "Sound", name = "sound"}
@ -7788,7 +7788,7 @@ return {
}, },
{ {
name = "IsMusicValid", name = "IsMusicValid",
description = "Checks if a music stream is ready", description = "Checks if a music stream is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "Music", name = "music"} {type = "Music", name = "music"}
@ -7914,7 +7914,7 @@ return {
}, },
{ {
name = "IsAudioStreamValid", name = "IsAudioStreamValid",
description = "Checks if an audio stream is ready", description = "Checks if an audio stream is valid",
returnType = "bool", returnType = "bool",
params = { params = {
{type = "AudioStream", name = "stream"} {type = "AudioStream", name = "stream"}

22
parser/output/raylib_api.txt
View File

@ -1376,7 +1376,7 @@ Function 075: LoadShaderFromMemory() (2 input parameters)
Function 076: IsShaderValid() (1 input parameters) Function 076: IsShaderValid() (1 input parameters)
Name: IsShaderValid Name: IsShaderValid
Return type: bool Return type: bool
Description: Check if a shader is ready Description: Check if a shader is valid
Param[1]: shader (type: Shader) Param[1]: shader (type: Shader)
Function 077: GetShaderLocation() (2 input parameters) Function 077: GetShaderLocation() (2 input parameters)
Name: GetShaderLocation Name: GetShaderLocation
@ -2649,7 +2649,7 @@ Function 275: LoadImageFromScreen() (0 input parameters)
Function 276: IsImageValid() (1 input parameters) Function 276: IsImageValid() (1 input parameters)
Name: IsImageValid Name: IsImageValid
Return type: bool Return type: bool
Description: Check if an image is ready Description: Check if an image is valid
Param[1]: image (type: Image) Param[1]: image (type: Image)
Function 277: UnloadImage() (1 input parameters) Function 277: UnloadImage() (1 input parameters)
Name: UnloadImage Name: UnloadImage
@ -3126,7 +3126,7 @@ Function 344: LoadRenderTexture() (2 input parameters)
Function 345: IsTextureValid() (1 input parameters) Function 345: IsTextureValid() (1 input parameters)
Name: IsTextureValid Name: IsTextureValid
Return type: bool Return type: bool
Description: Check if a texture is ready Description: Check if a texture is valid
Param[1]: texture (type: Texture2D) Param[1]: texture (type: Texture2D)
Function 346: UnloadTexture() (1 input parameters) Function 346: UnloadTexture() (1 input parameters)
Name: UnloadTexture Name: UnloadTexture
@ -3136,7 +3136,7 @@ Function 346: UnloadTexture() (1 input parameters)
Function 347: IsRenderTextureValid() (1 input parameters) Function 347: IsRenderTextureValid() (1 input parameters)
Name: IsRenderTextureValid Name: IsRenderTextureValid
Return type: bool Return type: bool
Description: Check if a render texture is ready Description: Check if a render texture is valid
Param[1]: target (type: RenderTexture2D) Param[1]: target (type: RenderTexture2D)
Function 348: UnloadRenderTexture() (1 input parameters) Function 348: UnloadRenderTexture() (1 input parameters)
Name: UnloadRenderTexture Name: UnloadRenderTexture
@ -3358,7 +3358,7 @@ Function 380: LoadFontFromMemory() (6 input parameters)
Function 381: IsFontValid() (1 input parameters) Function 381: IsFontValid() (1 input parameters)
Name: IsFontValid Name: IsFontValid
Return type: bool Return type: bool
Description: Check if a font is ready Description: Check if a font is valid
Param[1]: font (type: Font) Param[1]: font (type: Font)
Function 382: LoadFontData() (6 input parameters) Function 382: LoadFontData() (6 input parameters)
Name: LoadFontData Name: LoadFontData
@ -3824,7 +3824,7 @@ Function 446: LoadModelFromMesh() (1 input parameters)
Function 447: IsModelValid() (1 input parameters) Function 447: IsModelValid() (1 input parameters)
Name: IsModelValid Name: IsModelValid
Return type: bool Return type: bool
Description: Check if a model is ready Description: Check if a model is valid
Param[1]: model (type: Model) Param[1]: model (type: Model)
Function 448: UnloadModel() (1 input parameters) Function 448: UnloadModel() (1 input parameters)
Name: UnloadModel Name: UnloadModel
@ -4058,7 +4058,7 @@ Function 479: LoadMaterialDefault() (0 input parameters)
Function 480: IsMaterialValid() (1 input parameters) Function 480: IsMaterialValid() (1 input parameters)
Name: IsMaterialValid Name: IsMaterialValid
Return type: bool Return type: bool
Description: Check if a material is ready Description: Check if a material is valid
Param[1]: material (type: Material) Param[1]: material (type: Material)
Function 481: UnloadMaterial() (1 input parameters) Function 481: UnloadMaterial() (1 input parameters)
Name: UnloadMaterial Name: UnloadMaterial
@ -4207,7 +4207,7 @@ Function 503: LoadWaveFromMemory() (3 input parameters)
Function 504: IsWaveValid() (1 input parameters) Function 504: IsWaveValid() (1 input parameters)
Name: IsWaveValid Name: IsWaveValid
Return type: bool Return type: bool
Description: Checks if wave data is ready Description: Checks if wave data is valid
Param[1]: wave (type: Wave) Param[1]: wave (type: Wave)
Function 505: LoadSound() (1 input parameters) Function 505: LoadSound() (1 input parameters)
Name: LoadSound Name: LoadSound
@ -4227,7 +4227,7 @@ Function 507: LoadSoundAlias() (1 input parameters)
Function 508: IsSoundValid() (1 input parameters) Function 508: IsSoundValid() (1 input parameters)
Name: IsSoundValid Name: IsSoundValid
Return type: bool Return type: bool
Description: Checks if a sound is ready Description: Checks if a sound is valid
Param[1]: sound (type: Sound) Param[1]: sound (type: Sound)
Function 509: UpdateSound() (3 input parameters) Function 509: UpdateSound() (3 input parameters)
Name: UpdateSound Name: UpdateSound
@ -4351,7 +4351,7 @@ Function 529: LoadMusicStreamFromMemory() (3 input parameters)
Function 530: IsMusicValid() (1 input parameters) Function 530: IsMusicValid() (1 input parameters)
Name: IsMusicValid Name: IsMusicValid
Return type: bool Return type: bool
Description: Checks if a music stream is ready Description: Checks if a music stream is valid
Param[1]: music (type: Music) Param[1]: music (type: Music)
Function 531: UnloadMusicStream() (1 input parameters) Function 531: UnloadMusicStream() (1 input parameters)
Name: UnloadMusicStream Name: UnloadMusicStream
@ -4432,7 +4432,7 @@ Function 544: LoadAudioStream() (3 input parameters)
Function 545: IsAudioStreamValid() (1 input parameters) Function 545: IsAudioStreamValid() (1 input parameters)
Name: IsAudioStreamValid Name: IsAudioStreamValid
Return type: bool Return type: bool
Description: Checks if an audio stream is ready Description: Checks if an audio stream is valid
Param[1]: stream (type: AudioStream) Param[1]: stream (type: AudioStream)
Function 546: UnloadAudioStream() (1 input parameters) Function 546: UnloadAudioStream() (1 input parameters)
Name: UnloadAudioStream Name: UnloadAudioStream

22
parser/output/raylib_api.xml
View File

@ -866,7 +866,7 @@
<Param type="const char *" name="vsCode" desc="" /> <Param type="const char *" name="vsCode" desc="" />
<Param type="const char *" name="fsCode" desc="" /> <Param type="const char *" name="fsCode" desc="" />
</Function> </Function>
<Function name="IsShaderValid" retType="bool" paramCount="1" desc="Check if a shader is ready"> <Function name="IsShaderValid" retType="bool" paramCount="1" desc="Check if a shader is valid">
<Param type="Shader" name="shader" desc="" /> <Param type="Shader" name="shader" desc="" />
</Function> </Function>
<Function name="GetShaderLocation" retType="int" paramCount="2" desc="Get shader uniform location"> <Function name="GetShaderLocation" retType="int" paramCount="2" desc="Get shader uniform location">
@ -1707,7 +1707,7 @@
</Function> </Function>
<Function name="LoadImageFromScreen" retType="Image" paramCount="0" desc="Load image from screen buffer and (screenshot)"> <Function name="LoadImageFromScreen" retType="Image" paramCount="0" desc="Load image from screen buffer and (screenshot)">
</Function> </Function>
<Function name="IsImageValid" retType="bool" paramCount="1" desc="Check if an image is ready"> <Function name="IsImageValid" retType="bool" paramCount="1" desc="Check if an image is valid">
<Param type="Image" name="image" desc="" /> <Param type="Image" name="image" desc="" />
</Function> </Function>
<Function name="UnloadImage" retType="void" paramCount="1" desc="Unload image from CPU memory (RAM)"> <Function name="UnloadImage" retType="void" paramCount="1" desc="Unload image from CPU memory (RAM)">
@ -2046,13 +2046,13 @@
<Param type="int" name="width" desc="" /> <Param type="int" name="width" desc="" />
<Param type="int" name="height" desc="" /> <Param type="int" name="height" desc="" />
</Function> </Function>
<Function name="IsTextureValid" retType="bool" paramCount="1" desc="Check if a texture is ready"> <Function name="IsTextureValid" retType="bool" paramCount="1" desc="Check if a texture is valid">
<Param type="Texture2D" name="texture" desc="" /> <Param type="Texture2D" name="texture" desc="" />
</Function> </Function>
<Function name="UnloadTexture" retType="void" paramCount="1" desc="Unload texture from GPU memory (VRAM)"> <Function name="UnloadTexture" retType="void" paramCount="1" desc="Unload texture from GPU memory (VRAM)">
<Param type="Texture2D" name="texture" desc="" /> <Param type="Texture2D" name="texture" desc="" />
</Function> </Function>
<Function name="IsRenderTextureValid" retType="bool" paramCount="1" desc="Check if a render texture is ready"> <Function name="IsRenderTextureValid" retType="bool" paramCount="1" desc="Check if a render texture is valid">
<Param type="RenderTexture2D" name="target" desc="" /> <Param type="RenderTexture2D" name="target" desc="" />
</Function> </Function>
<Function name="UnloadRenderTexture" retType="void" paramCount="1" desc="Unload render texture from GPU memory (VRAM)"> <Function name="UnloadRenderTexture" retType="void" paramCount="1" desc="Unload render texture from GPU memory (VRAM)">
@ -2205,7 +2205,7 @@
<Param type="int *" name="codepoints" desc="" /> <Param type="int *" name="codepoints" desc="" />
<Param type="int" name="codepointCount" desc="" /> <Param type="int" name="codepointCount" desc="" />
</Function> </Function>
<Function name="IsFontValid" retType="bool" paramCount="1" desc="Check if a font is ready"> <Function name="IsFontValid" retType="bool" paramCount="1" desc="Check if a font is valid">
<Param type="Font" name="font" desc="" /> <Param type="Font" name="font" desc="" />
</Function> </Function>
<Function name="LoadFontData" retType="GlyphInfo *" paramCount="6" desc="Load font data for further use"> <Function name="LoadFontData" retType="GlyphInfo *" paramCount="6" desc="Load font data for further use">
@ -2539,7 +2539,7 @@
<Function name="LoadModelFromMesh" retType="Model" paramCount="1" desc="Load model from generated mesh (default material)"> <Function name="LoadModelFromMesh" retType="Model" paramCount="1" desc="Load model from generated mesh (default material)">
<Param type="Mesh" name="mesh" desc="" /> <Param type="Mesh" name="mesh" desc="" />
</Function> </Function>
<Function name="IsModelValid" retType="bool" paramCount="1" desc="Check if a model is ready"> <Function name="IsModelValid" retType="bool" paramCount="1" desc="Check if a model is valid">
<Param type="Model" name="model" desc="" /> <Param type="Model" name="model" desc="" />
</Function> </Function>
<Function name="UnloadModel" retType="void" paramCount="1" desc="Unload model (including meshes) from memory (RAM and/or VRAM)"> <Function name="UnloadModel" retType="void" paramCount="1" desc="Unload model (including meshes) from memory (RAM and/or VRAM)">
@ -2706,7 +2706,7 @@
</Function> </Function>
<Function name="LoadMaterialDefault" retType="Material" paramCount="0" desc="Load default material (Supports: DIFFUSE, SPECULAR, NORMAL maps)"> <Function name="LoadMaterialDefault" retType="Material" paramCount="0" desc="Load default material (Supports: DIFFUSE, SPECULAR, NORMAL maps)">
</Function> </Function>
<Function name="IsMaterialValid" retType="bool" paramCount="1" desc="Check if a material is ready"> <Function name="IsMaterialValid" retType="bool" paramCount="1" desc="Check if a material is valid">
<Param type="Material" name="material" desc="" /> <Param type="Material" name="material" desc="" />
</Function> </Function>
<Function name="UnloadMaterial" retType="void" paramCount="1" desc="Unload material from GPU memory (VRAM)"> <Function name="UnloadMaterial" retType="void" paramCount="1" desc="Unload material from GPU memory (VRAM)">
@ -2803,7 +2803,7 @@
<Param type="const unsigned char *" name="fileData" desc="" /> <Param type="const unsigned char *" name="fileData" desc="" />
<Param type="int" name="dataSize" desc="" /> <Param type="int" name="dataSize" desc="" />
</Function> </Function>
<Function name="IsWaveValid" retType="bool" paramCount="1" desc="Checks if wave data is ready"> <Function name="IsWaveValid" retType="bool" paramCount="1" desc="Checks if wave data is valid">
<Param type="Wave" name="wave" desc="" /> <Param type="Wave" name="wave" desc="" />
</Function> </Function>
<Function name="LoadSound" retType="Sound" paramCount="1" desc="Load sound from file"> <Function name="LoadSound" retType="Sound" paramCount="1" desc="Load sound from file">
@ -2815,7 +2815,7 @@
<Function name="LoadSoundAlias" retType="Sound" paramCount="1" desc="Create a new sound that shares the same sample data as the source sound, does not own the sound data"> <Function name="LoadSoundAlias" retType="Sound" paramCount="1" desc="Create a new sound that shares the same sample data as the source sound, does not own the sound data">
<Param type="Sound" name="source" desc="" /> <Param type="Sound" name="source" desc="" />
</Function> </Function>
<Function name="IsSoundValid" retType="bool" paramCount="1" desc="Checks if a sound is ready"> <Function name="IsSoundValid" retType="bool" paramCount="1" desc="Checks if a sound is valid">
<Param type="Sound" name="sound" desc="" /> <Param type="Sound" name="sound" desc="" />
</Function> </Function>
<Function name="UpdateSound" retType="void" paramCount="3" desc="Update sound buffer with new data"> <Function name="UpdateSound" retType="void" paramCount="3" desc="Update sound buffer with new data">
@ -2895,7 +2895,7 @@
<Param type="const unsigned char *" name="data" desc="" /> <Param type="const unsigned char *" name="data" desc="" />
<Param type="int" name="dataSize" desc="" /> <Param type="int" name="dataSize" desc="" />
</Function> </Function>
<Function name="IsMusicValid" retType="bool" paramCount="1" desc="Checks if a music stream is ready"> <Function name="IsMusicValid" retType="bool" paramCount="1" desc="Checks if a music stream is valid">
<Param type="Music" name="music" desc="" /> <Param type="Music" name="music" desc="" />
</Function> </Function>
<Function name="UnloadMusicStream" retType="void" paramCount="1" desc="Unload music stream"> <Function name="UnloadMusicStream" retType="void" paramCount="1" desc="Unload music stream">
@ -2946,7 +2946,7 @@
<Param type="unsigned int" name="sampleSize" desc="" /> <Param type="unsigned int" name="sampleSize" desc="" />
<Param type="unsigned int" name="channels" desc="" /> <Param type="unsigned int" name="channels" desc="" />
</Function> </Function>
<Function name="IsAudioStreamValid" retType="bool" paramCount="1" desc="Checks if an audio stream is ready"> <Function name="IsAudioStreamValid" retType="bool" paramCount="1" desc="Checks if an audio stream is valid">
<Param type="AudioStream" name="stream" desc="" /> <Param type="AudioStream" name="stream" desc="" />
</Function> </Function>
<Function name="UnloadAudioStream" retType="void" paramCount="1" desc="Unload audio stream and free memory"> <Function name="UnloadAudioStream" retType="void" paramCount="1" desc="Unload audio stream and free memory">