impeller::DeviceBufferGLES Class Reference

#include <device_buffer_gles.h>

Inheritance diagram for impeller::DeviceBufferGLES:

Public Types
enum class	BindingType { kArrayBuffer , kElementArrayBuffer }

Public Member Functions
	DeviceBufferGLES (DeviceBufferDescriptor desc, ReactorGLES::Ref reactor, std::shared_ptr< Allocation > backing_store)
	~DeviceBufferGLES () override
const uint8_t *	GetBufferData () const
void	UpdateBufferData (const std::function< void(uint8_t *, size_t length)> &update_buffer_data)
bool	BindAndUploadDataIfNecessary (BindingType type) const
void	Flush (std::optional< Range > range=std::nullopt) const override
Public Member Functions inherited from impeller::DeviceBuffer
virtual	~DeviceBuffer ()
bool	CopyHostBuffer (const uint8_t *source, Range source_range, size_t offset=0u)
virtual std::shared_ptr< Texture >	AsTexture (Allocator &allocator, const TextureDescriptor &descriptor, uint16_t row_bytes) const
const DeviceBufferDescriptor &	GetDeviceBufferDescriptor () const
virtual void	Invalidate (std::optional< Range > range=std::nullopt) const

Private Member Functions
uint8_t *	OnGetContents () const override
bool	OnCopyHostBuffer (const uint8_t *source, Range source_range, size_t offset) override
bool	SetLabel (const std::string &label) override
bool	SetLabel (const std::string &label, Range range) override

Additional Inherited Members
Static Public Member Functions inherited from impeller::DeviceBuffer
static BufferView	AsBufferView (std::shared_ptr< DeviceBuffer > buffer)
	Create a buffer view of this entire buffer.
Static Public Member Functions inherited from impeller::BackendCast< DeviceBufferGLES, DeviceBuffer >
static DeviceBufferGLES &	Cast (DeviceBuffer &base)
static const DeviceBufferGLES &	Cast (const DeviceBuffer &base)
static DeviceBufferGLES *	Cast (DeviceBuffer *base)
static const DeviceBufferGLES *	Cast (const DeviceBuffer *base)
Protected Member Functions inherited from impeller::DeviceBuffer
	DeviceBuffer (DeviceBufferDescriptor desc)
Protected Attributes inherited from impeller::DeviceBuffer
const DeviceBufferDescriptor	desc_

Detailed Description

Definition at line 18 of file device_buffer_gles.h.

Member Enumeration Documentation

BindingType

enum class impeller::DeviceBufferGLES::BindingType

strong

Enumerator
kArrayBuffer
kElementArrayBuffer

Definition at line 34 of file device_buffer_gles.h.

                         {
    kArrayBuffer,
    kElementArrayBuffer,
  };

Constructor & Destructor Documentation

DeviceBufferGLES()

impeller::DeviceBufferGLES::DeviceBufferGLES	(	DeviceBufferDescriptor	desc,
		ReactorGLES::Ref	reactor,
		std::shared_ptr< Allocation >	backing_store
	)

Definition at line 17 of file device_buffer_gles.cc.

    : DeviceBuffer(desc),
      reactor_(std::move(reactor)),
      handle_(reactor_ ? reactor_->CreateHandle(HandleType::kBuffer)
                       : HandleGLES::DeadHandle()),
      backing_store_(std::move(backing_store)) {}

~DeviceBufferGLES()

impeller::DeviceBufferGLES::~DeviceBufferGLES ( )

override

Definition at line 27 of file device_buffer_gles.cc.

                                    {
  if (!handle_.IsDead()) {
    reactor_->CollectHandle(handle_);
  }
}

Member Function Documentation

BindAndUploadDataIfNecessary()

bool impeller::DeviceBufferGLES::BindAndUploadDataIfNecessary

(

BindingType

type

)

const

Definition at line 74 of file device_buffer_gles.cc.

                                                                          {
  if (!reactor_) {
    return false;
  }
 
  auto buffer = reactor_->GetGLHandle(handle_);
  if (!buffer.has_value()) {
    return false;
  }
 
  const auto target_type = ToTarget(type);
  const auto& gl = reactor_->GetProcTable();
 
  gl.BindBuffer(target_type, buffer.value());
 
  if (upload_generation_ != generation_) {
    TRACE_EVENT1("impeller", "BufferData", "Bytes",
                 std::to_string(backing_store_->GetLength()).c_str());
    gl.BufferData(target_type, backing_store_->GetLength(),
                  backing_store_->GetBuffer(), GL_STATIC_DRAW);
    upload_generation_ = generation_;
  }
 
  return true;
}

Flush()

void impeller::DeviceBufferGLES::Flush ( std::optional< Range >  range = std::nullopt ) const

overridevirtual

Make any pending writes visible to the GPU.

This method must be called if the device pointer provided by [OnGetContents] is written to without using [CopyHostBuffer]. On Devices with coherent host memory, this method will not perform extra work.

If the range is not provided, the entire buffer is flushed.

Reimplemented from impeller::DeviceBuffer.

Definition at line 60 of file device_buffer_gles.cc.

                                                           {
  generation_++;
}

GetBufferData()

const uint8_t * impeller::DeviceBufferGLES::GetBufferData

(

)

const

Definition at line 113 of file device_buffer_gles.cc.

                                                     {
  return backing_store_->GetBuffer();
}

OnCopyHostBuffer()

bool impeller::DeviceBufferGLES::OnCopyHostBuffer ( const uint8_t *  source, Range  source_range, size_t  offset  )

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 42 of file device_buffer_gles.cc.

                                                       {
  if (!reactor_) {
    return false;
  }
 
  if (offset + source_range.length > backing_store_->GetLength()) {
    return false;
  }
 
  std::memmove(backing_store_->GetBuffer() + offset,
               source + source_range.offset, source_range.length);
  ++generation_;
 
  return true;
}

OnGetContents()

uint8_t * impeller::DeviceBufferGLES::OnGetContents ( ) const

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 34 of file device_buffer_gles.cc.

                                               {
  if (!reactor_) {
    return nullptr;
  }
  return backing_store_->GetBuffer();
}

SetLabel() [1/2]

bool impeller::DeviceBufferGLES::SetLabel ( const std::string &  label )

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 101 of file device_buffer_gles.cc.

                                                      {
  reactor_->SetDebugLabel(handle_, label);
  return true;
}

SetLabel() [2/2]

bool impeller::DeviceBufferGLES::SetLabel ( const std::string &  label, Range  range  )

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 107 of file device_buffer_gles.cc.

                                                                   {
  // Cannot support debug label on the range. Set the label for the entire
  // range.
  return SetLabel(label);
}

UpdateBufferData()

void impeller::DeviceBufferGLES::UpdateBufferData

(

const std::function< void(uint8_t *, size_t length)> &

update_buffer_data

)

Definition at line 117 of file device_buffer_gles.cc.

                            {
  if (update_buffer_data) {
    update_buffer_data(backing_store_->GetBuffer(),
                       backing_store_->GetLength());
    ++generation_;
  }
}

---

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

• impeller/renderer/backend/gles/device_buffer_gles.h
• impeller/renderer/backend/gles/device_buffer_gles.cc