Blink::Image Class Reference

Reference to a Blink image. More...

#include <Blink.h>

Inheritance diagram for Blink::Image:

Public Member Functions
	Image ()
	Image ref not pointing to any data.
	Image (const Image &src)
	Copy reference to source image. Both images will point to the same data.
	Image (const ImageInfo &info, ComputeDevice &device)
	Image (const DeviceMemory &memory, const ImageInfo &info, const BufferDesc &desc, ComputeDevice &device)
Image &	operator= (const Image &src)
Image	distributeTo (const ComputeDevice &dev)
	Return a reference to the image with the same data on the specified device performing a copy if necessary. More...
Image	makeLike (const ComputeDevice &dev)
	Return a reference to a new image with the same layout on the specified device. More...
void	copyFrom (const Image &src)
	Copies the data from src on any device into this image. The formats of the images must match.
ImageInfo	info () const
	Fetch info for image.
void	clear ()
	Clear reference to image.
bool	isEmpty () const
	Returns true if there is no underlying data.
void	copyToBuffer (void *buffer, const BufferDesc &bufferDesc) const
	Copy the contents of the image to the provided buffer.
void	copyFromBuffer (const void *buffer, const BufferDesc &bufferDesc) const
	Copy provided buffer to the image.
	Image (Ref ref)

Additional Inherited Members
Protected Member Functions inherited from Blink::RefHolder
	RefHolder (Ref ref, bool retain)
	RefHolder (const RefHolder &holder)
RefHolder &	operator= (const RefHolder &holder)
void	take (Ref ref)
RefHolder &	operator= (Ref ref)
Ref	ref () const
Protected Attributes inherited from Blink::RefHolder
Ref	_ref

Detailed Description

Reference to a Blink image.

Member Function Documentation

Image Blink::Image::distributeTo

(

const ComputeDevice &

dev

)

Return a reference to the image with the same data on the specified device performing a copy if necessary.

If the image is already on the specified device then return a reference to the image. Otherwise copy the image to the device and return a reference to the copy.

Image Blink::Image::makeLike

(

const ComputeDevice &

dev

)

Return a reference to a new image with the same layout on the specified device.

An Image returned from this call will be compatible for a copyFrom.

---

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

• Blink.h