Class ClampToMipExperiment

Inheritance Relationships

Base Type

Class Documentation

class ClampToMipExperiment : public gpa::playback::PipelineExperiment::Prefab

Expresses a specialized Experiment that overrides the Mip level of a resource.

Public Functions

ClampToMipExperiment()

Creates an instance of ClampToMipExperiment.

~ClampToMipExperiment()

Destroys this instance of ClampToMipExperiment.

bool operator!=(ClampToMipExperiment const &other) const

Gets a value indicating whether or not a given ClampToMipExperiment is inequal to this ClampToMipExperiment.

Parameters

other -- The ClampToMipExperiment to check for inequality

Returns

Whether or not the give ClampToMipExperiment is inequal to this ClampToMipExperiment

virtual BaseExperiment::Prefab::Impl const &GetImpl() const final override

Gets this ClampToMipExperiment's implementation object.

Returns

This ClampToMipExperiment's implementation object

void SetDesiredMipLevel(float mipLevel)

Designates the mip level to clamp too.

Needs to be called once per experiment. This does not do any form of bounds checking to ensure that the mip level requested is valid. Users of this experiment should query the associated metadata first to determine what mip levels are available.

Parameters

mipLevel -- the index to clamp too. APIs treat 0 as the most detailed mip

float GetDesiredMipLevel()

returns the previously set mip level