📦 libsdl3-doc

2201 pages · page 1 of 12

S

SDL_abs(3)Compute the absolute value of x.✨
SDL_acos(3)Compute the arc cosine of x.✨
SDL_acosf(3)Compute the arc cosine of x.✨
SDL_ACQUIRE(3)Wrapper around Clang thread safety analysis annotations.✨
SDL_ACQUIRE_SHARED(3)Wrapper around Clang thread safety analysis annotations.✨
SDL_AcquireCameraFrame(3)Acquire a frame.✨
SDL_ACQUIRED_AFTER(3)Wrapper around Clang thread safety analysis annotations.✨
SDL_ACQUIRED_BEFORE(3)Wrapper around Clang thread safety analysis annotations.✨
SDL_AcquireGPUCommandBuffer(3)Acquire a command buffer.✨
SDL_AcquireGPUSwapchainTexture(3)Acquire a texture to use in presentation.✨
SDL_AddAtomicInt(3)Add to an atomic variable.✨
SDL_AddAtomicU32(3)Add to an atomic variable.✨
SDL_AddEventWatch(3)Add a callback to be triggered when an event is added to the event queue.✨
SDL_AddGamepadMapping(3)Add support for gamepads that SDL is unaware of or change the binding of an existing gamepad.✨
SDL_AddGamepadMappingsFromFile(3)Load a set of gamepad mappings from a file.✨
SDL_AddGamepadMappingsFromIO(3)Load a set of gamepad mappings from an SDL_IOStream.✨
SDL_AddHintCallback(3)Add a function to watch a particular hint.✨
SDL_AddSurfaceAlternateImage(3)Add an alternate version of a surface.✨
SDL_AddTimer(3)Call a callback function at a future time.✨
SDL_AddTimerNS(3)Call a callback function at a future time.✨
SDL_AddVulkanRenderSemaphores(3)Add a set of synchronization semaphores for the current frame.✨
SDL_ALIGNED(3)A macro to specify data alignment.✨
SDL_aligned_alloc(3)Allocate memory aligned to a specific alignment.✨
SDL_aligned_free(3)Free memory allocated by SDL_aligned_alloc().✨
SDL_ALLOC_SIZE(3)A macro to tag a function as returning a certain allocation.✨
SDL_ALPHA_OPAQUE(3)A fully opaque 8-bit alpha value.✨
SDL_ALPHA_OPAQUE_FLOAT(3)A fully opaque floating point alpha value.✨
SDL_ALPHA_TRANSPARENT(3)A fully transparent 8-bit alpha value.✨
SDL_ALPHA_TRANSPARENT_FLOAT(3)A fully transparent floating point alpha value.✨
SDL_ALTIVEC_INTRINSICS(3)Defined if (and only if) the compiler supports PowerPC Altivec intrinsics.✨
SDL_ANALYZER_NORETURN(3)A macro to tag a function as never-returning (for analysis purposes).✨
SDL_ANDROID_EXTERNAL_STORAGE_READ(3)See the official Android developer guide for more information: http://developer.android.com/guide/topics/data/data-storage.html✨
SDL_ANDROID_EXTERNAL_STORAGE_WRITE(3)See the official Android developer guide for more information: http://developer.android.com/guide/topics/data/data-storage.html✨
SDL_AppEvent(3)App-implemented event entry point for SDL_MAIN_USE_CALLBACKS apps.✨
SDL_AppEvent_func(3type)Function pointer typedef for SDL_AppEvent.✨
SDL_AppInit(3)App-implemented initial entry point for SDL_MAIN_USE_CALLBACKS apps.✨
SDL_AppInit_func(3type)Function pointer typedef for SDL_AppInit.✨
SDL_AppIterate(3)App-implemented iteration entry point for SDL_MAIN_USE_CALLBACKS apps.✨
SDL_AppIterate_func(3type)Function pointer typedef for SDL_AppIterate.✨
SDL_AppQuit(3)App-implemented deinit entry point for SDL_MAIN_USE_CALLBACKS apps.✨
SDL_AppQuit_func(3type)Function pointer typedef for SDL_AppQuit.✨
SDL_AppResult(3type)Return values for optional main callbacks.✨
SDL_ArrayOrder(3type)Array component order, low byte -> high byte.✨
SDL_arraysize(3)The number of elements in a static array.✨
SDL_asin(3)Compute the arc sine of x.✨
SDL_asinf(3)Compute the arc sine of x.✨
SDL_asprintf(3)This works exactly like asprintf() but doesn't require access to a C runtime.✨
SDL_assert(3)An assertion test that is normally performed only in debug builds.✨
SDL_assert_always(3)An assertion test that is always performed.✨
SDL_ASSERT_CAPABILITY(3)Wrapper around Clang thread safety analysis annotations.✨
SDL_ASSERT_FILE(3)A macro that reports the current file being compiled, for use in assertions.✨
SDL_ASSERT_LEVEL(3)The level of assertion aggressiveness.✨
SDL_assert_paranoid(3)An assertion test that is performed only when built with paranoid settings.✨
SDL_assert_release(3)An assertion test that is performed even in release builds.✨
SDL_ASSERT_SHARED_CAPABILITY(3)Wrapper around Clang thread safety analysis annotations.✨
SDL_AssertBreakpoint(3)The macro used when an assertion triggers a breakpoint.✨
SDL_AssertData(3type)Information about an assertion failure.✨
SDL_AssertionHandler(3type)A callback that fires when an SDL assertion fails.✨
SDL_AssertState(3type)Possible outcomes from a triggered assertion.✨
SDL_AsyncIO(3type)The asynchronous I/O operation structure.✨
SDL_AsyncIOFromFile(3)Use this function to create a new SDL_AsyncIO object for reading from and/or writing to a named file.✨
SDL_AsyncIOOutcome(3type)Information about a completed asynchronous I/O request.✨
SDL_AsyncIOQueue(3type)A queue of completed asynchronous I/O tasks.✨
SDL_AsyncIOResult(3type)Possible outcomes of an asynchronous I/O task.✨
SDL_AsyncIOTaskType(3type)Types of asynchronous I/O tasks.✨
SDL_atan(3)Compute the arc tangent of x.✨
SDL_atan2(3)Compute the arc tangent of y / x, using the signs of x and y to adjust the result's quadrant.✨
SDL_atan2f(3)Compute the arc tangent of y / x, using the signs of x and y to adjust the result's quadrant.✨
SDL_atanf(3)Compute the arc tangent of x.✨
SDL_atof(3)Parse a double from a string.✨
SDL_atoi(3)Parse an int from a string.✨
SDL_AtomicDecRef(3)Decrement an atomic variable used as a reference count.✨
SDL_AtomicIncRef(3)Increment an atomic variable used as a reference count.✨
SDL_AtomicInt(3type)A type representing an atomic integer value.✨
SDL_AtomicU32(3type)A type representing an atomic unsigned 32-bit value.✨
SDL_AttachVirtualJoystick(3)Attach a new virtual joystick.✨
SDL_AUDIO_BITSIZE(3)Retrieve the size, in bits, from an SDL_AudioFormat.✨
SDL_AUDIO_BYTESIZE(3)Retrieve the size, in bytes, from an SDL_AudioFormat.✨
SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK(3)A value used to request a default playback audio device.✨
SDL_AUDIO_DEVICE_DEFAULT_RECORDING(3)A value used to request a default recording audio device.✨
SDL_AUDIO_FRAMESIZE(3)Calculate the size of each audio frame (in bytes) from an SDL_AudioSpec.✨
SDL_AUDIO_ISBIGENDIAN(3)Determine if an SDL_AudioFormat represents bigendian data.✨
SDL_AUDIO_ISFLOAT(3)Determine if an SDL_AudioFormat represents floating point data.✨
SDL_AUDIO_ISINT(3)Determine if an SDL_AudioFormat represents integer data.✨
SDL_AUDIO_ISLITTLEENDIAN(3)Determine if an SDL_AudioFormat represents littleendian data.✨
SDL_AUDIO_ISSIGNED(3)Determine if an SDL_AudioFormat represents signed data.✨
SDL_AUDIO_ISUNSIGNED(3)Determine if an SDL_AudioFormat represents unsigned data.✨
SDL_AUDIO_MASK_BIG_ENDIAN(3)Mask of bits in an SDL_AudioFormat that contain the bigendian flag.✨
SDL_AUDIO_MASK_BITSIZE(3)Mask of bits in an SDL_AudioFormat that contains the format bit size.✨
SDL_AUDIO_MASK_FLOAT(3)Mask of bits in an SDL_AudioFormat that contain the floating point flag.✨
SDL_AUDIO_MASK_SIGNED(3)Mask of bits in an SDL_AudioFormat that contain the signed data flag.✨
SDL_AudioDeviceEvent(3type)Audio device event structure (event.adevice.*)✨
SDL_AudioDeviceID(3type)SDL Audio Device instance IDs.✨
SDL_AudioDevicePaused(3)Use this function to query if an audio device is paused.✨
SDL_AudioFormat(3type)Audio format.✨
SDL_AudioPostmixCallback(3type)A callback that fires when data is about to be fed to an audio device.✨
SDL_AudioSpec(3type)Format specifier for audio data.✨
SDL_AudioStream(3type)The opaque handle that represents an audio stream.✨
SDL_AudioStreamCallback(3type)A callback that fires when data passes through an SDL_AudioStream.✨
SDL_AudioStreamDataCompleteCallback(3type)A callback that fires for completed SDL_PutAudioStreamDataNoCopy() data.✨
SDL_AudioStreamDevicePaused(3)Use this function to query if an audio device associated with a stream is paused.✨
SDL_AVX2_INTRINSICS(3)Defined if (and only if) the compiler supports Intel AVX2 intrinsics.✨
SDL_AVX512F_INTRINSICS(3)Defined if (and only if) the compiler supports Intel AVX-512F intrinsics.✨
SDL_AVX_INTRINSICS(3)Defined if (and only if) the compiler supports Intel AVX intrinsics.✨
SDL_BeginGPUComputePass(3)Begins a compute pass on a command buffer.✨
SDL_BeginGPUCopyPass(3)Begins a copy pass on a command buffer.✨
SDL_BeginGPURenderPass(3)Begins a render pass on a command buffer.✨
SDL_BIG_ENDIAN(3)A value to represent bigendian byteorder.✨
SDL_BindAudioStream(3)Bind a single audio stream to an audio device.✨
SDL_BindAudioStreams(3)Bind a list of audio streams to an audio device.✨
SDL_BindGPUComputePipeline(3)Binds a compute pipeline on a command buffer for use in compute dispatch.✨
SDL_BindGPUComputeSamplers(3)Binds texture-sampler pairs for use on the compute shader.✨
SDL_BindGPUComputeStorageBuffers(3)Binds storage buffers as readonly for use on the compute pipeline.✨
SDL_BindGPUComputeStorageTextures(3)Binds storage textures as readonly for use on the compute pipeline.✨
SDL_BindGPUFragmentSamplers(3)Binds texture-sampler pairs for use on the fragment shader.✨
SDL_BindGPUFragmentStorageBuffers(3)Binds storage buffers for use on the fragment shader.✨
SDL_BindGPUFragmentStorageTextures(3)Binds storage textures for use on the fragment shader.✨
SDL_BindGPUGraphicsPipeline(3)Binds a graphics pipeline on a render pass to be used in rendering.✨
SDL_BindGPUIndexBuffer(3)Binds an index buffer on a command buffer for use with subsequent draw calls.✨
SDL_BindGPUVertexBuffers(3)Binds vertex buffers on a command buffer for use with subsequent draw calls.✨
SDL_BindGPUVertexSamplers(3)Binds texture-sampler pairs for use on the vertex shader.✨
SDL_BindGPUVertexStorageBuffers(3)Binds storage buffers for use on the vertex shader.✨
SDL_BindGPUVertexStorageTextures(3)Binds storage textures for use on the vertex shader.✨
SDL_BitmapOrder(3type)Bitmap pixel order, high bit -> low bit.✨
SDL_BITSPERPIXEL(3)A macro to determine an SDL_PixelFormat's bits per pixel.✨
SDL_BlendFactor(3type)The normalized factor used to multiply pixel components.✨
SDL_BlendMode(3type)A set of blend modes used in drawing operations.✨
SDL_BlendOperation(3type)The blend operation used when combining source and destination pixel components.✨
SDL_BlitGPUTexture(3)Blits from a source texture region to a destination texture region.✨
SDL_BlitSurface(3)Performs a fast blit from the source surface to the destination surface with clipping.✨
SDL_BlitSurface9Grid(3)Perform a scaled blit using the 9-grid algorithm to a destination surface, which may be of a different format.✨
SDL_BlitSurfaceScaled(3)Perform a scaled blit to a destination surface, which may be of a different format.✨
SDL_BlitSurfaceTiled(3)Perform a tiled blit to a destination surface, which may be of a different format.✨
SDL_BlitSurfaceTiledWithScale(3)Perform a scaled and tiled blit to a destination surface, which may be of a different format.✨
SDL_BlitSurfaceUnchecked(3)Perform low-level surface blitting only.✨
SDL_BlitSurfaceUncheckedScaled(3)Perform low-level surface scaled blitting only.✨
SDL_BroadcastCondition(3)Restart all threads that are waiting on the condition variable.✨
SDL_bsearch(3)Perform a binary search on a previously sorted array.✨
SDL_bsearch_r(3)Perform a binary search on a previously sorted array, passing a userdata pointer to the compare function.✨
SDL_BYTEORDER(3)A macro that reports the target system's byte order.✨
SDL_BYTESPERPIXEL(3)A macro to determine an SDL_PixelFormat's bytes per pixel.✨
SDL_CACHELINE_SIZE(3)A guess for the cacheline size used for padding.✨
SDL_CalculateGPUTextureFormatSize(3)Calculate the size in bytes of a texture format with dimensions.✨
SDL_calloc(3)Allocate a zero-initialized array.✨
SDL_calloc_func(3type)A callback used to implement SDL_calloc().✨
SDL_Camera(3type)The opaque structure used to identify an opened SDL camera.✨
SDL_CameraDeviceEvent(3type)Camera device event structure (event.cdevice.*)✨
SDL_CameraID(3type)This is a unique ID for a camera device for the time it is connected to the system, and is never reused for the lifetime of the application.✨
SDL_CameraPermissionState(3type)The current state of a request for camera access.✨
SDL_CameraPosition(3type)The position of camera in relation to system device.✨
SDL_CameraSpec(3type)The details of an output format for a camera device.✨
SDL_CancelGPUCommandBuffer(3)Cancels a command buffer.✨
SDL_CAPABILITY(3)Wrapper around Clang thread safety analysis annotations.✨
SDL_Capitalization(3type)Auto capitalization type.✨
SDL_CaptureMouse(3)Capture the mouse and to track input outside an SDL window.✨
SDL_ceil(3)Compute the ceiling of x.✨
SDL_ceilf(3)Compute the ceiling of x.✨
SDL_ChromaLocation(3type)Colorspace chroma sample location.✨
SDL_ClaimWindowForGPUDevice(3)Claims a window, creating a swapchain structure for it.✨
SDL_clamp(3)Return a value clamped to a range.✨
SDL_CleanupPropertyCallback(3type)A callback used to free resources when a property is deleted.✨
SDL_CleanupTLS(3)Cleanup all TLS data for this thread.✨
SDL_ClearAudioStream(3)Clear any pending data in the stream.✨
SDL_ClearClipboardData(3)Clear the clipboard data.✨
SDL_ClearComposition(3)Dismiss the composition window/IME without disabling the subsystem.✨
SDL_ClearError(3)Clear any previous error message for this thread.✨
SDL_ClearProperty(3)Clear a property from a group of properties.✨
SDL_ClearSurface(3)Clear a surface with a specific color, with floating point precision.✨
SDL_ClickTrayEntry(3)Simulate a click on a tray entry.✨
SDL_ClipboardCleanupCallback(3type)Callback function that will be called when the clipboard is cleared, or when new data is set.✨
SDL_ClipboardDataCallback(3type)Callback function that will be called when data for the specified mime-type is requested by the OS.✨
SDL_ClipboardEvent(3type)An event triggered when the clipboard contents have changed (event.clipboard.*)✨
SDL_CloseAsyncIO(3)Close and free any allocated resources for an async I/O object.✨
SDL_CloseAudioDevice(3)Close a previously-opened audio device.✨
SDL_CloseCamera(3)Use this function to shut down camera processing and close the camera device.✨
SDL_CloseGamepad(3)Close a gamepad previously opened with SDL_OpenGamepad().✨
SDL_CloseHaptic(3)Close a haptic device previously opened with SDL_OpenHaptic().✨
SDL_CloseIO(3)Close and free an allocated SDL_IOStream structure.✨
SDL_CloseJoystick(3)Close a joystick previously opened with SDL_OpenJoystick().✨
SDL_CloseSensor(3)Close a sensor previously opened with SDL_OpenSensor().✨
SDL_CloseStorage(3)Closes and frees a storage container.✨
SDL_Color(3type)A structure that represents a color as RGBA components.✨
SDL_ColorPrimaries(3type)Colorspace color primaries, as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en✨
SDL_ColorRange(3type)Colorspace color range, as described by https://www.itu.int/rec/R-REC-BT.2100-2-201807-I/en✨
SDL_Colorspace(3type)Colorspace definitions.✨
SDL_COLORSPACECHROMA(3)A macro to retrieve the chroma sample location of an SDL_Colorspace.✨
SDL_COLORSPACEMATRIX(3)A macro to retrieve the matrix coefficients of an SDL_Colorspace.✨
SDL_COLORSPACEPRIMARIES(3)A macro to retrieve the primaries of an SDL_Colorspace.✨
SDL_COLORSPACERANGE(3)A macro to retrieve the range of an SDL_Colorspace.✨
SDL_COLORSPACETRANSFER(3)A macro to retrieve the transfer characteristics of an SDL_Colorspace.✨
SDL_COLORSPACETYPE(3)A macro to retrieve the type of an SDL_Colorspace.✨
SDL_ColorType(3type)Colorspace color type.✨
SDL_CommonEvent(3type)Fields shared by every event✨
SDL_CompareAndSwapAtomicInt(3)Set an atomic variable to a new value if it is currently an old value.✨
SDL_CompareAndSwapAtomicPointer(3)Set a pointer to a new value if it is currently an old value.✨
SDL_CompareAndSwapAtomicU32(3)Set an atomic variable to a new value if it is currently an old value.✨
SDL_CompareCallback(3type)A callback used with SDL sorting and binary search functions.✨
SDL_CompareCallback_r(3type)A callback used with SDL sorting and binary search functions.✨
SDL_COMPILE_TIME_ASSERT(3)A compile-time assertion.✨
SDL_CompilerBarrier(3)Mark a compiler barrier.✨