Blender  V3.3
Public Types | Public Member Functions | Friends | List of all members
blender::compositor::BufferRange< T > Class Template Reference

#include <COM_BufferRange.h>

Public Types

using Iterator = BufferRangeIterator< T >
 
using ConstIterator = BufferRangeIterator< const T >
 

Public Member Functions

constexpr BufferRange ()=default
 
constexpr BufferRange (T *buffer, int64_t start_elem_index, int64_t size, int elem_stride=1)
 
constexpr Toperator[] (int64_t index) const
 
constexpr int64_t size () const
 
constexpr Iterator begin ()
 
constexpr Iterator end ()
 
constexpr ConstIterator begin () const
 
constexpr ConstIterator end () const
 

Friends

constexpr friend bool operator== (const BufferRange &a, const BufferRange &b)
 

Detailed Description

template<typename T>
class blender::compositor::BufferRange< T >

A range of buffer elements.

Definition at line 18 of file COM_BufferRange.h.

Member Typedef Documentation

◆ ConstIterator

template<typename T >
using blender::compositor::BufferRange< T >::ConstIterator = BufferRangeIterator<const T>

Definition at line 21 of file COM_BufferRange.h.

◆ Iterator

template<typename T >
using blender::compositor::BufferRange< T >::Iterator = BufferRangeIterator<T>

Definition at line 20 of file COM_BufferRange.h.

Constructor & Destructor Documentation

◆ BufferRange() [1/2]

template<typename T >
constexpr blender::compositor::BufferRange< T >::BufferRange ( )
constexprdefault

◆ BufferRange() [2/2]

template<typename T >
constexpr blender::compositor::BufferRange< T >::BufferRange ( T buffer,
int64_t  start_elem_index,
int64_t  size,
int  elem_stride = 1 
)
inlineconstexpr

Create a buffer range of elements from a given element index.

Definition at line 36 of file COM_BufferRange.h.

Member Function Documentation

◆ begin() [1/2]

template<typename T >
constexpr Iterator blender::compositor::BufferRange< T >::begin ( )
inlineconstexpr

Definition at line 64 of file COM_BufferRange.h.

◆ begin() [2/2]

template<typename T >
constexpr ConstIterator blender::compositor::BufferRange< T >::begin ( ) const
inlineconstexpr

Definition at line 74 of file COM_BufferRange.h.

◆ end() [1/2]

template<typename T >
constexpr Iterator blender::compositor::BufferRange< T >::end ( )
inlineconstexpr

Definition at line 69 of file COM_BufferRange.h.

◆ end() [2/2]

template<typename T >
constexpr ConstIterator blender::compositor::BufferRange< T >::end ( ) const
inlineconstexpr

Definition at line 79 of file COM_BufferRange.h.

◆ operator[]()

template<typename T >
constexpr T* blender::compositor::BufferRange< T >::operator[] ( int64_t  index) const
inlineconstexpr

Access an element in the range. Index is relative to range start.

Definition at line 49 of file COM_BufferRange.h.

References BLI_assert, and blender::compositor::BufferRange< T >::size().

◆ size()

template<typename T >
constexpr int64_t blender::compositor::BufferRange< T >::size ( ) const
inlineconstexpr

Get the number of elements in the range.

Definition at line 59 of file COM_BufferRange.h.

Referenced by blender::compositor::BufferRange< T >::operator[](), and blender::compositor::tests::TEST().

Friends And Related Function Documentation

◆ operator==

template<typename T >
constexpr friend bool operator== ( const BufferRange< T > &  a,
const BufferRange< T > &  b 
)
friend

Definition at line 41 of file COM_BufferRange.h.


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