|
Size: 825
Comment: update content - pointers, structs
|
Size: 1091
Comment: Updated descriptions
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | ||<tablewidth="100%"style="color: rgb(255, 0, 0); text-align: center;">DRAFT || |
| Line 14: | Line 15: |
| == Function Parameters == ||'''thread''' ||^The desired/specified thread to query^ || |
|
| Line 15: | Line 18: |
| == Function Parameters == ||'''thread'''||^the desired/specified thread to query^|| |
|
| Line 19: | Line 20: |
| Returns the ID of the specified thread. <<Color2(green, What happens on error?)>> | Returns the ID of the specified thread. This thread identifier is as reported by the underlying operating system. If SDL is running on a platform that does not support threads the return value will always be zero. If the passed-in SDL_Thread pointer is NULL, this function will always return an SDL_threadID of zero. |
| Line 23: | Line 26: |
| You can add your code example here | |
| Line 25: | Line 27: |
| Line 27: | Line 28: |
| ^This function is^ equivalent to [[SDL_ThreadID]]() if the specified thread is NULL. | If the SDL thread pointer passed to this function is NULL, this function will return the SDL_ThreadID of the current thread. |
| Line 30: | Line 31: |
| .[[SDL_CreateThread]] * .[[SDL_ThreadID]] |
. [[SDL_CreateThread]] * . [[SDL_ThreadID]] |
| Line 34: | Line 35: |
| [[CategoryAPI]], [[CategoryThread]] | [[CategoryAPI]], CategoryThread |
DRAFT |
SDL_GetThreadID
Use this function to get the thread identifier for the specified thread.
Contents
Syntax
SDL_threadID SDL_GetThreadID(SDL_Thread* thread)
Function Parameters
thread |
The desired/specified thread to query |
Return Value
Returns the ID of the specified thread. This thread identifier is as reported by the underlying operating system. If SDL is running on a platform that does not support threads the return value will always be zero.
If the passed-in SDL_Thread pointer is NULL, this function will always return an SDL_threadID of zero.
Code Examples
Remarks
If the SDL thread pointer passed to this function is NULL, this function will return the SDL_ThreadID of the current thread.
