Pipeline.cs 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877
  1. using Ryujinx.Common.Logging;
  2. using Ryujinx.Graphics.GAL;
  3. using Ryujinx.Graphics.Shader;
  4. using SharpMetal.Foundation;
  5. using SharpMetal.Metal;
  6. using SharpMetal.QuartzCore;
  7. using System;
  8. using System.Runtime.Versioning;
  9. namespace Ryujinx.Graphics.Metal
  10. {
  11. public enum EncoderType
  12. {
  13. Blit,
  14. Compute,
  15. Render,
  16. None
  17. }
  18. [SupportedOSPlatform("macos")]
  19. class Pipeline : IPipeline, IEncoderFactory, IDisposable
  20. {
  21. private const ulong MinByteWeightForFlush = 256 * 1024 * 1024; // MiB
  22. private readonly MTLDevice _device;
  23. private readonly MetalRenderer _renderer;
  24. private EncoderStateManager _encoderStateManager;
  25. private ulong _byteWeight;
  26. public MTLCommandBuffer CommandBuffer;
  27. public IndexBufferPattern QuadsToTrisPattern;
  28. public IndexBufferPattern TriFanToTrisPattern;
  29. internal CommandBufferScoped? PreloadCbs { get; private set; }
  30. internal CommandBufferScoped Cbs { get; private set; }
  31. internal CommandBufferEncoder Encoders => Cbs.Encoders;
  32. internal EncoderType CurrentEncoderType => Encoders.CurrentEncoderType;
  33. public Pipeline(MTLDevice device, MetalRenderer renderer)
  34. {
  35. _device = device;
  36. _renderer = renderer;
  37. renderer.CommandBufferPool.Initialize(this);
  38. CommandBuffer = (Cbs = _renderer.CommandBufferPool.Rent()).CommandBuffer;
  39. }
  40. internal void InitEncoderStateManager(BufferManager bufferManager)
  41. {
  42. _encoderStateManager = new EncoderStateManager(_device, bufferManager, this);
  43. QuadsToTrisPattern = new IndexBufferPattern(_renderer, 4, 6, 0, [0, 1, 2, 0, 2, 3], 4, false);
  44. TriFanToTrisPattern = new IndexBufferPattern(_renderer, 3, 3, 2, [int.MinValue, -1, 0], 1, true);
  45. }
  46. public EncoderState SwapState(EncoderState state, DirtyFlags flags = DirtyFlags.All, bool endRenderPass = true)
  47. {
  48. if (endRenderPass && CurrentEncoderType == EncoderType.Render)
  49. {
  50. EndCurrentPass();
  51. }
  52. return _encoderStateManager.SwapState(state, flags);
  53. }
  54. public PredrawState SavePredrawState()
  55. {
  56. return _encoderStateManager.SavePredrawState();
  57. }
  58. public void RestorePredrawState(PredrawState state)
  59. {
  60. _encoderStateManager.RestorePredrawState(state);
  61. }
  62. public void SetClearLoadAction(bool clear)
  63. {
  64. _encoderStateManager.SetClearLoadAction(clear);
  65. }
  66. public MTLRenderCommandEncoder GetOrCreateRenderEncoder(bool forDraw = false)
  67. {
  68. // Mark all state as dirty to ensure it is set on the new encoder
  69. if (Cbs.Encoders.CurrentEncoderType != EncoderType.Render)
  70. {
  71. _encoderStateManager.SignalRenderDirty();
  72. }
  73. if (forDraw)
  74. {
  75. _encoderStateManager.RenderResourcesPrepass();
  76. }
  77. MTLRenderCommandEncoder renderCommandEncoder = Cbs.Encoders.EnsureRenderEncoder();
  78. if (forDraw)
  79. {
  80. _encoderStateManager.RebindRenderState(renderCommandEncoder);
  81. }
  82. return renderCommandEncoder;
  83. }
  84. public MTLBlitCommandEncoder GetOrCreateBlitEncoder()
  85. {
  86. return Cbs.Encoders.EnsureBlitEncoder();
  87. }
  88. public MTLComputeCommandEncoder GetOrCreateComputeEncoder(bool forDispatch = false)
  89. {
  90. // Mark all state as dirty to ensure it is set on the new encoder
  91. if (Cbs.Encoders.CurrentEncoderType != EncoderType.Compute)
  92. {
  93. _encoderStateManager.SignalComputeDirty();
  94. }
  95. if (forDispatch)
  96. {
  97. _encoderStateManager.ComputeResourcesPrepass();
  98. }
  99. MTLComputeCommandEncoder computeCommandEncoder = Cbs.Encoders.EnsureComputeEncoder();
  100. if (forDispatch)
  101. {
  102. _encoderStateManager.RebindComputeState(computeCommandEncoder);
  103. }
  104. return computeCommandEncoder;
  105. }
  106. public void EndCurrentPass()
  107. {
  108. Cbs.Encoders.EndCurrentPass();
  109. }
  110. public MTLRenderCommandEncoder CreateRenderCommandEncoder()
  111. {
  112. return _encoderStateManager.CreateRenderCommandEncoder();
  113. }
  114. public MTLComputeCommandEncoder CreateComputeCommandEncoder()
  115. {
  116. return _encoderStateManager.CreateComputeCommandEncoder();
  117. }
  118. public void Present(CAMetalDrawable drawable, Texture src, Extents2D srcRegion, Extents2D dstRegion, bool isLinear)
  119. {
  120. // TODO: Clean this up
  121. TextureCreateInfo textureInfo = new((int)drawable.Texture.Width, (int)drawable.Texture.Height, (int)drawable.Texture.Depth, (int)drawable.Texture.MipmapLevelCount, (int)drawable.Texture.SampleCount, 0, 0, 0, Format.B8G8R8A8Unorm, 0, Target.Texture2D, SwizzleComponent.Red, SwizzleComponent.Green, SwizzleComponent.Blue, SwizzleComponent.Alpha);
  122. Texture dst = new(_device, _renderer, this, textureInfo, drawable.Texture, 0, 0);
  123. _renderer.HelperShader.BlitColor(Cbs, src, dst, srcRegion, dstRegion, isLinear, true);
  124. EndCurrentPass();
  125. Cbs.CommandBuffer.PresentDrawable(drawable);
  126. FlushCommandsImpl();
  127. // TODO: Auto flush counting
  128. _renderer.SyncManager.GetAndResetWaitTicks();
  129. // Cleanup
  130. dst.Dispose();
  131. }
  132. public CommandBufferScoped GetPreloadCommandBuffer()
  133. {
  134. PreloadCbs ??= _renderer.CommandBufferPool.Rent();
  135. return PreloadCbs.Value;
  136. }
  137. public void FlushCommandsIfWeightExceeding(IAuto disposedResource, ulong byteWeight)
  138. {
  139. bool usedByCurrentCb = disposedResource.HasCommandBufferDependency(Cbs);
  140. if (PreloadCbs != null && !usedByCurrentCb)
  141. {
  142. usedByCurrentCb = disposedResource.HasCommandBufferDependency(PreloadCbs.Value);
  143. }
  144. if (usedByCurrentCb)
  145. {
  146. // Since we can only free memory after the command buffer that uses a given resource was executed,
  147. // keeping the command buffer might cause a high amount of memory to be in use.
  148. // To prevent that, we force submit command buffers if the memory usage by resources
  149. // in use by the current command buffer is above a given limit, and those resources were disposed.
  150. _byteWeight += byteWeight;
  151. if (_byteWeight >= MinByteWeightForFlush)
  152. {
  153. FlushCommandsImpl();
  154. }
  155. }
  156. }
  157. public void FlushCommandsImpl()
  158. {
  159. EndCurrentPass();
  160. _byteWeight = 0;
  161. if (PreloadCbs != null)
  162. {
  163. PreloadCbs.Value.Dispose();
  164. PreloadCbs = null;
  165. }
  166. CommandBuffer = (Cbs = _renderer.CommandBufferPool.ReturnAndRent(Cbs)).CommandBuffer;
  167. _renderer.RegisterFlush();
  168. }
  169. public void DirtyTextures()
  170. {
  171. _encoderStateManager.DirtyTextures();
  172. }
  173. public void DirtyImages()
  174. {
  175. _encoderStateManager.DirtyImages();
  176. }
  177. public void Blit(
  178. Texture src,
  179. Texture dst,
  180. Extents2D srcRegion,
  181. Extents2D dstRegion,
  182. bool isDepthOrStencil,
  183. bool linearFilter)
  184. {
  185. if (isDepthOrStencil)
  186. {
  187. _renderer.HelperShader.BlitDepthStencil(Cbs, src, dst, srcRegion, dstRegion);
  188. }
  189. else
  190. {
  191. _renderer.HelperShader.BlitColor(Cbs, src, dst, srcRegion, dstRegion, linearFilter);
  192. }
  193. }
  194. public void Barrier()
  195. {
  196. switch (CurrentEncoderType)
  197. {
  198. case EncoderType.Render:
  199. {
  200. MTLBarrierScope scope = MTLBarrierScope.Buffers | MTLBarrierScope.Textures | MTLBarrierScope.RenderTargets;
  201. MTLRenderStages stages = MTLRenderStages.RenderStageVertex | MTLRenderStages.RenderStageFragment;
  202. Encoders.RenderEncoder.MemoryBarrier(scope, stages, stages);
  203. break;
  204. }
  205. case EncoderType.Compute:
  206. {
  207. MTLBarrierScope scope = MTLBarrierScope.Buffers | MTLBarrierScope.Textures | MTLBarrierScope.RenderTargets;
  208. Encoders.ComputeEncoder.MemoryBarrier(scope);
  209. break;
  210. }
  211. }
  212. }
  213. public void ClearBuffer(BufferHandle destination, int offset, int size, uint value)
  214. {
  215. MTLBlitCommandEncoder blitCommandEncoder = GetOrCreateBlitEncoder();
  216. MTLBuffer mtlBuffer = _renderer.BufferManager.GetBuffer(destination, offset, size, true).Get(Cbs, offset, size, true).Value;
  217. // Might need a closer look, range's count, lower, and upper bound
  218. // must be a multiple of 4
  219. blitCommandEncoder.FillBuffer(mtlBuffer,
  220. new NSRange
  221. {
  222. location = (ulong)offset,
  223. length = (ulong)size
  224. },
  225. (byte)value);
  226. }
  227. public void ClearRenderTargetColor(int index, int layer, int layerCount, uint componentMask, ColorF color)
  228. {
  229. float[] colors = [color.Red, color.Green, color.Blue, color.Alpha];
  230. Texture dst = _encoderStateManager.RenderTargets[index];
  231. // TODO: Remove workaround for Wonder which has an invalid texture due to unsupported format
  232. if (dst == null)
  233. {
  234. Logger.Warning?.PrintMsg(LogClass.Gpu, "Attempted to clear invalid render target!");
  235. return;
  236. }
  237. _renderer.HelperShader.ClearColor(index, colors, componentMask, dst.Width, dst.Height, dst.Info.Format);
  238. }
  239. public void ClearRenderTargetDepthStencil(int layer, int layerCount, float depthValue, bool depthMask, int stencilValue, int stencilMask)
  240. {
  241. Texture depthStencil = _encoderStateManager.DepthStencil;
  242. if (depthStencil == null)
  243. {
  244. return;
  245. }
  246. _renderer.HelperShader.ClearDepthStencil(depthValue, depthMask, stencilValue, stencilMask, depthStencil.Width, depthStencil.Height);
  247. }
  248. public void CommandBufferBarrier()
  249. {
  250. Barrier();
  251. }
  252. public void CopyBuffer(BufferHandle src, BufferHandle dst, int srcOffset, int dstOffset, int size)
  253. {
  254. Auto<DisposableBuffer> srcBuffer = _renderer.BufferManager.GetBuffer(src, srcOffset, size, false);
  255. Auto<DisposableBuffer> dstBuffer = _renderer.BufferManager.GetBuffer(dst, dstOffset, size, true);
  256. BufferHolder.Copy(Cbs, srcBuffer, dstBuffer, srcOffset, dstOffset, size);
  257. }
  258. public void PushDebugGroup(string name)
  259. {
  260. MTLCommandEncoder? encoder = Encoders.CurrentEncoder;
  261. NSString debugGroupName = StringHelper.NSString(name);
  262. if (encoder == null)
  263. {
  264. return;
  265. }
  266. switch (Encoders.CurrentEncoderType)
  267. {
  268. case EncoderType.Render:
  269. encoder.Value.PushDebugGroup(debugGroupName);
  270. break;
  271. case EncoderType.Blit:
  272. encoder.Value.PushDebugGroup(debugGroupName);
  273. break;
  274. case EncoderType.Compute:
  275. encoder.Value.PushDebugGroup(debugGroupName);
  276. break;
  277. }
  278. }
  279. public void PopDebugGroup()
  280. {
  281. MTLCommandEncoder? encoder = Encoders.CurrentEncoder;
  282. if (encoder == null)
  283. {
  284. return;
  285. }
  286. switch (Encoders.CurrentEncoderType)
  287. {
  288. case EncoderType.Render:
  289. encoder.Value.PopDebugGroup();
  290. break;
  291. case EncoderType.Blit:
  292. encoder.Value.PopDebugGroup();
  293. break;
  294. case EncoderType.Compute:
  295. encoder.Value.PopDebugGroup();
  296. break;
  297. }
  298. }
  299. public void DispatchCompute(int groupsX, int groupsY, int groupsZ)
  300. {
  301. DispatchCompute(groupsX, groupsY, groupsZ, String.Empty);
  302. }
  303. public void DispatchCompute(int groupsX, int groupsY, int groupsZ, string debugGroupName)
  304. {
  305. MTLComputeCommandEncoder computeCommandEncoder = GetOrCreateComputeEncoder(true);
  306. ComputeSize localSize = _encoderStateManager.ComputeLocalSize;
  307. if (debugGroupName != String.Empty)
  308. {
  309. PushDebugGroup(debugGroupName);
  310. }
  311. computeCommandEncoder.DispatchThreadgroups(
  312. new MTLSize { width = (ulong)groupsX, height = (ulong)groupsY, depth = (ulong)groupsZ },
  313. new MTLSize { width = (ulong)localSize.X, height = (ulong)localSize.Y, depth = (ulong)localSize.Z });
  314. if (debugGroupName != String.Empty)
  315. {
  316. PopDebugGroup();
  317. }
  318. }
  319. public void Draw(int vertexCount, int instanceCount, int firstVertex, int firstInstance)
  320. {
  321. Draw(vertexCount, instanceCount, firstVertex, firstInstance, String.Empty);
  322. }
  323. public void Draw(int vertexCount, int instanceCount, int firstVertex, int firstInstance, string debugGroupName)
  324. {
  325. if (vertexCount == 0)
  326. {
  327. return;
  328. }
  329. MTLPrimitiveType primitiveType = TopologyRemap(_encoderStateManager.Topology).Convert();
  330. if (TopologyUnsupported(_encoderStateManager.Topology))
  331. {
  332. IndexBufferPattern pattern = GetIndexBufferPattern();
  333. BufferHandle handle = pattern.GetRepeatingBuffer(vertexCount, out int indexCount);
  334. Auto<DisposableBuffer> buffer = _renderer.BufferManager.GetBuffer(handle, false);
  335. MTLBuffer mtlBuffer = buffer.Get(Cbs, 0, indexCount * sizeof(int)).Value;
  336. MTLRenderCommandEncoder renderCommandEncoder = GetOrCreateRenderEncoder(true);
  337. renderCommandEncoder.DrawIndexedPrimitives(
  338. primitiveType,
  339. (ulong)indexCount,
  340. MTLIndexType.UInt32,
  341. mtlBuffer,
  342. 0);
  343. }
  344. else
  345. {
  346. MTLRenderCommandEncoder renderCommandEncoder = GetOrCreateRenderEncoder(true);
  347. if (debugGroupName != String.Empty)
  348. {
  349. PushDebugGroup(debugGroupName);
  350. }
  351. renderCommandEncoder.DrawPrimitives(
  352. primitiveType,
  353. (ulong)firstVertex,
  354. (ulong)vertexCount,
  355. (ulong)instanceCount,
  356. (ulong)firstInstance);
  357. if (debugGroupName != String.Empty)
  358. {
  359. PopDebugGroup();
  360. }
  361. }
  362. }
  363. private IndexBufferPattern GetIndexBufferPattern()
  364. {
  365. return _encoderStateManager.Topology switch
  366. {
  367. PrimitiveTopology.Quads => QuadsToTrisPattern,
  368. PrimitiveTopology.TriangleFan or PrimitiveTopology.Polygon => TriFanToTrisPattern,
  369. _ => throw new NotSupportedException($"Unsupported topology: {_encoderStateManager.Topology}"),
  370. };
  371. }
  372. private PrimitiveTopology TopologyRemap(PrimitiveTopology topology)
  373. {
  374. return topology switch
  375. {
  376. PrimitiveTopology.Quads => PrimitiveTopology.Triangles,
  377. PrimitiveTopology.QuadStrip => PrimitiveTopology.TriangleStrip,
  378. PrimitiveTopology.TriangleFan or PrimitiveTopology.Polygon => PrimitiveTopology.Triangles,
  379. _ => topology,
  380. };
  381. }
  382. private bool TopologyUnsupported(PrimitiveTopology topology)
  383. {
  384. return topology switch
  385. {
  386. PrimitiveTopology.Quads or PrimitiveTopology.TriangleFan or PrimitiveTopology.Polygon => true,
  387. _ => false,
  388. };
  389. }
  390. public void DrawIndexed(int indexCount, int instanceCount, int firstIndex, int firstVertex, int firstInstance)
  391. {
  392. if (indexCount == 0)
  393. {
  394. return;
  395. }
  396. MTLBuffer mtlBuffer;
  397. int offset;
  398. MTLIndexType type;
  399. int finalIndexCount = indexCount;
  400. MTLPrimitiveType primitiveType = TopologyRemap(_encoderStateManager.Topology).Convert();
  401. if (TopologyUnsupported(_encoderStateManager.Topology))
  402. {
  403. IndexBufferPattern pattern = GetIndexBufferPattern();
  404. int convertedCount = pattern.GetConvertedCount(indexCount);
  405. finalIndexCount = convertedCount;
  406. (mtlBuffer, offset, type) = _encoderStateManager.IndexBuffer.GetConvertedIndexBuffer(_renderer, Cbs, firstIndex, indexCount, convertedCount, pattern);
  407. }
  408. else
  409. {
  410. (mtlBuffer, offset, type) = _encoderStateManager.IndexBuffer.GetIndexBuffer(_renderer, Cbs);
  411. }
  412. if (mtlBuffer.NativePtr != IntPtr.Zero)
  413. {
  414. MTLRenderCommandEncoder renderCommandEncoder = GetOrCreateRenderEncoder(true);
  415. renderCommandEncoder.DrawIndexedPrimitives(
  416. primitiveType,
  417. (ulong)finalIndexCount,
  418. type,
  419. mtlBuffer,
  420. (ulong)offset,
  421. (ulong)instanceCount,
  422. firstVertex,
  423. (ulong)firstInstance);
  424. }
  425. }
  426. public void DrawIndexedIndirect(BufferRange indirectBuffer)
  427. {
  428. DrawIndexedIndirectOffset(indirectBuffer);
  429. }
  430. public void DrawIndexedIndirectOffset(BufferRange indirectBuffer, int offset = 0)
  431. {
  432. // TODO: Reindex unsupported topologies
  433. if (TopologyUnsupported(_encoderStateManager.Topology))
  434. {
  435. Logger.Warning?.Print(LogClass.Gpu, $"Drawing indexed with unsupported topology: {_encoderStateManager.Topology}");
  436. }
  437. MTLBuffer buffer = _renderer.BufferManager
  438. .GetBuffer(indirectBuffer.Handle, indirectBuffer.Offset, indirectBuffer.Size, false)
  439. .Get(Cbs, indirectBuffer.Offset, indirectBuffer.Size).Value;
  440. MTLPrimitiveType primitiveType = TopologyRemap(_encoderStateManager.Topology).Convert();
  441. (MTLBuffer indexBuffer, int indexOffset, MTLIndexType type) = _encoderStateManager.IndexBuffer.GetIndexBuffer(_renderer, Cbs);
  442. if (indexBuffer.NativePtr != IntPtr.Zero && buffer.NativePtr != IntPtr.Zero)
  443. {
  444. MTLRenderCommandEncoder renderCommandEncoder = GetOrCreateRenderEncoder(true);
  445. renderCommandEncoder.DrawIndexedPrimitives(
  446. primitiveType,
  447. type,
  448. indexBuffer,
  449. (ulong)indexOffset,
  450. buffer,
  451. (ulong)(indirectBuffer.Offset + offset));
  452. }
  453. }
  454. public void DrawIndexedIndirectCount(BufferRange indirectBuffer, BufferRange parameterBuffer, int maxDrawCount, int stride)
  455. {
  456. for (int i = 0; i < maxDrawCount; i++)
  457. {
  458. DrawIndexedIndirectOffset(indirectBuffer, stride * i);
  459. }
  460. }
  461. public void DrawIndirect(BufferRange indirectBuffer)
  462. {
  463. DrawIndirectOffset(indirectBuffer);
  464. }
  465. public void DrawIndirectOffset(BufferRange indirectBuffer, int offset = 0)
  466. {
  467. if (TopologyUnsupported(_encoderStateManager.Topology))
  468. {
  469. // TODO: Reindex unsupported topologies
  470. Logger.Warning?.Print(LogClass.Gpu, $"Drawing indirect with unsupported topology: {_encoderStateManager.Topology}");
  471. }
  472. MTLBuffer buffer = _renderer.BufferManager
  473. .GetBuffer(indirectBuffer.Handle, indirectBuffer.Offset, indirectBuffer.Size, false)
  474. .Get(Cbs, indirectBuffer.Offset, indirectBuffer.Size).Value;
  475. MTLPrimitiveType primitiveType = TopologyRemap(_encoderStateManager.Topology).Convert();
  476. MTLRenderCommandEncoder renderCommandEncoder = GetOrCreateRenderEncoder(true);
  477. renderCommandEncoder.DrawPrimitives(
  478. primitiveType,
  479. buffer,
  480. (ulong)(indirectBuffer.Offset + offset));
  481. }
  482. public void DrawIndirectCount(BufferRange indirectBuffer, BufferRange parameterBuffer, int maxDrawCount, int stride)
  483. {
  484. for (int i = 0; i < maxDrawCount; i++)
  485. {
  486. DrawIndirectOffset(indirectBuffer, stride * i);
  487. }
  488. }
  489. public void DrawTexture(ITexture texture, ISampler sampler, Extents2DF srcRegion, Extents2DF dstRegion)
  490. {
  491. _renderer.HelperShader.DrawTexture(texture, sampler, srcRegion, dstRegion);
  492. }
  493. public void SetAlphaTest(bool enable, float reference, CompareOp op)
  494. {
  495. // This is currently handled using shader specialization, as Metal does not support alpha test.
  496. // In the future, we may want to use this to write the reference value into the support buffer,
  497. // to avoid creating one version of the shader per reference value used.
  498. }
  499. public void SetBlendState(AdvancedBlendDescriptor blend)
  500. {
  501. // Metal does not support advanced blend.
  502. }
  503. public void SetBlendState(int index, BlendDescriptor blend)
  504. {
  505. _encoderStateManager.UpdateBlendDescriptors(index, blend);
  506. }
  507. public void SetDepthBias(PolygonModeMask enables, float factor, float units, float clamp)
  508. {
  509. if (enables == 0)
  510. {
  511. _encoderStateManager.UpdateDepthBias(0, 0, 0);
  512. }
  513. else
  514. {
  515. _encoderStateManager.UpdateDepthBias(units, factor, clamp);
  516. }
  517. }
  518. public void SetDepthClamp(bool clamp)
  519. {
  520. _encoderStateManager.UpdateDepthClamp(clamp);
  521. }
  522. public void SetDepthMode(DepthMode mode)
  523. {
  524. // Metal does not support depth clip control.
  525. }
  526. public void SetDepthTest(DepthTestDescriptor depthTest)
  527. {
  528. _encoderStateManager.UpdateDepthState(depthTest);
  529. }
  530. public void SetFaceCulling(bool enable, Face face)
  531. {
  532. _encoderStateManager.UpdateCullMode(enable, face);
  533. }
  534. public void SetFrontFace(FrontFace frontFace)
  535. {
  536. _encoderStateManager.UpdateFrontFace(frontFace);
  537. }
  538. public void SetIndexBuffer(BufferRange buffer, IndexType type)
  539. {
  540. _encoderStateManager.UpdateIndexBuffer(buffer, type);
  541. }
  542. public void SetImage(ShaderStage stage, int binding, ITexture image)
  543. {
  544. if (image is TextureBase img)
  545. {
  546. _encoderStateManager.UpdateImage(stage, binding, img);
  547. }
  548. }
  549. public void SetImageArray(ShaderStage stage, int binding, IImageArray array)
  550. {
  551. if (array is ImageArray imageArray)
  552. {
  553. _encoderStateManager.UpdateImageArray(stage, binding, imageArray);
  554. }
  555. }
  556. public void SetImageArraySeparate(ShaderStage stage, int setIndex, IImageArray array)
  557. {
  558. if (array is ImageArray imageArray)
  559. {
  560. _encoderStateManager.UpdateImageArraySeparate(stage, setIndex, imageArray);
  561. }
  562. }
  563. public void SetLineParameters(float width, bool smooth)
  564. {
  565. // Metal does not support wide-lines.
  566. }
  567. public void SetLogicOpState(bool enable, LogicalOp op)
  568. {
  569. _encoderStateManager.UpdateLogicOpState(enable, op);
  570. }
  571. public void SetMultisampleState(MultisampleDescriptor multisample)
  572. {
  573. _encoderStateManager.UpdateMultisampleState(multisample);
  574. }
  575. public void SetPatchParameters(int vertices, ReadOnlySpan<float> defaultOuterLevel, ReadOnlySpan<float> defaultInnerLevel)
  576. {
  577. Logger.Warning?.Print(LogClass.Gpu, "Not Implemented!");
  578. }
  579. public void SetPointParameters(float size, bool isProgramPointSize, bool enablePointSprite, Origin origin)
  580. {
  581. Logger.Warning?.Print(LogClass.Gpu, "Not Implemented!");
  582. }
  583. public void SetPolygonMode(PolygonMode frontMode, PolygonMode backMode)
  584. {
  585. // Metal does not support polygon mode.
  586. }
  587. public void SetPrimitiveRestart(bool enable, int index)
  588. {
  589. // Always active for LineStrip and TriangleStrip
  590. // https://github.com/gpuweb/gpuweb/issues/1220#issuecomment-732483263
  591. // https://developer.apple.com/documentation/metal/mtlrendercommandencoder/1515520-drawindexedprimitives
  592. // https://stackoverflow.com/questions/70813665/how-to-render-multiple-trianglestrips-using-metal
  593. // Emulating disabling this is very difficult. It's unlikely for an index buffer to use the largest possible index,
  594. // so it's fine nearly all of the time.
  595. }
  596. public void SetPrimitiveTopology(PrimitiveTopology topology)
  597. {
  598. _encoderStateManager.UpdatePrimitiveTopology(topology);
  599. }
  600. public void SetProgram(IProgram program)
  601. {
  602. _encoderStateManager.UpdateProgram(program);
  603. }
  604. public void SetRasterizerDiscard(bool discard)
  605. {
  606. _encoderStateManager.UpdateRasterizerDiscard(discard);
  607. }
  608. public void SetRenderTargetColorMasks(ReadOnlySpan<uint> componentMask)
  609. {
  610. _encoderStateManager.UpdateRenderTargetColorMasks(componentMask);
  611. }
  612. public void SetRenderTargets(ITexture[] colors, ITexture depthStencil)
  613. {
  614. _encoderStateManager.UpdateRenderTargets(colors, depthStencil);
  615. }
  616. public void SetScissors(ReadOnlySpan<Rectangle<int>> regions)
  617. {
  618. _encoderStateManager.UpdateScissors(regions);
  619. }
  620. public void SetStencilTest(StencilTestDescriptor stencilTest)
  621. {
  622. _encoderStateManager.UpdateStencilState(stencilTest);
  623. }
  624. public void SetUniformBuffers(ReadOnlySpan<BufferAssignment> buffers)
  625. {
  626. _encoderStateManager.UpdateUniformBuffers(buffers);
  627. }
  628. public void SetStorageBuffers(ReadOnlySpan<BufferAssignment> buffers)
  629. {
  630. _encoderStateManager.UpdateStorageBuffers(buffers);
  631. }
  632. internal void SetStorageBuffers(int first, ReadOnlySpan<Auto<DisposableBuffer>> buffers)
  633. {
  634. _encoderStateManager.UpdateStorageBuffers(first, buffers);
  635. }
  636. public void SetTextureAndSampler(ShaderStage stage, int binding, ITexture texture, ISampler sampler)
  637. {
  638. if (texture is TextureBase tex)
  639. {
  640. if (sampler == null || sampler is SamplerHolder)
  641. {
  642. _encoderStateManager.UpdateTextureAndSampler(stage, binding, tex, (SamplerHolder)sampler);
  643. }
  644. }
  645. }
  646. public void SetTextureArray(ShaderStage stage, int binding, ITextureArray array)
  647. {
  648. if (array is TextureArray textureArray)
  649. {
  650. _encoderStateManager.UpdateTextureArray(stage, binding, textureArray);
  651. }
  652. }
  653. public void SetTextureArraySeparate(ShaderStage stage, int setIndex, ITextureArray array)
  654. {
  655. if (array is TextureArray textureArray)
  656. {
  657. _encoderStateManager.UpdateTextureArraySeparate(stage, setIndex, textureArray);
  658. }
  659. }
  660. public void SetUserClipDistance(int index, bool enableClip)
  661. {
  662. // TODO. Same as Vulkan
  663. }
  664. public void SetVertexAttribs(ReadOnlySpan<VertexAttribDescriptor> vertexAttribs)
  665. {
  666. _encoderStateManager.UpdateVertexAttribs(vertexAttribs);
  667. }
  668. public void SetVertexBuffers(ReadOnlySpan<VertexBufferDescriptor> vertexBuffers)
  669. {
  670. _encoderStateManager.UpdateVertexBuffers(vertexBuffers);
  671. }
  672. public void SetViewports(ReadOnlySpan<Viewport> viewports)
  673. {
  674. _encoderStateManager.UpdateViewports(viewports);
  675. }
  676. public void TextureBarrier()
  677. {
  678. if (CurrentEncoderType == EncoderType.Render)
  679. {
  680. Encoders.RenderEncoder.MemoryBarrier(MTLBarrierScope.Textures, MTLRenderStages.RenderStageFragment, MTLRenderStages.RenderStageFragment);
  681. }
  682. }
  683. public void TextureBarrierTiled()
  684. {
  685. TextureBarrier();
  686. }
  687. public bool TryHostConditionalRendering(ICounterEvent value, ulong compare, bool isEqual)
  688. {
  689. // TODO: Implementable via indirect draw commands
  690. return false;
  691. }
  692. public bool TryHostConditionalRendering(ICounterEvent value, ICounterEvent compare, bool isEqual)
  693. {
  694. // TODO: Implementable via indirect draw commands
  695. return false;
  696. }
  697. public void EndHostConditionalRendering()
  698. {
  699. // TODO: Implementable via indirect draw commands
  700. }
  701. public void BeginTransformFeedback(PrimitiveTopology topology)
  702. {
  703. // Metal does not support transform feedback.
  704. }
  705. public void EndTransformFeedback()
  706. {
  707. // Metal does not support transform feedback.
  708. }
  709. public void SetTransformFeedbackBuffers(ReadOnlySpan<BufferRange> buffers)
  710. {
  711. // Metal does not support transform feedback.
  712. }
  713. public void Dispose()
  714. {
  715. EndCurrentPass();
  716. _encoderStateManager.Dispose();
  717. }
  718. }
  719. }