section 3 · Library functions 📚

S (continued)

• SDL_GetSilenceValueForFormat(3)Get the appropriate memset value for silencing an audio format.✨
• SDL_GetSIMDAlignment(3)Report the alignment this system needs for SIMD allocations.✨
• SDL_GetStorageFileSize(3)Query the size of a file within a storage container.✨
• SDL_GetStoragePathInfo(3)Get information about a filesystem path in a storage container.✨
• SDL_GetStorageSpaceRemaining(3)Queries the remaining space in a storage container.✨
• SDL_GetStringProperty(3)Get a string property from a group of properties.✨
• SDL_GetSurfaceAlphaMod(3)Get the additional alpha value used in blit operations.✨
• SDL_GetSurfaceBlendMode(3)Get the blend mode used for blit operations.✨
• SDL_GetSurfaceClipRect(3)Get the clipping rectangle for a surface.✨
• SDL_GetSurfaceColorKey(3)Get the color key (transparent pixel) for a surface.✨
• SDL_GetSurfaceColorMod(3)Get the additional color value multiplied into blit operations.✨
• SDL_GetSurfaceColorspace(3)Get the colorspace used by a surface.✨
• SDL_GetSurfaceImages(3)Get an array including all versions of a surface.✨
• SDL_GetSurfacePalette(3)Get the palette used by a surface.✨
• SDL_GetSurfaceProperties(3)Get the properties associated with a surface.✨
• SDL_GetSystemPageSize(3)Report the size of a page of memory.✨
• SDL_GetSystemRAM(3)Get the amount of RAM configured in the system.✨
• SDL_GetSystemTheme(3)Get the current system theme.✨
• SDL_GetTextInputArea(3)Get the area used to type Unicode text input.✨
• SDL_GetTextureAlphaMod(3)Get the additional alpha value multiplied into render copy operations.✨
• SDL_GetTextureAlphaModFloat(3)Get the additional alpha value multiplied into render copy operations.✨
• SDL_GetTextureBlendMode(3)Get the blend mode used for texture copy operations.✨
• SDL_GetTextureColorMod(3)Get the additional color value multiplied into render copy operations.✨
• SDL_GetTextureColorModFloat(3)Get the additional color value multiplied into render copy operations.✨
• SDL_GetTexturePalette(3)Get the palette used by a texture.✨
• SDL_GetTextureProperties(3)Get the properties associated with a texture.✨
• SDL_GetTextureScaleMode(3)Get the scale mode used for texture scale operations.✨
• SDL_GetTextureSize(3)Get the size of a texture, as floating point values.✨
• SDL_GetThreadID(3)Get the thread identifier for the specified thread.✨
• SDL_GetThreadName(3)Get the thread name as it was specified in SDL_CreateThread().✨
• SDL_GetThreadState(3)Get the current state of a thread.✨
• SDL_GetTicks(3)Get the number of milliseconds that have elapsed since the SDL library initialization.✨
• SDL_GetTicksNS(3)Get the number of nanoseconds since SDL library initialization.✨
• SDL_GetTLS(3)Get the current thread's value associated with a thread local storage ID.✨
• SDL_GetTouchDeviceName(3)Get the touch device name as reported from the driver.✨
• SDL_GetTouchDevices(3)Get a list of registered touch devices.✨
• SDL_GetTouchDeviceType(3)Get the type of the given touch device.✨
• SDL_GetTouchFingers(3)Get a list of active fingers for a given touch device.✨
• SDL_GetTrayEntries(3)Returns a list of entries in the menu, in order.✨
• SDL_GetTrayEntryChecked(3)Gets whether or not an entry is checked.✨
• SDL_GetTrayEntryEnabled(3)Gets whether or not an entry is enabled.✨
• SDL_GetTrayEntryLabel(3)Gets the label of an entry.✨
• SDL_GetTrayEntryParent(3)Gets the menu containing a certain tray entry.✨
• SDL_GetTrayMenu(3)Gets a previously created tray menu.✨
• SDL_GetTrayMenuParentEntry(3)Gets the entry for which the menu is a submenu, if the current menu is a submenu.✨
• SDL_GetTrayMenuParentTray(3)Gets the tray for which this menu is the first-level menu, if the current menu isn't a submenu.✨
• SDL_GetTraySubmenu(3)Gets a previously created tray entry submenu.✨
• SDL_GetUserFolder(3)Finds the most suitable user folder for a specific purpose.✨
• SDL_GetVersion(3)Get the version of SDL that is linked against your program.✨
• SDL_GetVideoDriver(3)Get the name of a built in video driver.✨
• SDL_GetVideoInfo(3)returns a pointer to information about the video hardware✨
• SDL_GetVideoSurface(3)returns a pointer to the current display surface✨
• SDL_GetWindowAspectRatio(3)Get the aspect ratio of a window's client area.✨
• SDL_GetWindowBordersSize(3)Get the size of a window's borders (decorations) around the client area.✨
• SDL_GetWindowDisplayScale(3)Get the content display scale relative to a window's pixel size.✨
• SDL_GetWindowFlags(3)Get the window flags.✨
• SDL_GetWindowFromEvent(3)Get window associated with an event.✨
• SDL_GetWindowFromID(3)Get a window from a stored ID.✨
• SDL_GetWindowFullscreenMode(3)Query the display mode to use when a window is visible at fullscreen.✨
• SDL_GetWindowICCProfile(3)Get the raw ICC profile data for the screen the window is currently on.✨
• SDL_GetWindowID(3)Get the numeric ID of a window.✨
• SDL_GetWindowKeyboardGrab(3)Get a window's keyboard grab mode.✨
• SDL_GetWindowMaximumSize(3)Get the maximum size of a window's client area.✨
• SDL_GetWindowMinimumSize(3)Get the minimum size of a window's client area.✨
• SDL_GetWindowMouseGrab(3)Get a window's mouse grab mode.✨
• SDL_GetWindowMouseRect(3)Get the mouse confinement rectangle of a window.✨
• SDL_GetWindowOpacity(3)Get the opacity of a window.✨
• SDL_GetWindowParent(3)Get parent of a window.✨
• SDL_GetWindowPixelDensity(3)Get the pixel density of a window.✨
• SDL_GetWindowPixelFormat(3)Get the pixel format associated with the window.✨
• SDL_GetWindowPosition(3)Get the position of a window.✨
• SDL_GetWindowProgressState(3)Get the state of the progress bar for the given window’s taskbar icon.✨
• SDL_GetWindowProgressValue(3)Get the value of the progress bar for the given window’s taskbar icon.✨
• SDL_GetWindowProperties(3)Get the properties associated with a window.✨
• SDL_GetWindowRelativeMouseMode(3)Query whether relative mouse mode is enabled for a window.✨
• SDL_GetWindows(3)Get a list of valid windows.✨
• SDL_GetWindowSafeArea(3)Get the safe area for this window.✨
• SDL_GetWindowSize(3)Get the size of a window's client area.✨
• SDL_GetWindowSizeInPixels(3)Get the size of a window's client area, in pixels.✨
• SDL_GetWindowSurface(3)Get the SDL surface associated with the window.✨
• SDL_GetWindowSurfaceVSync(3)Get VSync for the window surface.✨
• SDL_GetWindowTitle(3)Get the title of a window.✨
• SDL_GL_CreateContext(3)Create an OpenGL context for an OpenGL window, and make it current.✨
• SDL_GL_DestroyContext(3)Delete an OpenGL context.✨
• SDL_GL_ExtensionSupported(3)Check if an OpenGL extension is supported for the current context.✨
• SDL_GL_GetAttribute(3)Get the actual value for an attribute from the current context.✨
• SDL_GL_GetCurrentContext(3)Get the currently active OpenGL context.✨
• SDL_GL_GetCurrentWindow(3)Get the currently active OpenGL window.✨
• SDL_GL_GetProcAddress(3)Get an OpenGL function by name.✨
• SDL_GL_GetSwapInterval(3)Get the swap interval for the current OpenGL context.✨
• SDL_GL_LoadLibrary(3)Dynamically load an OpenGL library.✨
• SDL_GL_MakeCurrent(3)Set up an OpenGL context for rendering into an OpenGL window.✨
• SDL_GL_ResetAttributes(3)Reset all previously set OpenGL context attributes to their default values.✨
• SDL_GL_SetAttribute(3)Set an OpenGL window attribute before window creation.✨
• SDL_GL_SetSwapInterval(3)Set the swap interval for the current OpenGL context.✨
• SDL_GL_SwapBuffers(3)Swap OpenGL framebuffers/Update Display✨
• SDL_GL_SwapWindow(3)Update a window with OpenGL rendering.✨
• SDL_GL_UnloadLibrary(3)Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().✨
• SDL_GLattr(3)SDL GL Attributes✨
• SDL_GLAttr(3type)An enumeration of OpenGL configuration attributes.✨
• SDL_GLContext(3type)An opaque handle to an OpenGL context.✨
• SDL_GLContextFlag(3type)Possible flags to be set for the SDL_GL_CONTEXT_FLAGS attribute.✨
• SDL_GLContextReleaseFlag(3type)Possible values to be set for the SDL_GL_CONTEXT_RELEASE_BEHAVIOR attribute.✨
• SDL_GLContextResetNotification(3type)Possible values to be set SDL_GL_CONTEXT_RESET_NOTIFICATION attribute.✨
• SDL_GlobDirectory(3)Enumerate a directory tree, filtered by pattern, and return a list.✨
• SDL_GlobFlags(3type)Flags for path matching.✨
• SDL_GlobStorageDirectory(3)Enumerate a directory tree, filtered by pattern, and return a list.✨
• SDL_GLProfile(3type)Possible values to be set for the SDL_GL_CONTEXT_PROFILE_MASK attribute.✨
• SDL_GPU_RENDERER(3)The name of the GPU renderer.✨
• SDL_GPUBlendFactor(3type)Specifies a blending factor to be used when pixels in a render target are blended with existing pixels in the texture.✨
• SDL_GPUBlendOp(3type)Specifies the operator to be used when pixels in a render target are blended with existing pixels in the texture.✨
• SDL_GPUBlitInfo(3type)A structure containing parameters for a blit command.✨
• SDL_GPUBlitRegion(3type)A structure specifying a region of a texture used in the blit operation.✨
• SDL_GPUBuffer(3type)An opaque handle representing a buffer.✨
• SDL_GPUBufferBinding(3type)A structure specifying parameters in a buffer binding call.✨
• SDL_GPUBufferCreateInfo(3type)A structure specifying the parameters of a buffer.✨
• SDL_GPUBufferLocation(3type)A structure specifying a location in a buffer.✨
• SDL_GPUBufferRegion(3type)A structure specifying a region of a buffer.✨
• SDL_GPUBufferUsageFlags(3type)Specifies how a buffer is intended to be used by the client.✨
• SDL_GPUColorComponentFlags(3type)Specifies which color components are written in a graphics pipeline.✨
• SDL_GPUColorTargetBlendState(3type)A structure specifying the blend state of a color target.✨
• SDL_GPUColorTargetDescription(3type)A structure specifying the parameters of color targets used in a graphics pipeline.✨
• SDL_GPUColorTargetInfo(3type)A structure specifying the parameters of a color target used by a render pass.✨
• SDL_GPUCommandBuffer(3type)An opaque handle representing a command buffer.✨
• SDL_GPUCompareOp(3type)Specifies a comparison operator for depth, stencil and sampler operations.✨
• SDL_GPUComputePass(3type)An opaque handle representing a compute pass.✨
• SDL_GPUComputePipeline(3type)An opaque handle representing a compute pipeline.✨
• SDL_GPUComputePipelineCreateInfo(3type)A structure specifying the parameters of a compute pipeline state.✨
• SDL_GPUCopyPass(3type)An opaque handle representing a copy pass.✨
• SDL_GPUCubeMapFace(3type)Specifies the face of a cube map.✨
• SDL_GPUCullMode(3type)Specifies the facing direction in which triangle faces will be culled.✨
• SDL_GPUDepthStencilState(3type)A structure specifying the parameters of the graphics pipeline depth stencil state.✨
• SDL_GPUDepthStencilTargetInfo(3type)A structure specifying the parameters of a depth-stencil target used by a render pass.✨
• SDL_GPUDevice(3type)An opaque handle representing the SDL_GPU context.✨
• SDL_GPUFence(3type)An opaque handle representing a fence.✨
• SDL_GPUFillMode(3type)Specifies the fill mode of the graphics pipeline.✨
• SDL_GPUFilter(3type)Specifies a filter operation used by a sampler.✨
• SDL_GPUFrontFace(3type)Specifies the vertex winding that will cause a triangle to be determined to be front-facing.✨
• SDL_GPUGraphicsPipeline(3type)An opaque handle representing a graphics pipeline.✨
• SDL_GPUGraphicsPipelineCreateInfo(3type)A structure specifying the parameters of a graphics pipeline state.✨
• SDL_GPUGraphicsPipelineTargetInfo(3type)A structure specifying the descriptions of render targets used in a graphics pipeline.✨
• SDL_GPUIndexedIndirectDrawCommand(3type)A structure specifying the parameters of an indexed indirect draw command.✨
• SDL_GPUIndexElementSize(3type)Specifies the size of elements in an index buffer.✨
• SDL_GPUIndirectDispatchCommand(3type)A structure specifying the parameters of an indexed dispatch command.✨
• SDL_GPUIndirectDrawCommand(3type)A structure specifying the parameters of an indirect draw command.✨
• SDL_GPULoadOp(3type)Specifies how the contents of a texture attached to a render pass are treated at the beginning of the render pass.✨
• SDL_GPUMultisampleState(3type)A structure specifying the parameters of the graphics pipeline multisample state.✨
• SDL_GPUPresentMode(3type)Specifies the timing that will be used to present swapchain textures to the OS.✨
• SDL_GPUPrimitiveType(3type)Specifies the primitive topology of a graphics pipeline.✨
• SDL_GPURasterizerState(3type)A structure specifying the parameters of the graphics pipeline rasterizer state.✨
• SDL_GPURenderPass(3type)An opaque handle representing a render pass.✨
• SDL_GPURenderState(3type)A custom GPU render state.✨
• SDL_GPURenderStateCreateInfo(3type)A structure specifying the parameters of a GPU render state.✨
• SDL_GPUSampleCount(3type)Specifies the sample count of a texture.✨
• SDL_GPUSampler(3type)An opaque handle representing a sampler.✨
• SDL_GPUSamplerAddressMode(3type)Specifies behavior of texture sampling when the coordinates exceed the 0-1 range.✨
• SDL_GPUSamplerCreateInfo(3type)A structure specifying the parameters of a sampler.✨
• SDL_GPUSamplerMipmapMode(3type)Specifies a mipmap mode used by a sampler.✨
• SDL_GPUShader(3type)An opaque handle representing a compiled shader object.✨
• SDL_GPUShaderCreateInfo(3type)A structure specifying code and metadata for creating a shader object.✨
• SDL_GPUShaderFormat(3type)Specifies the format of shader code.✨
• SDL_GPUShaderStage(3type)Specifies which stage a shader program corresponds to.✨
• SDL_GPUStencilOp(3type)Specifies what happens to a stored stencil value if stencil tests fail or pass.✨
• SDL_GPUStencilOpState(3type)A structure specifying the stencil operation state of a graphics pipeline.✨
• SDL_GPUStorageBufferReadWriteBinding(3type)A structure specifying parameters related to binding buffers in a compute pass.✨
• SDL_GPUStorageTextureReadWriteBinding(3type)A structure specifying parameters related to binding textures in a compute pass.✨
• SDL_GPUStoreOp(3type)Specifies how the contents of a texture attached to a render pass are treated at the end of the render pass.✨
• SDL_GPUSupportsProperties(3)Checks for GPU runtime support.✨
• SDL_GPUSupportsShaderFormats(3)Checks for GPU runtime support.✨
• SDL_GPUSwapchainComposition(3type)Specifies the texture format and colorspace of the swapchain textures.✨
• SDL_GPUTexture(3type)An opaque handle representing a texture.✨
• SDL_GPUTextureCreateInfo(3type)A structure specifying the parameters of a texture.✨
• SDL_GPUTextureFormat(3type)Specifies the pixel format of a texture.✨
• SDL_GPUTextureFormatTexelBlockSize(3)Obtains the texel block size for a texture format.✨
• SDL_GPUTextureLocation(3type)A structure specifying a location in a texture.✨
• SDL_GPUTextureRegion(3type)A structure specifying a region of a texture.✨
• SDL_GPUTextureSamplerBinding(3type)A structure specifying parameters in a sampler binding call.✨
• SDL_GPUTextureSupportsFormat(3)Determines whether a texture format is supported for a given type and usage.✨
• SDL_GPUTextureSupportsSampleCount(3)Determines if a sample count for a texture format is supported.✨
• SDL_GPUTextureTransferInfo(3type)A structure specifying parameters related to transferring data to or from a texture.✨
• SDL_GPUTextureType(3type)Specifies the type of a texture.✨
• SDL_GPUTextureUsageFlags(3type)Specifies how a texture is intended to be used by the client.✨
• SDL_GPUTransferBuffer(3type)An opaque handle representing a transfer buffer.✨
• SDL_GPUTransferBufferCreateInfo(3type)A structure specifying the parameters of a transfer buffer.✨
• SDL_GPUTransferBufferLocation(3type)A structure specifying a location in a transfer buffer.✨
• SDL_GPUTransferBufferUsage(3type)Specifies how a transfer buffer is intended to be used by the client.✨
• SDL_GPUVertexAttribute(3type)A structure specifying a vertex attribute.✨
• SDL_GPUVertexBufferDescription(3type)A structure specifying the parameters of vertex buffers used in a graphics pipeline.✨
• SDL_GPUVertexElementFormat(3type)Specifies the format of a vertex attribute.✨
• SDL_GPUVertexInputRate(3type)Specifies the rate at which vertex attributes are pulled from buffers.✨
• SDL_GPUVertexInputState(3type)A structure specifying the parameters of a graphics pipeline vertex input state.✨
• SDL_GPUViewport(3type)A structure specifying a viewport.✨
• SDL_GPUVulkanOptions(3type)A structure specifying additional options when using Vulkan.✨
• SDL_GUARDED_BY(3)Wrapper around Clang thread safety analysis annotations.✨
• SDL_GUID(3type)An SDL_GUID is a 128-bit identifier for an input device that identifies that device across runs of SDL programs on the same platform.✨
• SDL_GUIDToString(3)Get an ASCII string representation for a given SDL_GUID.✨
• SDL_Haptic(3type)The haptic structure used to identify an SDL haptic.✨
• SDL_HAPTIC_AUTOCENTER(3)Device can set autocenter.✨
• SDL_HAPTIC_CARTESIAN(3)Uses cartesian coordinates for the direction.✨
• SDL_HAPTIC_CONSTANT(3)Constant effect supported.✨