formats_mtl.mm

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#include "impeller/renderer/backend/metal/formats_mtl.h"
#include <Metal/Metal.h>
 
#include <memory>
 
#include "impeller/renderer/render_pass.h"
 
namespace impeller {
 
MTLRenderPipelineColorAttachmentDescriptor*
ToMTLRenderPipelineColorAttachmentDescriptor(
    ColorAttachmentDescriptor descriptor) {
  auto des = [[MTLRenderPipelineColorAttachmentDescriptor alloc] init];
  des.pixelFormat = ToMTLPixelFormat(descriptor.format);
 
  des.blendingEnabled = descriptor.blending_enabled;
 
  des.sourceRGBBlendFactor =
      ToMTLBlendFactor(descriptor.src_color_blend_factor);
  des.rgbBlendOperation = ToMTLBlendOperation(descriptor.color_blend_op);
  des.destinationRGBBlendFactor =
      ToMTLBlendFactor(descriptor.dst_color_blend_factor);
 
  des.sourceAlphaBlendFactor =
      ToMTLBlendFactor(descriptor.src_alpha_blend_factor);
  des.alphaBlendOperation = ToMTLBlendOperation(descriptor.alpha_blend_op);
  des.destinationAlphaBlendFactor =
      ToMTLBlendFactor(descriptor.dst_alpha_blend_factor);
 
  des.writeMask = ToMTLColorWriteMask(descriptor.write_mask);
  return des;
}
 
MTLStencilDescriptor* ToMTLStencilDescriptor(
    const StencilAttachmentDescriptor& descriptor) {
  auto des = [[MTLStencilDescriptor alloc] init];
  des.stencilCompareFunction = ToMTLCompareFunction(descriptor.stencil_compare);
  des.stencilFailureOperation =
      ToMTLStencilOperation(descriptor.stencil_failure);
  des.depthFailureOperation = ToMTLStencilOperation(descriptor.depth_failure);
  des.depthStencilPassOperation =
      ToMTLStencilOperation(descriptor.depth_stencil_pass);
 
  des.readMask = descriptor.read_mask;
  des.writeMask = descriptor.write_mask;
 
  return des;
}
 
MTLDepthStencilDescriptor* ToMTLDepthStencilDescriptor(
    std::optional<DepthAttachmentDescriptor> depth,
    std::optional<StencilAttachmentDescriptor> front,
    std::optional<StencilAttachmentDescriptor> back) {
  if (!depth) {
    depth = DepthAttachmentDescriptor{
        // Always pass the depth test.
        .depth_compare = CompareFunction::kAlways,
        .depth_write_enabled = false,
    };
  }
 
  auto des = [[MTLDepthStencilDescriptor alloc] init];
 
  // These temporary variables are necessary for clang-tidy (Fuchsia LLVM
  // version 17.0.0git) to not crash.
  auto compare_function = ToMTLCompareFunction(depth->depth_compare);
  auto depth_write_enabled = depth->depth_write_enabled;
 
  des.depthCompareFunction = compare_function;
  des.depthWriteEnabled = depth_write_enabled;
 
  if (front.has_value()) {
    des.frontFaceStencil = ToMTLStencilDescriptor(front.value());
  }
  if (back.has_value()) {
    des.backFaceStencil = ToMTLStencilDescriptor(back.value());
  }
 
  return des;
}
 
MTLTextureDescriptor* ToMTLTextureDescriptor(const TextureDescriptor& desc) {
  if (!desc.IsValid()) {
    return nil;
  }
  auto mtl_desc = [[MTLTextureDescriptor alloc] init];
  mtl_desc.textureType = ToMTLTextureType(desc.type);
  mtl_desc.pixelFormat = ToMTLPixelFormat(desc.format);
  mtl_desc.sampleCount = static_cast<NSUInteger>(desc.sample_count);
  mtl_desc.width = desc.size.width;
  mtl_desc.height = desc.size.height;
  mtl_desc.mipmapLevelCount = desc.mip_count;
  mtl_desc.usage = MTLTextureUsageUnknown;
  if (desc.usage & TextureUsage::kUnknown) {
    mtl_desc.usage |= MTLTextureUsageUnknown;
  }
  if (desc.usage & TextureUsage::kShaderRead) {
    mtl_desc.usage |= MTLTextureUsageShaderRead;
  }
  if (desc.usage & TextureUsage::kShaderWrite) {
    mtl_desc.usage |= MTLTextureUsageShaderWrite;
  }
  if (desc.usage & TextureUsage::kRenderTarget) {
    mtl_desc.usage |= MTLTextureUsageRenderTarget;
  }
  return mtl_desc;
}
 
MTLPixelFormat SafeMTLPixelFormatDepth24Unorm_Stencil8() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatDepth24Unorm_Stencil8;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatBGR10_XR_sRGB() {
  if (@available(iOS 11, macOS 11.0, *)) {
    return MTLPixelFormatBGR10_XR_sRGB;
  } else {
    return MTLPixelFormatInvalid;
  }
}
 
MTLPixelFormat SafeMTLPixelFormatBGR10_XR() {
  if (@available(iOS 10, macOS 11.0, *)) {
    return MTLPixelFormatBGR10_XR;
  } else {
    return MTLPixelFormatInvalid;
  }
}
 
MTLPixelFormat SafeMTLPixelFormatBGRA10_XR() {
  if (@available(iOS 10, macOS 11.0, *)) {
    return MTLPixelFormatBGRA10_XR;
  } else {
    return MTLPixelFormatInvalid;
  }
}
 
// BC formats are only available on macOS; referencing the enum values when
// compiling for iOS is a hard error, so they are guarded at compile time.
MTLPixelFormat SafeMTLPixelFormatBC1_RGBA() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatBC1_RGBA;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatBC1_RGBA_sRGB() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatBC1_RGBA_sRGB;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatBC3_RGBA() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatBC3_RGBA;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatBC3_RGBA_sRGB() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatBC3_RGBA_sRGB;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatBC5_RGUnorm() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatBC5_RGUnorm;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatBC7_RGBAUnorm() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatBC7_RGBAUnorm;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatBC7_RGBAUnorm_sRGB() {
#if !FML_OS_IOS
  if (@available(macOS 10.11, *)) {
    return MTLPixelFormatBC7_RGBAUnorm_sRGB;
  }
#endif  // FML_OS_IOS
  return MTLPixelFormatInvalid;
}
 
// ETC2 and ASTC are available on iOS and on macOS 11.0+. The macOS deployment
// target is below 11.0, so the references are version-guarded.
MTLPixelFormat SafeMTLPixelFormatETC2_RGB8() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatETC2_RGB8;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatETC2_RGB8_sRGB() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatETC2_RGB8_sRGB;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatEAC_RGBA8() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatEAC_RGBA8;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatEAC_RGBA8_sRGB() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatEAC_RGBA8_sRGB;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatASTC_4x4_LDR() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatASTC_4x4_LDR;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatASTC_4x4_sRGB() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatASTC_4x4_sRGB;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatASTC_8x8_LDR() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatASTC_8x8_LDR;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatASTC_8x8_sRGB() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatASTC_8x8_sRGB;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatASTC_4x4_HDR() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatASTC_4x4_HDR;
  }
  return MTLPixelFormatInvalid;
}
 
MTLPixelFormat SafeMTLPixelFormatASTC_8x8_HDR() {
  if (@available(macOS 11.0, *)) {
    return MTLPixelFormatASTC_8x8_HDR;
  }
  return MTLPixelFormatInvalid;
}
 
}  // namespace impeller