Coal::Image3D Class Reference

3D image More...

#include <memobject.h>

Inheritance diagram for Coal::Image3D:

Collaboration diagram for Coal::Image3D:

List of all members.

Public Member Functions
	Image3D (Context *ctx, size_t width, size_t height, size_t depth, size_t row_pitch, size_t slice_pitch, const cl_image_format *format, void *host_ptr, cl_mem_flags flags, cl_int *errcode_ret)
	Constructor.
size_t	size () const
	Size in bytes of this image.
Type	type () const
	Return that we are a Coal::MemObject::Image3D.
size_t	depth () const
	Depth of the image.
size_t	slice_pitch () const
	Size in bytes of a 2D slice.
Private Attributes
size_t	p_depth
size_t	p_slice_pitch

---

Detailed Description

3D image

Definition at line 248 of file memobject.h.

---

Constructor & Destructor Documentation

Image3D::Image3D	(	Context *	ctx,
		size_t	width,
		size_t	height,
		size_t	depth,
		size_t	row_pitch,
		size_t	slice_pitch,
		const cl_image_format *	format,
		void *	host_ptr,
		cl_mem_flags	flags,
		cl_int *	errcode_ret
	)

Constructor.

Parameters:

ctx	parent Coal::Context
width	width of the image
height	height of the image
depth	depth of the image
row_pitch	number of bytes in a row of pixels. If 0, defaults to width * pixel_size()
slice_pitch	number of bytes in a 2D slice. If 0, defaults to height * row_pitch()
format	image format
host_ptr	host pointer
flags	memory flags
errcode_ret	return code

Definition at line 783 of file memobject.cpp.

References p_slice_pitch, Coal::Image2D::row_pitch(), and slice_pitch().

Referenced by type().

---

Member Function Documentation

size_t Image3D::depth

(

)

const

Depth of the image.

Definition at line 832 of file memobject.cpp.

References p_depth.

Referenced by get_image_depth(), Coal::Image2D::imageInfo(), Coal::KernelEvent::KernelEvent(), Coal::CPUKernelWorkGroup::readImageImplF(), and size().

size_t Image3D::size

(

)

const [virtual]

Size in bytes of this image.

Reimplemented from Coal::Image2D.

Definition at line 822 of file memobject.cpp.

References depth(), and slice_pitch().

size_t Image3D::slice_pitch

(

)

const [virtual]

Size in bytes of a 2D slice.

Reimplemented from Coal::Image2D.

Definition at line 837 of file memobject.cpp.

References p_slice_pitch.

Referenced by Image3D(), Coal::Image2D::imageInfo(), and size().

MemObject::Type Image3D::type

(

)

const [virtual]

Return that we are a Coal::MemObject::Image3D.

Reimplemented from Coal::Image2D.

Definition at line 827 of file memobject.cpp.

References Image3D().

Referenced by get_image_depth(), and is_image_3d().

---

Member Data Documentation

size_t Coal::Image3D::p_depth [private]

Definition at line 276 of file memobject.h.

Referenced by depth().

size_t Coal::Image3D::p_slice_pitch [private]

Definition at line 276 of file memobject.h.

Referenced by Image3D(), and slice_pitch().

---

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

• memobject.h
• memobject.cpp