blender::compositor::BufferArea< T > Class Template Reference

#include <COM_BufferArea.h>

Inherits rcti.

Public Types
using	Iterator = BufferAreaIterator<T>
using	ConstIterator = BufferAreaIterator<const T>

Public Member Functions
constexpr	BufferArea ()=default
constexpr	BufferArea (T *buffer, int buffer_width, const rcti &area, int elem_stride=1)
constexpr	BufferArea (T *buffer, int buffer_width, int buffer_height, int elem_stride=1)
constexpr const rcti &	get_rect () const
constexpr int	width () const
constexpr int	height () const
constexpr Iterator	begin ()
constexpr Iterator	end ()
constexpr ConstIterator	begin () const
constexpr ConstIterator	end () const

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

Detailed Description

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

A rectangle area of buffer elements.

Definition at line 19 of file COM_BufferArea.h.

Member Typedef Documentation

ConstIterator

template<typename T >

using blender::compositor::BufferArea< T >::ConstIterator = BufferAreaIterator<const T>

Definition at line 22 of file COM_BufferArea.h.

Iterator

template<typename T >

using blender::compositor::BufferArea< T >::Iterator = BufferAreaIterator<T>

Definition at line 21 of file COM_BufferArea.h.

Constructor & Destructor Documentation

BufferArea() [1/3]

template<typename T >

blender::compositor::BufferArea< T >::BufferArea ( )

constexprdefault

BufferArea() [2/3]

template<typename T >

blender::compositor::BufferArea< T >::BufferArea ( T * buffer, int buffer_width, const rcti & area, int elem_stride = 1 )

inlineconstexpr

Create a buffer area containing given rectangle area.

Definition at line 37 of file COM_BufferArea.h.

BufferArea() [3/3]

template<typename T >

blender::compositor::BufferArea< T >::BufferArea ( T * buffer, int buffer_width, int buffer_height, int elem_stride = 1 )

inlineconstexpr

Create a buffer area containing whole buffer with no offsets.

Definition at line 45 of file COM_BufferArea.h.

References BLI_rcti_init().

Member Function Documentation

begin() [1/2]

template<typename T >

Iterator blender::compositor::BufferArea< T >::begin ( )

inlineconstexpr

Definition at line 77 of file COM_BufferArea.h.

begin() [2/2]

template<typename T >

ConstIterator blender::compositor::BufferArea< T >::begin ( ) const

inlineconstexpr

Definition at line 87 of file COM_BufferArea.h.

end() [1/2]

template<typename T >

Iterator blender::compositor::BufferArea< T >::end ( )

inlineconstexpr

Definition at line 82 of file COM_BufferArea.h.

end() [2/2]

template<typename T >

ConstIterator blender::compositor::BufferArea< T >::end ( ) const

inlineconstexpr

Definition at line 92 of file COM_BufferArea.h.

get_rect()

template<typename T >

const rcti & blender::compositor::BufferArea< T >::get_rect ( ) const

inlineconstexpr

Definition at line 56 of file COM_BufferArea.h.

height()

template<typename T >

int blender::compositor::BufferArea< T >::height ( ) const

inlineconstexpr

Number of elements in a column.

Definition at line 72 of file COM_BufferArea.h.

References BLI_rcti_size_y().

width()

template<typename T >

int blender::compositor::BufferArea< T >::width ( ) const

inlineconstexpr

Number of elements in a row.

Definition at line 64 of file COM_BufferArea.h.

References BLI_rcti_size_x().

Friends And Related Symbol Documentation

operator==

template<typename T >

friend bool operator== ( const BufferArea< T > & a, const BufferArea< T > & b )

friend

Definition at line 51 of file COM_BufferArea.h.

---

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

• COM_BufferArea.h