Don't export CPUStorage from MTL

JuliaGPU · Jul 23, 2024 · e9c59e2 · e9c59e2
1 parent df4cf68
commit e9c59e2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/docs/src/api/array.md b/docs/src/api/array.md
@@ -21,7 +21,6 @@ The Metal API has various storage modes that dictate how a resource can be acces
 Metal.PrivateStorage
 Metal.SharedStorage
 Metal.ManagedStorage
-Metal.CPUStorage
 ```
 
 There also exist the following convenience functions to check if an MtlArray is using a specific storage mode:

diff --git a/lib/mtl/storage_type.jl b/lib/mtl/storage_type.jl
@@ -1,4 +1,4 @@
-export SharedStorage, ManagedStorage, PrivateStorage, CPUStorage
+export SharedStorage, ManagedStorage, PrivateStorage
 export ReadUsage, WriteUsage, ReadWriteUsage
 
 # Metal Has 4 storage types
@@ -18,7 +18,7 @@ For more information on Metal storage modes, refer to the official Metal documen
 
 See also [`Metal.PrivateStorage`](@ref) and [`Metal.ManagedStorage`](@ref).
 """
-struct SharedStorage      <: StorageMode end
+struct SharedStorage  <: StorageMode end
 
 """
     struct Metal.ManagedStorage <: MTL.StorageMode
@@ -29,7 +29,7 @@ For more information on Metal storage modes, refer to the official Metal documen
 
 See also [`Metal.SharedStorage`](@ref) and [`Metal.PrivateStorage`](@ref).
 """
-struct ManagedStorage     <: StorageMode end
+struct ManagedStorage <: StorageMode end
 
 """
     struct Metal.PrivateStorage <: MTL.StorageMode
@@ -40,22 +40,23 @@ For more information on Metal storage modes, refer to the official Metal documen
 
 See also [`Metal.SharedStorage`](@ref) and [`Metal.ManagedStorage`](@ref).
 """
-struct PrivateStorage     <: StorageMode end
-struct Memoryless  <: StorageMode end
+struct PrivateStorage <: StorageMode end
+struct Memoryless     <: StorageMode end
 
 # Remove the ".MTL" when printing
 Base.show(io::IO, ::Type{<:PrivateStorage}) = print(io, "Metal.PrivateStorage")
 Base.show(io::IO, ::Type{<:SharedStorage}) = print(io, "Metal.SharedStorage")
 Base.show(io::IO, ::Type{<:ManagedStorage}) = print(io, "Metal.ManagedStorage")
 
 """
-    CPUStorage
+    MTL.CPUStorage
 
 Union type of [`Metal.SharedStorage`](@ref) and [`Metal.ManagedStorage`](@ref) storage modes.
 
 Represents storage modes where the resource is accessible via the CPU.
 """
 const CPUStorage = Union{SharedStorage,ManagedStorage}
+
 Base.convert(::Type{MTLStorageMode}, ::Type{SharedStorage})     = MTLStorageModeShared
 Base.convert(::Type{MTLStorageMode}, ::Type{ManagedStorage})    = MTLStorageModeManaged
 Base.convert(::Type{MTLStorageMode}, ::Type{PrivateStorage})    = MTLStorageModePrivate