RenderRegion Struct Reference

Note: The render region can set the clipping rectangle,offset and scale of render target in the screen space of render view. More...

#include <RenderRegion.h>

Inheritance diagram for RenderRegion:

Public Member Functions
	RenderRegion ()
	RenderRegion (bool bScalingBeforeClipping, const Point2 &scale, const FBox2 &rect, const Point2 &offset)
	RenderRegion (const RenderRegion &from)
RenderRegion &	operator= (const RenderRegion &from)
	~RenderRegion ()

Public Attributes
bool	mbScalingBeforeClipping
	the flag can indicate the order of scaling and clipping.The offset order does not affect the final result. More...
Point2	mScreenSpaceScale
	the scale value for the cropped render target after it is positioned in the screen space of the view. More...
FBox2	mPostRenderClippingRegion
	indicate the clipping rectangle of the render target. More...
Point2	mScreenSpaceOffset
	the offset value of the render target in the screen space of the view. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

Note: The render region can set the clipping rectangle,offset and scale of render target in the screen space of render view.

See also

the function SetRenderRegion of Class IRenderView

Constructor & Destructor Documentation

RenderRegion() [1/3]

RenderRegion ( )

inline

    {
        mbScalingBeforeClipping         = true;
        mScreenSpaceScale               = Point2(1.0,1.0);
        mPostRenderClippingRegion.pmin  = Point2(0.0,0.0);
        mPostRenderClippingRegion.pmax  = Point2(1.0,1.0);
        mScreenSpaceOffset              = Point2(0.0,0.0);  
        
    }

RenderRegion() [2/3]

RenderRegion ( bool  bScalingBeforeClipping, const Point2 &  scale, const FBox2 &  rect, const Point2 &  offset  )

inline

    {
        this->mbScalingBeforeClipping   = bScalingBeforeClipping;
        this->mScreenSpaceScale         = scale;
        this->mPostRenderClippingRegion = rect;
        this->mScreenSpaceOffset        = offset;       
    }

RenderRegion() [3/3]

RenderRegion ( const RenderRegion &  from )

inline

    {
        this->mbScalingBeforeClipping   = from.mbScalingBeforeClipping;
        this->mScreenSpaceScale         = from.mScreenSpaceScale;
        this->mPostRenderClippingRegion = from.mPostRenderClippingRegion;
        this->mScreenSpaceOffset        = from.mScreenSpaceOffset;      
    }

~RenderRegion()

~RenderRegion ( )

inline

    {
        // do nothing.
    }

Member Function Documentation

operator=()

RenderRegion& operator= ( const RenderRegion &  from )

inline

    {
        this->mbScalingBeforeClipping   = from.mbScalingBeforeClipping;
        this->mScreenSpaceScale         = from.mScreenSpaceScale;
        this->mPostRenderClippingRegion = from.mPostRenderClippingRegion;
        this->mScreenSpaceOffset        = from.mScreenSpaceOffset;
        
        return *this;
    }

Member Data Documentation

mbScalingBeforeClipping

bool mbScalingBeforeClipping

the flag can indicate the order of scaling and clipping.The offset order does not affect the final result.

mScreenSpaceScale

Point2 mScreenSpaceScale

the scale value for the cropped render target after it is positioned in the screen space of the view.

Its X and Y are radios that take the render target's width and height as base. The scaling operation take the center of the render target as reference point.

mPostRenderClippingRegion

FBox2 mPostRenderClippingRegion

indicate the clipping rectangle of the render target.

mScreenSpaceOffset

Point2 mScreenSpaceOffset

the offset value of the render target in the screen space of the view.

They are ratios that take the view's width and height as base.