Skip to content

Commit

Permalink
Sync SDL_rtf header -> wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
SDLWikiBot committed May 15, 2024
1 parent 4a8ba53 commit 26cd66e
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 0 deletions.
27 changes: 27 additions & 0 deletions SDL_rtf/RTF_Version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
###### (This function is part of SDL_rtf, a separate library from SDL.)
# RTF_Version

This function gets the version of the dynamically linked SDL_rtf library.

## Header File

Defined in SDL_rtf.h

## Syntax

```c
int RTF_Version(void);

```
## Return Value
Returns SDL_rtf version
## Version
This function is available since SDL_rtf 3.0.0.
----
[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
18 changes: 18 additions & 0 deletions SDL_rtf/SDL_RTF_MAJOR_VERSION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
###### (This function is part of SDL_rtf, a separate library from SDL.)
# SDL_RTF_MAJOR_VERSION

Printable format: "%d.%d.%d", MAJOR, MINOR, MICRO

## Header File

Defined in SDL_rtf.h

## Syntax

```c
#define SDL_RTF_MAJOR_VERSION 3
```
----
[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro)
19 changes: 19 additions & 0 deletions SDL_rtf/SDL_RTF_VERSION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
###### (This function is part of SDL_rtf, a separate library from SDL.)
# SDL_RTF_VERSION

This is the version number macro for the current SDL_rtf version.

## Header File

Defined in SDL_rtf.h

## Syntax

```c
#define SDL_RTF_VERSION \
SDL_VERSIONNUM(SDL_RTF_MAJOR_VERSION, SDL_RTF_MINOR_VERSION, SDL_RTF_MICRO_VERSION)
```
----
[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro)
21 changes: 21 additions & 0 deletions SDL_rtf/SDL_RTF_VERSION_ATLEAST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
###### (This function is part of SDL_rtf, a separate library from SDL.)
# SDL_RTF_VERSION_ATLEAST

This macro will evaluate to true if compiled with SDL_rtf at least X.Y.Z.

## Header File

Defined in SDL_rtf.h

## Syntax

```c
#define SDL_RTF_VERSION_ATLEAST(X, Y, Z) \
((SDL_RTF_MAJOR_VERSION >= X) && \
(SDL_RTF_MAJOR_VERSION > X || SDL_RTF_MINOR_VERSION >= Y) && \
(SDL_RTF_MAJOR_VERSION > X || SDL_RTF_MINOR_VERSION > Y || SDL_RTF_MICRO_VERSION >= Z))
```
----
[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro)

0 comments on commit 26cd66e

Please sign in to comment.