|
@@ -289,7 +289,34 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithProperties(SDL_Prop
|
|
|
|
|
|
#ifndef SDL_WIKI_DOCUMENTATION_SECTION
|
|
|
/* These are the actual functions exported from SDL! Don't use them directly! Use the SDL_CreateThread and SDL_CreateThreadWithProperties macros! */
|
|
|
+/**
|
|
|
+ * The actual entry point for SDL_CreateThread.
|
|
|
+ *
|
|
|
+ * \param fn the SDL_ThreadFunction function to call in the new thread
|
|
|
+ * \param name the name of the thread
|
|
|
+ * \param data a pointer that is passed to `fn`
|
|
|
+ * \param pfnBeginThread the C runtime's _beginthreadex (or whatnot). Can be NULL.
|
|
|
+ * \param pfnEndThread the C runtime's _endthreadex (or whatnot). Can be NULL.
|
|
|
+ * \returns an opaque pointer to the new thread object on success, NULL if the
|
|
|
+ * new thread could not be created; call SDL_GetError() for more
|
|
|
+ * information.
|
|
|
+ *
|
|
|
+ * \since This function is available since SDL 3.0.0.
|
|
|
+ */
|
|
|
extern SDL_DECLSPEC SDL_Thread *SDLCALL SDL_CreateThreadRuntime(SDL_ThreadFunction fn, const char *name, void *data, SDL_FunctionPointer pfnBeginThread, SDL_FunctionPointer pfnEndThread);
|
|
|
+
|
|
|
+/**
|
|
|
+ * The actual entry point for SDL_CreateThreadWithProperties.
|
|
|
+ *
|
|
|
+ * \param props the properties to use
|
|
|
+ * \param pfnBeginThread the C runtime's _beginthreadex (or whatnot). Can be NULL.
|
|
|
+ * \param pfnEndThread the C runtime's _endthreadex (or whatnot). Can be NULL.
|
|
|
+ * \returns an opaque pointer to the new thread object on success, NULL if the
|
|
|
+ * new thread could not be created; call SDL_GetError() for more
|
|
|
+ * information.
|
|
|
+ *
|
|
|
+ * \since This function is available since SDL 3.0.0.
|
|
|
+ */
|
|
|
extern SDL_DECLSPEC SDL_Thread *SDLCALL SDL_CreateThreadWithPropertiesRuntime(SDL_PropertiesID props, SDL_FunctionPointer pfnBeginThread, SDL_FunctionPointer pfnEndThread);
|
|
|
|
|
|
#define SDL_CreateThread(fn, name, data) SDL_CreateThreadRuntime((fn), (name), (data), (SDL_FunctionPointer) (SDL_BeginThreadFunction), (SDL_FunctionPointer) (SDL_EndThreadFunction))
|