summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authoraiafrasinei <[email protected]>2024-03-07 13:28:11 +0200
committerGitHub <[email protected]>2024-03-07 12:28:11 +0100
commit3b7be851515bf8ec4d9585352a5df8ba5aa85ac0 (patch)
treef44af34c88922f0f90d39e1837c7ec08d30b3ff4
parentfccdfa7926260339a66a5590c0246f4c158c5970 (diff)
downloadraylib-3b7be851515bf8ec4d9585352a5df8ba5aa85ac0.tar.gz
raylib-3b7be851515bf8ec4d9585352a5df8ba5aa85ac0.zip
Screen space related functions consistency (#3830)
* Screen/world-space related functions rename * Update raylib_api.* by CI --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
-rw-r--r--examples/core/core_3d_picking.c2
-rw-r--r--examples/models/models_loading.c2
-rw-r--r--examples/models/models_mesh_picking.c2
-rw-r--r--examples/text/text_draw_3d.c2
-rw-r--r--parser/output/raylib_api.json4
-rw-r--r--parser/output/raylib_api.lua4
-rw-r--r--parser/output/raylib_api.txt8
-rw-r--r--parser/output/raylib_api.xml4
-rw-r--r--src/raylib.h4
-rw-r--r--src/rcore.c6
10 files changed, 19 insertions, 19 deletions
diff --git a/examples/core/core_3d_picking.c b/examples/core/core_3d_picking.c
index fa6fcaec..634afba8 100644
--- a/examples/core/core_3d_picking.c
+++ b/examples/core/core_3d_picking.c
@@ -60,7 +60,7 @@ int main(void)
{
if (!collision.hit)
{
- ray = GetMouseRay(GetMousePosition(), camera);
+ ray = GetScreenToWorldRay(GetMousePosition(), camera);
// Check collision between ray and box
collision = GetRayCollisionBox(ray,
diff --git a/examples/models/models_loading.c b/examples/models/models_loading.c
index 8b4002d1..d35db347 100644
--- a/examples/models/models_loading.c
+++ b/examples/models/models_loading.c
@@ -109,7 +109,7 @@ int main(void)
if (IsMouseButtonPressed(MOUSE_BUTTON_LEFT))
{
// Check collision between ray and box
- if (GetRayCollisionBox(GetMouseRay(GetMousePosition(), camera), bounds).hit) selected = !selected;
+ if (GetRayCollisionBox(GetScreenToWorldRay(GetMousePosition(), camera), bounds).hit) selected = !selected;
else selected = false;
}
//----------------------------------------------------------------------------------
diff --git a/examples/models/models_mesh_picking.c b/examples/models/models_mesh_picking.c
index 4530d58a..15723e39 100644
--- a/examples/models/models_mesh_picking.c
+++ b/examples/models/models_mesh_picking.c
@@ -88,7 +88,7 @@ int main(void)
Color cursorColor = WHITE;
// Get ray and test against objects
- ray = GetMouseRay(GetMousePosition(), camera);
+ ray = GetScreenToWorldRay(GetMousePosition(), camera);
// Check ray collision against ground quad
RayCollision groundHitInfo = GetRayCollisionQuad(ray, g0, g1, g2, g3);
diff --git a/examples/text/text_draw_3d.c b/examples/text/text_draw_3d.c
index b279f1b3..ed4e6ce6 100644
--- a/examples/text/text_draw_3d.c
+++ b/examples/text/text_draw_3d.c
@@ -195,7 +195,7 @@ int main(void)
// Handle clicking the cube
if (IsMouseButtonPressed(MOUSE_BUTTON_LEFT))
{
- Ray ray = GetMouseRay(GetMousePosition(), camera);
+ Ray ray = GetScreenToWorldRay(GetMousePosition(), camera);
// Check collision between ray and box
RayCollision collision = GetRayCollisionBox(ray,
diff --git a/parser/output/raylib_api.json b/parser/output/raylib_api.json
index 3aec33ef..8a1594b2 100644
--- a/parser/output/raylib_api.json
+++ b/parser/output/raylib_api.json
@@ -3872,7 +3872,7 @@
]
},
{
- "name": "GetMouseRay",
+ "name": "GetScreenToWorldRay",
"description": "Get a ray trace from mouse position",
"returnType": "Ray",
"params": [
@@ -3887,7 +3887,7 @@
]
},
{
- "name": "GetViewRay",
+ "name": "GetScreenToWorldRayEx",
"description": "Get a ray trace from mouse position in a viewport",
"returnType": "Ray",
"params": [
diff --git a/parser/output/raylib_api.lua b/parser/output/raylib_api.lua
index dbcf969f..1d588fd6 100644
--- a/parser/output/raylib_api.lua
+++ b/parser/output/raylib_api.lua
@@ -3635,7 +3635,7 @@ return {
}
},
{
- name = "GetMouseRay",
+ name = "GetScreenToWorldRay",
description = "Get a ray trace from mouse position",
returnType = "Ray",
params = {
@@ -3644,7 +3644,7 @@ return {
}
},
{
- name = "GetViewRay",
+ name = "GetScreenToWorldRayEx",
description = "Get a ray trace from mouse position in a viewport",
returnType = "Ray",
params = {
diff --git a/parser/output/raylib_api.txt b/parser/output/raylib_api.txt
index 668e84bb..a0477b66 100644
--- a/parser/output/raylib_api.txt
+++ b/parser/output/raylib_api.txt
@@ -1421,14 +1421,14 @@ Function 083: UnloadShader() (1 input parameters)
Return type: void
Description: Unload shader from GPU memory (VRAM)
Param[1]: shader (type: Shader)
-Function 084: GetMouseRay() (2 input parameters)
- Name: GetMouseRay
+Function 084: GetScreenToWorldRay() (2 input parameters)
+ Name: GetScreenToWorldRay
Return type: Ray
Description: Get a ray trace from mouse position
Param[1]: mousePosition (type: Vector2)
Param[2]: camera (type: Camera)
-Function 085: GetViewRay() (4 input parameters)
- Name: GetViewRay
+Function 085: GetScreenToWorldRayEx() (4 input parameters)
+ Name: GetScreenToWorldRayEx
Return type: Ray
Description: Get a ray trace from mouse position in a viewport
Param[1]: mousePosition (type: Vector2)
diff --git a/parser/output/raylib_api.xml b/parser/output/raylib_api.xml
index c0472736..525f81de 100644
--- a/parser/output/raylib_api.xml
+++ b/parser/output/raylib_api.xml
@@ -902,11 +902,11 @@
<Function name="UnloadShader" retType="void" paramCount="1" desc="Unload shader from GPU memory (VRAM)">
<Param type="Shader" name="shader" desc="" />
</Function>
- <Function name="GetMouseRay" retType="Ray" paramCount="2" desc="Get a ray trace from mouse position">
+ <Function name="GetScreenToWorldRay" retType="Ray" paramCount="2" desc="Get a ray trace from mouse position">
<Param type="Vector2" name="mousePosition" desc="" />
<Param type="Camera" name="camera" desc="" />
</Function>
- <Function name="GetViewRay" retType="Ray" paramCount="4" desc="Get a ray trace from mouse position in a viewport">
+ <Function name="GetScreenToWorldRayEx" retType="Ray" paramCount="4" desc="Get a ray trace from mouse position in a viewport">
<Param type="Vector2" name="mousePosition" desc="" />
<Param type="Camera" name="camera" desc="" />
<Param type="float" name="width" desc="" />
diff --git a/src/raylib.h b/src/raylib.h
index c8f765ec..3c54abac 100644
--- a/src/raylib.h
+++ b/src/raylib.h
@@ -1049,8 +1049,8 @@ RLAPI void SetShaderValueTexture(Shader shader, int locIndex, Texture2D texture)
RLAPI void UnloadShader(Shader shader); // Unload shader from GPU memory (VRAM)
// Screen-space-related functions
-RLAPI Ray GetMouseRay(Vector2 mousePosition, Camera camera); // Get a ray trace from mouse position
-RLAPI Ray GetViewRay(Vector2 mousePosition, Camera camera, float width, float height); // Get a ray trace from mouse position in a viewport
+RLAPI Ray GetScreenToWorldRay(Vector2 mousePosition, Camera camera); // Get a ray trace from mouse position
+RLAPI Ray GetScreenToWorldRayEx(Vector2 mousePosition, Camera camera, float width, float height); // Get a ray trace from mouse position in a viewport
RLAPI Vector2 GetWorldToScreen(Vector3 position, Camera camera); // Get the screen space position for a 3d world space position
RLAPI Vector2 GetWorldToScreenEx(Vector3 position, Camera camera, int width, int height); // Get size position for a 3d world space position
RLAPI Vector2 GetWorldToScreen2D(Vector2 position, Camera2D camera); // Get the screen space position for a 2d camera world space position
diff --git a/src/rcore.c b/src/rcore.c
index 024f0d12..5e45a49a 100644
--- a/src/rcore.c
+++ b/src/rcore.c
@@ -1407,13 +1407,13 @@ void SetShaderValueTexture(Shader shader, int locIndex, Texture2D texture)
//----------------------------------------------------------------------------------
// Get a ray trace from mouse position
-Ray GetMouseRay(Vector2 mousePosition, Camera camera)
+Ray GetScreenToWorldRay(Vector2 mousePosition, Camera camera)
{
- return GetViewRay(mousePosition, camera, (float)GetScreenWidth(), (float)GetScreenHeight());
+ return GetScreenToWorldRayEx(mousePosition, camera, (float)GetScreenWidth(), (float)GetScreenHeight());
}
// Get a ray trace from the mouse position within a specific section of the screen
-Ray GetViewRay(Vector2 mousePosition, Camera camera, float width, float height)
+Ray GetScreenToWorldRayEx(Vector2 mousePosition, Camera camera, float width, float height)
{
Ray ray = { 0 };