Dali 3D User Interface Engine
List of all members | Public Member Functions | Static Public Member Functions
Dali::Sampler Class Reference

Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures. More...

#include <sampler.h>

Inheritance diagram for Dali::Sampler:
Inheritance graph
[legend]
Collaboration diagram for Dali::Sampler:
Collaboration graph
[legend]

Public Member Functions

 Sampler ()
 Default constructor, creates an empty handle. More...
 
 ~Sampler ()
 Destructor. More...
 
 Sampler (const Sampler &handle)
 Copy constructor, creates a new handle to the same object. More...
 
Sampleroperator= (const Sampler &handle)
 Assignment operator, changes this handle to point at the same object. More...
 
void SetFilterMode (FilterMode::Type minFilter, FilterMode::Type magFilter)
 Set the filter modes for this sampler. More...
 
void SetWrapMode (WrapMode::Type uWrap, WrapMode::Type vWrap)
 Set the wrap modes for this sampler. More...
 
DALI_INTERNAL Sampler (Internal::Sampler *pointer)
 The constructor. More...
 
- Public Member Functions inherited from Dali::BaseHandle
 BaseHandle (Dali::BaseObject *handle)
 This constructor is used by Dali New() methods. More...
 
 BaseHandle ()
 This constructor provides an uninitialized Dali::BaseHandle. More...
 
 ~BaseHandle ()
 Dali::BaseHandle is intended as a base class. More...
 
 BaseHandle (const BaseHandle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
BaseHandleoperator= (const BaseHandle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
BaseObjectGetBaseObject ()
 Retrieve the internal Dali resource. More...
 
const BaseObjectGetBaseObject () const
 Retrieve the internal Dali resource. More...
 
void Reset ()
 Resets the handle. More...
 
 operator BooleanType () const
 Converts an handle to a BooleanType. More...
 
bool operator== (const BaseHandle &rhs) const
 Equality operator overload. More...
 
bool operator!= (const BaseHandle &rhs) const
 Inequality operator overload. More...
 
Dali::RefObjectGetObjectPtr () const
 Get the reference counted object pointer. More...
 

Static Public Member Functions

static Sampler New ()
 Creates a new Sampler object. More...
 
static Sampler DownCast (BaseHandle handle)
 Downcast to a sampler handle. More...
 

Additional Inherited Members

- Public Types inherited from Dali::BaseHandle
typedef void(BaseHandle::* BooleanType )() const
 Pointer-to-member type. More...
 
- Protected Member Functions inherited from Dali::BaseHandle
void ThisIsSaferThanReturningVoidStar () const
 Used by the safe bool idiom. More...
 

Detailed Description

Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures.

Definition at line 36 of file sampler.h.

Constructor & Destructor Documentation

Dali::Sampler::Sampler ( )

Default constructor, creates an empty handle.

Definition at line 33 of file sampler.cpp.

Referenced by DownCast(), and New().

Here is the caller graph for this function:

Dali::Sampler::~Sampler ( )

Destructor.

Definition at line 37 of file sampler.cpp.

Dali::Sampler::Sampler ( const Sampler handle)

Copy constructor, creates a new handle to the same object.

Parameters
[in]handleHandle to an object

Definition at line 41 of file sampler.cpp.

Dali::Sampler::Sampler ( Internal::Sampler pointer)
explicit

The constructor.

Parameters
[in]pointerA pointer to a newly allocated Sampler

Definition at line 68 of file sampler.cpp.

Member Function Documentation

Sampler Dali::Sampler::DownCast ( BaseHandle  handle)
static

Downcast to a sampler handle.

If not the returned handle is left uninitialized.

Parameters
[in]handleto An object
Returns
handle or an uninitialized handle

Definition at line 46 of file sampler.cpp.

References Dali::BaseHandle::GetObjectPtr(), and Sampler().

Referenced by UtcDaliSamplerDownCast01(), and UtcDaliSamplerDownCast02().

Here is the call graph for this function:

Here is the caller graph for this function:

Sampler Dali::Sampler::New ( )
static

Creates a new Sampler object.

Parameters
[in]imageImage used by this sampler
[in]uniformNameString with the name of the uniform

Definition at line 27 of file sampler.cpp.

References Dali::IntrusivePtr< T >::Get(), Dali::Internal::Sampler::New(), and Sampler().

Referenced by Dali::Toolkit::Internal::GradientRenderer::InitializeRenderer(), UtcDaliMaterialAddTexture02(), UtcDaliMaterialRemoveTexture(), UtcDaliMaterialSetSampler(), UtcDaliSamplerAssignmentOperator(), UtcDaliSamplerCopyConstructor(), UtcDaliSamplerDownCast01(), UtcDaliSamplerNew01(), UtcSamplerSetFilterMode(), and UtcSamplerSetWrapMode().

Here is the call graph for this function:

Here is the caller graph for this function:

Sampler & Dali::Sampler::operator= ( const Sampler handle)

Assignment operator, changes this handle to point at the same object.

Parameters
[in]handleHandle to an object
Returns
Reference to the assigned object

Definition at line 51 of file sampler.cpp.

References Dali::BaseHandle::operator=().

Here is the call graph for this function:

void Dali::Sampler::SetFilterMode ( FilterMode::Type  minFilter,
FilterMode::Type  magFilter 
)

Set the filter modes for this sampler.

Calling this function sets the properties MINIFICATION_FILTER and MAGNIFICATION_FILTER

Parameters
[in]minFilterThe minification filter that will be used
[in]magFilterThe magnification filter that will be used

Definition at line 58 of file sampler.cpp.

References Dali::GetImplementation().

Referenced by Dali::Internal::ImageActor::SetFilterMode(), Dali::Internal::ImageActor::SetImage(), UtcDaliMaterialAddTexture02(), UtcDaliMaterialSetSampler(), and UtcSamplerSetFilterMode().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Sampler::SetWrapMode ( WrapMode::Type  uWrap,
WrapMode::Type  vWrap 
)

Set the wrap modes for this sampler.

Calling this function sets the properties U_WRAP and V_WRAP

param[in] uWrap Wrap mode for u coordinates param[in] vWrap Wrap mode for v coordinates

Definition at line 63 of file sampler.cpp.

References Dali::GetImplementation().

Referenced by Dali::Toolkit::Internal::GradientRenderer::InitializeRenderer(), and UtcSamplerSetWrapMode().

Here is the call graph for this function:

Here is the caller graph for this function:


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali