impeller::ShaderLibraryMTL Class Reference

#include <shader_library_mtl.h>

Inheritance diagram for impeller::ShaderLibraryMTL:

Public Member Functions
	ShaderLibraryMTL ()
	~ShaderLibraryMTL () override
bool	IsValid () const override
Public Member Functions inherited from impeller::ShaderLibrary
virtual	~ShaderLibrary ()

Private Member Functions
std::shared_ptr< const ShaderFunction >	GetFunction (std::string_view name, ShaderStage stage) override
void	RegisterFunction (std::string name, ShaderStage stage, std::shared_ptr< fml::Mapping > code, RegistrationCallback callback) override
void	UnregisterFunction (std::string name, ShaderStage stage) override

Friends
class	ContextMTL

Additional Inherited Members
Public Types inherited from impeller::ShaderLibrary
using	RegistrationCallback = std::function< void(bool)>
Protected Member Functions inherited from impeller::ShaderLibrary
	ShaderLibrary ()

Detailed Description

Definition at line 23 of file shader_library_mtl.h.

Constructor & Destructor Documentation

ShaderLibraryMTL()

impeller::ShaderLibraryMTL::ShaderLibraryMTL

(

)

~ShaderLibraryMTL()

impeller::ShaderLibraryMTL::~ShaderLibraryMTL ( )

overridedefault

Member Function Documentation

GetFunction()

std::shared_ptr< const ShaderFunction > impeller::ShaderLibraryMTL::GetFunction ( std::string_view  name, ShaderStage  stage  )

overrideprivatevirtual

Implements impeller::ShaderLibrary.

Definition at line 41 of file shader_library_mtl.mm.

                       {
  if (!IsValid()) {
    return nullptr;
  }
 
  if (name.empty()) {
    VALIDATION_LOG << "Library function name was empty.";
    return nullptr;
  }
 
  ShaderKey key(name, stage);
 
  id<MTLFunction> function = nil;
  id<MTLLibrary> library = nil;
 
  {
    ReaderLock lock(libraries_mutex_);
 
    if (auto found = functions_.find(key); found != functions_.end()) {
      return found->second;
    }
 
    for (size_t i = 0, count = [libraries_ count]; i < count; i++) {
      library = libraries_[i];
      function = [library newFunctionWithName:@(name.data())];
      if (function) {
        break;
      }
    }
 
    if (function == nil) {
      return nullptr;
    }
 
    if (function.functionType != ToMTLFunctionType(stage)) {
      VALIDATION_LOG << "Library function named " << name
                     << " was for an unexpected shader stage.";
      return nullptr;
    }
 
    auto func = std::shared_ptr<ShaderFunctionMTL>(new ShaderFunctionMTL(
        library_id_, function, library, {name.data(), name.size()}, stage));
    functions_[key] = func;
 
    return func;
  }
}

IsValid()

bool impeller::ShaderLibraryMTL::IsValid ( ) const

overridevirtual

Implements impeller::ShaderLibrary.

Definition at line 24 of file shader_library_mtl.mm.

                                     {
  return is_valid_;
}

RegisterFunction()

void impeller::ShaderLibraryMTL::RegisterFunction ( std::string  name, ShaderStage  stage, std::shared_ptr< fml::Mapping >  code, RegistrationCallback  callback  )

overrideprivatevirtual

Reimplemented from impeller::ShaderLibrary.

Definition at line 100 of file shader_library_mtl.mm.

                                                                       {
  if (!callback) {
    callback = [](auto) {};
  }
  auto failure_callback = std::make_shared<fml::ScopedCleanupClosure>(
      [callback]() { callback(false); });
  if (!IsValid()) {
    return;
  }
  if (code == nullptr || code->GetMapping() == nullptr) {
    return;
  }
  auto device = GetDevice();
  if (device == nil) {
    return;
  }
 
  auto source = [[NSString alloc] initWithBytes:code->GetMapping()
                                         length:code->GetSize()
                                       encoding:NSUTF8StringEncoding];
 
  auto weak_this = weak_from_this();
  [device newLibraryWithSource:source
                       options:NULL
             completionHandler:^(id<MTLLibrary> library, NSError* error) {
               auto strong_this = weak_this.lock();
               if (!strong_this) {
                 VALIDATION_LOG << "Shader library was collected before "
                                   "dynamic shader stage could be registered.";
                 return;
               }
               if (!library) {
                 VALIDATION_LOG << "Could not register dynamic stage library: "
                                << error.localizedDescription.UTF8String;
                 return;
               }
               reinterpret_cast<ShaderLibraryMTL*>(strong_this.get())
                   ->RegisterLibrary(library);
               failure_callback->Release();
               callback(true);
             }];
}

UnregisterFunction()

void impeller::ShaderLibraryMTL::UnregisterFunction ( std::string  name, ShaderStage  stage  )

overrideprivatevirtual

Implements impeller::ShaderLibrary.

Definition at line 147 of file shader_library_mtl.mm.

                                                                           {
  ReaderLock lock(libraries_mutex_);
 
  // Find the shader library containing this function name and remove it.
 
  bool found_library = false;
  for (size_t i = [libraries_ count] - 1; i >= 0; i--) {
    id<MTLFunction> function =
        [libraries_[i] newFunctionWithName:@(name.data())];
    if (function) {
      [libraries_ removeObjectAtIndex:i];
      found_library = true;
      break;
    }
  }
  if (!found_library) {
    VALIDATION_LOG << "Library containing function " << name
                   << " was not found, so it couldn't be unregistered.";
  }
 
  // Remove the shader from the function cache.
 
  ShaderKey key(name, stage);
 
  auto found = functions_.find(key);
  if (found == functions_.end()) {
    VALIDATION_LOG << "Library function named " << name
                   << " was not found, so it couldn't be unregistered.";
    return;
  }
 
  functions_.erase(found);
}

Friends And Related Symbol Documentation

ContextMTL

friend class ContextMTL

friend

Definition at line 34 of file shader_library_mtl.h.

---

The documentation for this class was generated from the following files:

• impeller/renderer/backend/metal/shader_library_mtl.h
• impeller/renderer/backend/metal/shader_library_mtl.mm