libobs-metal: Fix typos

This commit is contained in:
Anton Kesy
2026-01-14 13:47:30 -05:00
committed by Ryan Foster
parent 380ff3fd58
commit 7f022bffa7
4 changed files with 9 additions and 9 deletions
+1 -1
View File
@@ -272,7 +272,7 @@ final class MetalIndexBuffer: MetalBuffer {
/// Sets up buffer objects for the data provided in the provided memory location /// Sets up buffer objects for the data provided in the provided memory location
/// - Parameter data: Pointer to bytes representing index buffer data /// - Parameter data: Pointer to bytes representing index buffer data
/// ///
/// The provided memory location is expected to provide bytes represnting index buffer data as either unsigned /// The provided memory location is expected to provide bytes representing index buffer data as either unsigned
/// 16-bit integers or unsigned 32-bit integers. The size depends on the type used to create the /// 16-bit integers or unsigned 32-bit integers. The size depends on the type used to create the
/// ``MetalIndexBuffer`` instance. /// ``MetalIndexBuffer`` instance.
public func setupBuffers(_ data: UnsafeMutableRawPointer? = nil) { public func setupBuffers(_ data: UnsafeMutableRawPointer? = nil) {
+4 -4
View File
@@ -547,7 +547,7 @@ class MetalDevice {
/// ///
/// This is necessary as the final output of projectors needs to be blitted into the drawables provided by the /// This is necessary as the final output of projectors needs to be blitted into the drawables provided by the
/// `CAMetalLayer` of each ``OBSSwapChain`` at the screen refresh interval, but projectors are usually rendered /// `CAMetalLayer` of each ``OBSSwapChain`` at the screen refresh interval, but projectors are usually rendered
/// using tens of seperate little draw calls. /// using tens of separate little draw calls.
/// ///
/// Thus a virtual "display render stage" state is maintained by the Metal renderer, which is started when a /// Thus a virtual "display render stage" state is maintained by the Metal renderer, which is started when a
/// ``OBSSwapChain`` instance is loaded by `libobs` and ended when `device_end_scene` is called. /// ``OBSSwapChain`` instance is loaded by `libobs` and ended when `device_end_scene` is called.
@@ -626,7 +626,7 @@ class MetalDevice {
/// will fail. /// will fail.
/// ///
/// If the source texture has pending writes (e.g., it was used as the render target for a clear or draw command), /// If the source texture has pending writes (e.g., it was used as the render target for a clear or draw command),
/// then the current command buffer will be comitted to ensure that the blit command encoded by this function /// then the current command buffer will be committed to ensure that the blit command encoded by this function
/// happens after the pending commands. /// happens after the pending commands.
/// ///
/// > Important: This function differs from ``copyTexture`` insofar as it will wait for the completion of all /// > Important: This function differs from ``copyTexture`` insofar as it will wait for the completion of all
@@ -659,7 +659,7 @@ class MetalDevice {
/// textures pixel data. /// textures pixel data.
/// ///
/// If the source texture has pending writes (e.g., it was used as the render target for a clear or draw command), /// If the source texture has pending writes (e.g., it was used as the render target for a clear or draw command),
/// then the current command buffer will be comitted to ensure that the blit command encoded by this function /// then the current command buffer will be committed to ensure that the blit command encoded by this function
/// happens after the pending commands. /// happens after the pending commands.
/// ///
/// > Important: This function will wait for the completion of all commands in the command queue to ensure that the /// > Important: This function will wait for the completion of all commands in the command queue to ensure that the
@@ -737,7 +737,7 @@ class MetalDevice {
/// otherwise the copy operation will fail. /// otherwise the copy operation will fail.
/// ///
/// If the source texture has pending writes (e.g., it was used as the render target for a clear or draw command), /// If the source texture has pending writes (e.g., it was used as the render target for a clear or draw command),
/// then the current command buffer will be comitted to ensure that the blit command encoded by this function /// then the current command buffer will be committed to ensure that the blit command encoded by this function
/// happens after the pending commands. /// happens after the pending commands.
/// ///
func copyTextureRegion( func copyTextureRegion(
+3 -3
View File
@@ -413,7 +413,7 @@ class OBSShader {
/// Analyzes shader uniform parameters parsed by the ``libobs`` shader parser. /// Analyzes shader uniform parameters parsed by the ``libobs`` shader parser.
/// ///
/// Each global variable declared as a "uniform" is stored as an ``OBSShaderVariable`` struct, which will be /// Each global variable declared as a "uniform" is stored as an ``OBSShaderVariable`` struct, which will be
/// extended with additional metadata by later analystics steps. /// extended with additional metadata by later analysis steps.
/// ///
/// This is necessary as MSL does not support global variables and all data needs to be explicitly provided /// This is necessary as MSL does not support global variables and all data needs to be explicitly provided
/// via buffer objects, which requires these "unforms" to be wrapped into a single struct and passed as an explicit /// via buffer objects, which requires these "unforms" to be wrapped into a single struct and passed as an explicit
@@ -465,7 +465,7 @@ class OBSShader {
/// ///
/// Structured data declarations are used to pass data into and out of shaders. /// Structured data declarations are used to pass data into and out of shaders.
/// ///
/// Whereas HLSL allows one to use "InOut" structures with attribute mappings (e.g., using the same type defintion /// Whereas HLSL allows one to use "InOut" structures with attribute mappings (e.g., using the same type definition
/// for vertex data going in and out of a vertex shader), MSL does not allow the mixing of input mappings and output /// for vertex data going in and out of a vertex shader), MSL does not allow the mixing of input mappings and output
/// mappings in the same type definition. /// mappings in the same type definition.
/// ///
@@ -663,7 +663,7 @@ class OBSShader {
/// ///
/// Because MSL does not support global variables, unforms, textures, or samplers need to be passed explicitly to a /// Because MSL does not support global variables, unforms, textures, or samplers need to be passed explicitly to a
/// function. This requires scanning the entire function body (recursively in the case of separate function scopes /// function. This requires scanning the entire function body (recursively in the case of separate function scopes
/// denoted by curvy brackets or parantheses) for any occurrence of a known uniform, texture, or sampler variable /// denoted by curvy brackets or parentheses) for any occurrence of a known uniform, texture, or sampler variable
/// name. /// name.
/// ///
/// - Parameters: /// - Parameters:
+1 -1
View File
@@ -141,7 +141,7 @@ public func gs_indexbuffer_get_num_indices(indexBuffer: UnsafeRawPointer) -> UIn
/// - Parameter indexBuffer: Opaque pointer to ``MetalIndexBuffer`` instance shared with `libobs` /// - Parameter indexBuffer: Opaque pointer to ``MetalIndexBuffer`` instance shared with `libobs`
/// - Returns: Index buffer type as identified by the `gs_index_type` enum /// - Returns: Index buffer type as identified by the `gs_index_type` enum
/// ///
/// > Warning: As the `gs_index_type` enumeration does not provide an "invalid" value (and thus `0` becomes a valied /// > Warning: As the `gs_index_type` enumeration does not provide an "invalid" value (and thus `0` becomes a valid
/// value), this function has no way to communicate an incompatible index buffer type that might be introduced at a /// value), this function has no way to communicate an incompatible index buffer type that might be introduced at a
/// later point. /// later point.
@_cdecl("gs_indexbuffer_get_type") @_cdecl("gs_indexbuffer_get_type")