peak Namespace Reference

The "peak" namespace directly contains convenience functionality like the DeviceManager as well as the global Library::Initialize() / Library::Close() functions, which must be called before/after usage of the library. More...

Namespaces
namespace	common
	Root namespace for common types and interfaces shared across multiple libraries.
namespace	core
	The "core" namespace contains the direct GenAPI and GenTL wrapper.
namespace	pipeline
	Interfaces and implementations for defining and controlling data processing pipelines.

Classes
class	DeviceManager
	The global DeviceManager (singleton) searches all installed producer libraries (*.cti) and enumerates the modules contained in them. More...
class	Library
	A collection of global library functions. More...

Functions
template<>
PEAK_COMMON_NO_DISCARD peak::icv::Image	BufferTo< peak::icv::Image > (const std::shared_ptr< peak::core::Buffer > &buffer)
	Converts a core::Buffer into a peak::icv::Image.
template<>
PEAK_COMMON_NO_DISCARD peak::ipl::Image	BufferTo< peak::ipl::Image > (const std::shared_ptr< peak::core::Buffer > &buffer)
	Converts a core::Buffer into a peak::ipl::Image.
template<>
PEAK_COMMON_NO_DISCARD peak::icv::Image	BufferPartTo (const std::shared_ptr< peak::core::BufferPart > &part)
	Converts a core::BufferPart into a peak::ipl::Image.
template<>
PEAK_COMMON_NO_DISCARD peak::ipl::Image	BufferPartTo (const std::shared_ptr< peak::core::BufferPart > &part)
	Converts a core::BufferPart into a peak::ipl::Image.
template<class OutType>
PEAK_COMMON_NO_DISCARD OutType	BufferTo (const std::shared_ptr< peak::core::Buffer > &buffer)
	Converts a core::Buffer into a different type.
template<class OutType>
PEAK_COMMON_NO_DISCARD OutType	BufferPartTo (const std::shared_ptr< peak::core::BufferPart > &bufferPart)
	Converts a core::BufferPart into a different type.

Detailed Description

The "peak" namespace directly contains convenience functionality like the DeviceManager as well as the global Library::Initialize() / Library::Close() functions, which must be called before/after usage of the library.

Function Documentation

BufferPartTo()

template<>

PEAK_COMMON_NO_DISCARD peak::ipl::Image peak::BufferPartTo ( const std::shared_ptr< peak::core::BufferPart > & part )

inline

Converts a core::BufferPart into a peak::ipl::Image.

This creates a peak::ipl::Image as a shallow copy of the buffer (i.e. using the same memory).

Parameters

[in]

part

The buffer part to convert

Returns

The buffer part converted to an Image.

Remarks

Remember that the buffer part's memory is only under your control until you re-queue the buffer.

Since

1.8

Note

To use this method, this file needs to be included explicitly:

#include <peak/converters/peak_bufferpart_converter_ipl.hpp>