Celeritas 0.6.0-dev.115+3b60a5fd
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::Image< M > Class Template Referencefinal

Implement an image on host or device. More...

#include <Image.hh>

Inheritance diagram for celeritas::Image< M >:
Inheritance graph
[legend]

Public Types

Type aliases
using Value = ImageStateData< Ownership::value, M >
 
using Ref = ImageStateData< Ownership::reference, M >
 
- Public Types inherited from celeritas::ImageInterface
using int_type = int
 
using SpanInt = Span< int_type >
 
using SPConstParams = std::shared_ptr< ImageParams const >
 

Public Member Functions

 Image (SPConstParams params)
 Construct from parameters.
 
SPConstParams constparams () const final
 Access image properties.
 
void copy_to_host (SpanInt) const final
 Copy the image back to the host.
 
Ref constref ()
 Access the mutable state data.
 
- Public Member Functions inherited from celeritas::ImageInterface
virtual ~ImageInterface ()=default
 Default virtual destructor.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::ImageInterface
 CELER_DEFAULT_COPY_MOVE (ImageInterface)
 

Detailed Description

template<MemSpace M>
class celeritas::Image< M >

Implement an image on host or device.

Member Function Documentation

◆ copy_to_host()

template<MemSpace M>
void celeritas::Image< M >::copy_to_host ( SpanInt  out) const
finalvirtual

Copy the image back to the host.

Implements celeritas::ImageInterface.

◆ params()

template<MemSpace M>
SPConstParams const & celeritas::Image< M >::params ( ) const
inlinefinalvirtual

Access image properties.

Implements celeritas::ImageInterface.


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