The ISampler video object interface. More...

#include "murl_video_i_sampler.h"

Inherited by Murl::Video::Vulkan::Sampler.

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Video::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Video::IObject interface. More...
 
virtual Bool SetWrapModeX (IEnums::TextureWrapMode mode)=0
 Set the texture's wrap mode in X direction. More...
 
virtual Bool SetWrapModeY (IEnums::TextureWrapMode mode)=0
 Set the texture's wrap mode in Y direction. More...
 
virtual Bool SetWrapModeZ (IEnums::TextureWrapMode mode)=0
 Set the texture's wrap mode in Z direction. More...
 
virtual IEnums::TextureWrapMode GetWrapModeX () const =0
 Get the texture's wrap mode in X direction. More...
 
virtual IEnums::TextureWrapMode GetWrapModeY () const =0
 Get the texture's wrap mode in Y direction. More...
 
virtual IEnums::TextureWrapMode GetWrapModeZ () const =0
 Get the texture's wrap mode in Z direction. More...
 
virtual Bool SetMagFilter (IEnums::TextureFilter magFilter)=0
 Set the texture filter used for magnification. More...
 
virtual Bool SetMinFilter (IEnums::TextureFilter minFilter, IEnums::TextureFilter mipFilter)=0
 Set the texture filters used for minification and MIP level selection. More...
 
virtual IEnums::TextureFilter GetMagFilter () const =0
 Get the texture filter used for magnification. More...
 
virtual IEnums::TextureFilter GetMinFilter () const =0
 Get the texture filter used for minification. More...
 
virtual IEnums::TextureFilter GetMipFilter () const =0
 Get the texture filter used for mip-level selection. More...
 
virtual Bool SetDepthTestMode (IEnums::DepthTestMode mode)=0
 Set the depth compare mode, if the pixel format defines a depth texture. More...
 
virtual IEnums::DepthTestMode GetDepthTestMode () const =0
 Get the depth compare mode. More...
 
virtual Bool SetDepthTestFunction (IEnums::DepthTestFunction function)=0
 Set the depth test function, if the pixel format defines a depth texture and the depth compare mode is not NONE. More...
 
virtual IEnums::DepthTestFunction GetDepthTestFunction () const =0
 Get the depth test function. More...
 
virtual Bool SetMaxAnisotropy (Real maxAnisotropy)=0
 Set the maximum anisotropy for filtering. More...
 
virtual Real GetMaxAnisotropy () const =0
 Set the maximum anisotropy for filtering. More...
 

Detailed Description

The ISampler video object interface.

This interface represents a GPU Sampler.

Used internally by various geometry texture nodes, such as Graph::FlatTexture, Graph::CubemapTexture, Graph::FrameBufferTexture and others.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Video::ISampler::GetObjectInterface ( )
pure virtual

Get the mutable Video::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Video::ISampler::GetObjectInterface ( ) const
pure virtual

Get the constant Video::IObject interface.

Returns
The IObject interface.

◆ SetWrapModeX()

virtual Bool Murl::Video::ISampler::SetWrapModeX ( IEnums::TextureWrapMode  mode)
pure virtual

Set the texture's wrap mode in X direction.

Parameters
modeThe wrap mode.
Returns
true if successful.

◆ SetWrapModeY()

virtual Bool Murl::Video::ISampler::SetWrapModeY ( IEnums::TextureWrapMode  mode)
pure virtual

Set the texture's wrap mode in Y direction.

Parameters
modeThe wrap mode.
Returns
true if successful.

◆ SetWrapModeZ()

virtual Bool Murl::Video::ISampler::SetWrapModeZ ( IEnums::TextureWrapMode  mode)
pure virtual

Set the texture's wrap mode in Z direction.

Parameters
modeThe wrap mode.
Returns
true if successful.

◆ GetWrapModeX()

virtual IEnums::TextureWrapMode Murl::Video::ISampler::GetWrapModeX ( ) const
pure virtual

Get the texture's wrap mode in X direction.

Returns
The wrap mode.

◆ GetWrapModeY()

virtual IEnums::TextureWrapMode Murl::Video::ISampler::GetWrapModeY ( ) const
pure virtual

Get the texture's wrap mode in Y direction.

Returns
The wrap mode.

◆ GetWrapModeZ()

virtual IEnums::TextureWrapMode Murl::Video::ISampler::GetWrapModeZ ( ) const
pure virtual

Get the texture's wrap mode in Z direction.

Returns
The wrap mode.

◆ SetMagFilter()

virtual Bool Murl::Video::ISampler::SetMagFilter ( IEnums::TextureFilter  magFilter)
pure virtual

Set the texture filter used for magnification.

Parameters
magFilterThe filter to use.
Returns
true if successful.

◆ SetMinFilter()

virtual Bool Murl::Video::ISampler::SetMinFilter ( IEnums::TextureFilter  minFilter,
IEnums::TextureFilter  mipFilter 
)
pure virtual

Set the texture filters used for minification and MIP level selection.

Parameters
minFilterThe minification filter to use.
mipFilterThe MIP level selection filter to use.
Returns
true if successful.

◆ GetMagFilter()

virtual IEnums::TextureFilter Murl::Video::ISampler::GetMagFilter ( ) const
pure virtual

Get the texture filter used for magnification.

Returns
The filter used.

◆ GetMinFilter()

virtual IEnums::TextureFilter Murl::Video::ISampler::GetMinFilter ( ) const
pure virtual

Get the texture filter used for minification.

Returns
The filter used.

◆ GetMipFilter()

virtual IEnums::TextureFilter Murl::Video::ISampler::GetMipFilter ( ) const
pure virtual

Get the texture filter used for mip-level selection.

Returns
The filter used.

◆ SetDepthTestMode()

virtual Bool Murl::Video::ISampler::SetDepthTestMode ( IEnums::DepthTestMode  mode)
pure virtual

Set the depth compare mode, if the pixel format defines a depth texture.

Parameters
modeThe depth compare mode to use.
Returns
true if successful.

◆ GetDepthTestMode()

virtual IEnums::DepthTestMode Murl::Video::ISampler::GetDepthTestMode ( ) const
pure virtual

Get the depth compare mode.

Returns
The depth compare mode used.

◆ SetDepthTestFunction()

virtual Bool Murl::Video::ISampler::SetDepthTestFunction ( IEnums::DepthTestFunction  function)
pure virtual

Set the depth test function, if the pixel format defines a depth texture and the depth compare mode is not NONE.

Parameters
functionThe depth test function to use.
Returns
true if successful.

◆ GetDepthTestFunction()

virtual IEnums::DepthTestFunction Murl::Video::ISampler::GetDepthTestFunction ( ) const
pure virtual

Get the depth test function.

Returns
The depth test function used.

◆ SetMaxAnisotropy()

virtual Bool Murl::Video::ISampler::SetMaxAnisotropy ( Real  maxAnisotropy)
pure virtual

Set the maximum anisotropy for filtering.

The given value is clamped to the range from 1.0 to the highest possible value defined in the graphics driver/hardware, with 1.0 representing isotropic filtering (fastest), and higher values producing better visual results at the cost of rendering performance.

Parameters
maxAnisotropyThe maximum anisotropy value.
Returns
true if successful.

◆ GetMaxAnisotropy()

virtual Real Murl::Video::ISampler::GetMaxAnisotropy ( ) const
pure virtual

Set the maximum anisotropy for filtering.

Returns
The maximum anisotropy value.

The documentation for this interface was generated from the following file:
  • murl_video_i_sampler.h


Copyright © 2011-2024 Spraylight GmbH.