impeller::AiksContext Class Reference

#include <aiks_context.h>

Public Member Functions
	AiksContext (std::shared_ptr< Context > context, std::shared_ptr< TypographerContext > typographer_context, std::optional< std::shared_ptr< RenderTargetAllocator > > render_target_allocator=std::nullopt)
	~AiksContext ()
bool	IsValid () const
std::shared_ptr< Context >	GetContext () const
ContentContext &	GetContentContext () const
bool	Render (const Picture &picture, RenderTarget &render_target, bool reset_host_buffer)

Detailed Description

Definition at line 19 of file aiks_context.h.

Constructor & Destructor Documentation

AiksContext()

impeller::AiksContext::AiksContext	(	std::shared_ptr< Context >	context,
		std::shared_ptr< TypographerContext >	typographer_context,
		std::optional< std::shared_ptr< RenderTargetAllocator > >	render_target_allocator = std::nullopt
	)

Construct a new AiksContext.

Parameters

context	The Impeller context that Aiks should use for allocating resources and executing device commands. Required.
typographer_context	The text backend to use for rendering text. If nullptr is supplied, then attempting to draw text with Aiks will result in validation errors.
render_target_allocator	Injects a render target allocator or allocates its own if none is supplied.

Definition at line 13 of file aiks_context.cc.

    : context_(std::move(context)) {
  if (!context_ || !context_->IsValid()) {
    return;
  }
 
  content_context_ = std::make_unique<ContentContext>(
      context_, std::move(typographer_context),
      render_target_allocator.has_value() ? render_target_allocator.value()
                                          : nullptr);
  if (!content_context_->IsValid()) {
    return;
  }
 
  is_valid_ = true;
}

~AiksContext()

impeller::AiksContext::~AiksContext ( )

default

Member Function Documentation

GetContentContext()

ContentContext & impeller::AiksContext::GetContentContext

(

)

const

Definition at line 44 of file aiks_context.cc.

                                                     {
  return *content_context_;
}

GetContext()

std::shared_ptr< Context > impeller::AiksContext::GetContext

(

)

const

Definition at line 40 of file aiks_context.cc.

                                                     {
  return context_;
}

IsValid()

bool impeller::AiksContext::IsValid

(

)

const

Definition at line 36 of file aiks_context.cc.

                                {
  return is_valid_;
}

Render()

bool impeller::AiksContext::Render	(	const Picture &	picture,
		RenderTarget &	render_target,
		bool	reset_host_buffer
	)

Definition at line 48 of file aiks_context.cc.

                                                 {
  if (!IsValid()) {
    return false;
  }
 
  fml::ScopedCleanupClosure closure([&]() {
    if (reset_host_buffer) {
      content_context_->GetTransientsBuffer().Reset();
    }
  });
  if (picture.pass) {
    return picture.pass->Render(*content_context_, render_target);
  }
 
  return true;
}

---

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

• impeller/aiks/aiks_context.h
• impeller/aiks/aiks_context.cc