mirror of https://github.com/libsdl-org/SDL
Fix various typos (docs/build scripts/tests)
This commit is contained in:
parent
c0bd18f023
commit
65e1d568ef
|
@ -14,7 +14,7 @@
|
||||||
//
|
//
|
||||||
// A few options:
|
// A few options:
|
||||||
// --c++=11 to parse cpp file
|
// --c++=11 to parse cpp file
|
||||||
// --max-width 200 to increase line witdth of generated source
|
// --max-width 200 to increase line width of generated source
|
||||||
//
|
//
|
||||||
// Apply the patch to your project:
|
// Apply the patch to your project:
|
||||||
// patch -p1 <patch.txt
|
// patch -p1 <patch.txt
|
||||||
|
@ -28,7 +28,7 @@
|
||||||
// @@
|
// @@
|
||||||
// rule / transformation
|
// rule / transformation
|
||||||
//
|
//
|
||||||
// So this file is a set of many semantic patches, mostly independant.
|
// So this file is a set of many semantic patches, mostly independent.
|
||||||
|
|
||||||
|
|
||||||
@ rule_audio_open @
|
@ rule_audio_open @
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
#
|
#
|
||||||
# This script renames SDL headers in the specfied paths
|
# This script renames SDL headers in the specified paths
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import pathlib
|
import pathlib
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
#
|
#
|
||||||
# This script renames symbols in the specfied paths
|
# This script renames symbols in the specified paths
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -59,7 +59,7 @@ get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
|
||||||
# function returns an empty string via _git_dir_var.
|
# function returns an empty string via _git_dir_var.
|
||||||
#
|
#
|
||||||
# Example: Given a path C:/bla/foo/bar and assuming C:/bla/.git exists and
|
# Example: Given a path C:/bla/foo/bar and assuming C:/bla/.git exists and
|
||||||
# neither foo nor bar contain a file/directory .git. This wil return
|
# neither foo nor bar contain a file/directory .git. This will return
|
||||||
# C:/bla/.git
|
# C:/bla/.git
|
||||||
#
|
#
|
||||||
function(_git_find_closest_git_dir _start_dir _git_dir_var)
|
function(_git_find_closest_git_dir _start_dir _git_dir_var)
|
||||||
|
|
|
@ -218,7 +218,7 @@ You should not use the SDL renderer API while the app going in background:
|
||||||
GL context is restored, and the SDL renderer API is available (unless you
|
GL context is restored, and the SDL renderer API is available (unless you
|
||||||
receive SDL_EVENT_RENDER_DEVICE_RESET).
|
receive SDL_EVENT_RENDER_DEVICE_RESET).
|
||||||
|
|
||||||
Activity lifecyle
|
Activity lifecycle
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
You can control activity re-creation (eg. onCreate()) behaviour. This allows to keep
|
You can control activity re-creation (eg. onCreate()) behaviour. This allows to keep
|
||||||
|
|
|
@ -18,10 +18,10 @@ cmake --install build
|
||||||
|
|
||||||
## Hints
|
## Hints
|
||||||
The PS2 port has a special Hint for having a dynamic VSYNC. The Hint is `SDL_HINT_PS2_DYNAMIC_VSYNC`.
|
The PS2 port has a special Hint for having a dynamic VSYNC. The Hint is `SDL_HINT_PS2_DYNAMIC_VSYNC`.
|
||||||
If you enabled the dynamic vsync having as well `SDL_RENDERER_PRESENTVSYNC` enabled, then if the app is not able to run at 60 FPS, automatically the `vsync` will be disabled having a better performance, instead of droping FPS to 30.
|
If you enabled the dynamic vsync having as well `SDL_RENDERER_PRESENTVSYNC` enabled, then if the app is not able to run at 60 FPS, automatically the `vsync` will be disabled having a better performance, instead of dropping FPS to 30.
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
If you trying to debug a SDL app through [ps2client](https://github.com/ps2dev/ps2client) you need to avoid the IOP reset, otherwise you will lose the conection with your computer.
|
If you trying to debug a SDL app through [ps2client](https://github.com/ps2dev/ps2client) you need to avoid the IOP reset, otherwise you will lose the connection with your computer.
|
||||||
So to avoid the reset of the IOP CPU, you need to call to the macro `SDL_PS2_SKIP_IOP_RESET();`.
|
So to avoid the reset of the IOP CPU, you need to call to the macro `SDL_PS2_SKIP_IOP_RESET();`.
|
||||||
It could be something similar as:
|
It could be something similar as:
|
||||||
```c
|
```c
|
||||||
|
|
|
@ -697,9 +697,9 @@ static int rect_testIntersectRectParam(void *arg)
|
||||||
intersection = SDL_GetRectIntersection((SDL_Rect *)NULL, &rectB, &result);
|
intersection = SDL_GetRectIntersection((SDL_Rect *)NULL, &rectB, &result);
|
||||||
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 1st parameter is NULL");
|
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 1st parameter is NULL");
|
||||||
intersection = SDL_GetRectIntersection(&rectA, (SDL_Rect *)NULL, &result);
|
intersection = SDL_GetRectIntersection(&rectA, (SDL_Rect *)NULL, &result);
|
||||||
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 2st parameter is NULL");
|
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 2nd parameter is NULL");
|
||||||
intersection = SDL_GetRectIntersection(&rectA, &rectB, (SDL_Rect *)NULL);
|
intersection = SDL_GetRectIntersection(&rectA, &rectB, (SDL_Rect *)NULL);
|
||||||
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 3st parameter is NULL");
|
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 3rd parameter is NULL");
|
||||||
intersection = SDL_GetRectIntersection((SDL_Rect *)NULL, (SDL_Rect *)NULL, &result);
|
intersection = SDL_GetRectIntersection((SDL_Rect *)NULL, (SDL_Rect *)NULL, &result);
|
||||||
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 1st and 2nd parameters are NULL");
|
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 1st and 2nd parameters are NULL");
|
||||||
intersection = SDL_GetRectIntersection((SDL_Rect *)NULL, &rectB, (SDL_Rect *)NULL);
|
intersection = SDL_GetRectIntersection((SDL_Rect *)NULL, &rectB, (SDL_Rect *)NULL);
|
||||||
|
@ -945,7 +945,7 @@ static int rect_testHasIntersectionParam(void *arg)
|
||||||
intersection = SDL_HasRectIntersection((SDL_Rect *)NULL, &rectB);
|
intersection = SDL_HasRectIntersection((SDL_Rect *)NULL, &rectB);
|
||||||
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 1st parameter is NULL");
|
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 1st parameter is NULL");
|
||||||
intersection = SDL_HasRectIntersection(&rectA, (SDL_Rect *)NULL);
|
intersection = SDL_HasRectIntersection(&rectA, (SDL_Rect *)NULL);
|
||||||
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 2st parameter is NULL");
|
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when 2nd parameter is NULL");
|
||||||
intersection = SDL_HasRectIntersection((SDL_Rect *)NULL, (SDL_Rect *)NULL);
|
intersection = SDL_HasRectIntersection((SDL_Rect *)NULL, (SDL_Rect *)NULL);
|
||||||
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when all parameters are NULL");
|
SDLTest_AssertCheck(intersection == SDL_FALSE, "Check that function returns SDL_FALSE when all parameters are NULL");
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* Adapted/rewritten for test lib by Andreas Schiffler
|
* Adapted/rewritten for test lib by Andreas Schiffler
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* Supress C4996 VS compiler warnings for unlink() */
|
/* Suppress C4996 VS compiler warnings for unlink() */
|
||||||
#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
|
#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
|
||||||
#define _CRT_SECURE_NO_DEPRECATE
|
#define _CRT_SECURE_NO_DEPRECATE
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -1625,7 +1625,7 @@ cleanup:
|
||||||
/**
|
/**
|
||||||
* \brief Tests the functionality of the SDL_WINDOWPOS_CENTERED_DISPLAY along with SDL_WINDOW_FULLSCREEN.
|
* \brief Tests the functionality of the SDL_WINDOWPOS_CENTERED_DISPLAY along with SDL_WINDOW_FULLSCREEN.
|
||||||
*
|
*
|
||||||
* Espeically useful when run on a multi-monitor system with different DPI scales per monitor,
|
* Especially useful when run on a multi-monitor system with different DPI scales per monitor,
|
||||||
* to test that the window size is maintained when moving between monitors.
|
* to test that the window size is maintained when moving between monitors.
|
||||||
*/
|
*/
|
||||||
static int video_setWindowCenteredOnDisplay(void *arg)
|
static int video_setWindowCenteredOnDisplay(void *arg)
|
||||||
|
|
|
@ -10,7 +10,7 @@
|
||||||
freely.
|
freely.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* sanity tests on SDL_rwops.c (usefull for alternative implementations of stdio rwops) */
|
/* sanity tests on SDL_rwops.c (useful for alternative implementations of stdio rwops) */
|
||||||
|
|
||||||
/* quiet windows compiler warnings */
|
/* quiet windows compiler warnings */
|
||||||
#if defined(_MSC_VER) && !defined(_CRT_NONSTDC_NO_WARNINGS)
|
#if defined(_MSC_VER) && !defined(_CRT_NONSTDC_NO_WARNINGS)
|
||||||
|
|
|
@ -128,7 +128,7 @@ int main(int argc, char *argv[])
|
||||||
SDL_CloseJoystick(joystick);
|
SDL_CloseJoystick(joystick);
|
||||||
joystick = NULL;
|
joystick = NULL;
|
||||||
} else {
|
} else {
|
||||||
SDL_Log("Unknown joystick diconnected\n");
|
SDL_Log("Unknown joystick disconnected\n");
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
case SDL_EVENT_JOYSTICK_AXIS_MOTION:
|
case SDL_EVENT_JOYSTICK_AXIS_MOTION:
|
||||||
|
|
|
@ -771,9 +771,9 @@ int main(int argc, char *argv[])
|
||||||
SDL_strlcat(text, event.text.text, sizeof(text));
|
SDL_strlcat(text, event.text.text, sizeof(text));
|
||||||
}
|
}
|
||||||
|
|
||||||
SDL_Log("text inputed: %s\n", text);
|
SDL_Log("text inputted: %s\n", text);
|
||||||
|
|
||||||
/* After text inputed, we can clear up markedText because it */
|
/* After text inputted, we can clear up markedText because it */
|
||||||
/* is committed */
|
/* is committed */
|
||||||
markedText[0] = 0;
|
markedText[0] = 0;
|
||||||
Redraw();
|
Redraw();
|
||||||
|
|
|
@ -381,7 +381,7 @@ static int Test64Bit(SDL_bool verbose)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (verbose && (failed == 0)) {
|
if (verbose && (failed == 0)) {
|
||||||
SDL_Log("All 64bit instrinsic tests passed\n");
|
SDL_Log("All 64bit intrinsic tests passed\n");
|
||||||
}
|
}
|
||||||
return failed ? 1 : 0;
|
return failed ? 1 : 0;
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue