/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** @file rs_allocation.rsh
* \brief Allocation routines
*
*
*/
#ifndef __RS_ALLOCATION_RSH__
#define __RS_ALLOCATION_RSH__
/**
* Returns the Allocation for a given pointer. The pointer should point within
* a valid allocation. The results are undefined if the pointer is not from a
* valid allocation.
*
* This function is deprecated and will be removed in the SDK from a future
* release.
*/
extern rs_allocation __attribute__((overloadable))
rsGetAllocation(const void *);
/**
* Query the dimension of an allocation.
*
* @return uint32_t The X dimension of the allocation.
*/
extern uint32_t __attribute__((overloadable))
rsAllocationGetDimX(rs_allocation);
/**
* Query the dimension of an allocation.
*
* @return uint32_t The Y dimension of the allocation.
*/
extern uint32_t __attribute__((overloadable))
rsAllocationGetDimY(rs_allocation);
/**
* Query the dimension of an allocation.
*
* @return uint32_t The Z dimension of the allocation.
*/
extern uint32_t __attribute__((overloadable))
rsAllocationGetDimZ(rs_allocation);
/**
* Query an allocation for the presence of more than one LOD.
*
* @return uint32_t Returns 1 if more than one LOD is present, 0 otherwise.
*/
extern uint32_t __attribute__((overloadable))
rsAllocationGetDimLOD(rs_allocation);
/**
* Query an allocation for the presence of more than one face.
*
* @return uint32_t Returns 1 if more than one face is present, 0 otherwise.
*/
extern uint32_t __attribute__((overloadable))
rsAllocationGetDimFaces(rs_allocation);
#if (defined(RS_VERSION) && (RS_VERSION >= 14))
/**
* Copy part of an allocation from another allocation.
*
* @param dstAlloc Allocation to copy data into.
* @param dstOff The offset of the first element to be copied in
* the destination allocation.
* @param dstMip Mip level in the destination allocation.
* @param count The number of elements to be copied.
* @param srcAlloc The source data allocation.
* @param srcOff The offset of the first element in data to be
* copied in the source allocation.
* @param srcMip Mip level in the source allocation.
*/
extern void __attribute__((overloadable))
rsAllocationCopy1DRange(rs_allocation dstAlloc,
uint32_t dstOff, uint32_t dstMip,
uint32_t count,
rs_allocation srcAlloc,
uint32_t srcOff, uint32_t srcMip);
/**
* Copy a rectangular region into the allocation from another
* allocation.
*
* @param dstAlloc allocation to copy data into.
* @param dstXoff X offset of the region to update in the
* destination allocation.
* @param dstYoff Y offset of the region to update in the
* destination allocation.
* @param dstMip Mip level in the destination allocation.
* @param dstFace Cubemap face of the destination allocation,
* ignored for allocations that aren't cubemaps.
* @param width Width of the incoming region to update.
* @param height Height of the incoming region to update.
* @param srcAlloc The source data allocation.
* @param srcXoff X offset in data of the source allocation.
* @param srcYoff Y offset in data of the source allocation.
* @param srcMip Mip level in the source allocation.
* @param srcFace Cubemap face of the source allocation,
* ignored for allocations that aren't cubemaps.
*/
extern void __attribute__((overloadable))
rsAllocationCopy2DRange(rs_allocation dstAlloc,
uint32_t dstXoff, uint32_t dstYoff,
uint32_t dstMip,
rs_allocation_cubemap_face dstFace,
uint32_t width, uint32_t height,
rs_allocation srcAlloc,
uint32_t srcXoff, uint32_t srcYoff,
uint32_t srcMip,
rs_allocation_cubemap_face srcFace);
#endif //defined(RS_VERSION) && (RS_VERSION >= 14)
/**
* Extract a single element from an allocation.
*/
extern const void * __attribute__((overloadable))
rsGetElementAt(rs_allocation a, uint32_t x);
/**
* \overload
*/
extern const void * __attribute__((overloadable))
rsGetElementAt(rs_allocation a, uint32_t x, uint32_t y);
/**
* \overload
*/
extern const void * __attribute__((overloadable))
rsGetElementAt(rs_allocation a, uint32_t x, uint32_t y, uint32_t z);
#if (defined(RS_VERSION) && (RS_VERSION >= 18))
#define GET_ELEMENT_AT(T) \
extern T __attribute__((overloadable)) \
rsGetElementAt_##T(rs_allocation a, uint32_t x); \
extern T __attribute__((overloadable)) \
rsGetElementAt_##T(rs_allocation a, uint32_t x, uint32_t y); \
extern T __attribute__((overloadable)) \
rsGetElementAt_##T(rs_allocation a, uint32_t x, uint32_t y, uint32_t z);
#else
#define GET_ELEMENT_AT(T) \
static inline T __attribute__((overloadable)) \
rsGetElementAt_##T(rs_allocation a, uint32_t x) { \
return ((T *)rsGetElementAt(a, x))[0]; \
} \
static inline T __attribute__((overloadable)) \
rsGetElementAt_##T(rs_allocation a, uint32_t x, uint32_t y) { \
return ((T *)rsGetElementAt(a, x, y))[0]; \
} \
static inline T __attribute__((overloadable)) \
rsGetElementAt_##T(rs_allocation a, uint32_t x, uint32_t y, uint32_t z) { \
return ((T *)rsGetElementAt(a, x, y, z))[0]; \
}
#endif
GET_ELEMENT_AT(char)
GET_ELEMENT_AT(char2)
GET_ELEMENT_AT(char3)
GET_ELEMENT_AT(char4)
GET_ELEMENT_AT(uchar)
GET_ELEMENT_AT(uchar2)
GET_ELEMENT_AT(uchar3)
GET_ELEMENT_AT(uchar4)
GET_ELEMENT_AT(short)
GET_ELEMENT_AT(short2)
GET_ELEMENT_AT(short3)
GET_ELEMENT_AT(short4)
GET_ELEMENT_AT(ushort)
GET_ELEMENT_AT(ushort2)
GET_ELEMENT_AT(ushort3)
GET_ELEMENT_AT(ushort4)
GET_ELEMENT_AT(int)
GET_ELEMENT_AT(int2)
GET_ELEMENT_AT(int3)
GET_ELEMENT_AT(int4)
GET_ELEMENT_AT(uint)
GET_ELEMENT_AT(uint2)
GET_ELEMENT_AT(uint3)
GET_ELEMENT_AT(uint4)
GET_ELEMENT_AT(long)
GET_ELEMENT_AT(long2)
GET_ELEMENT_AT(long3)
GET_ELEMENT_AT(long4)
GET_ELEMENT_AT(ulong)
GET_ELEMENT_AT(ulong2)
GET_ELEMENT_AT(ulong3)
GET_ELEMENT_AT(ulong4)
GET_ELEMENT_AT(float)
GET_ELEMENT_AT(float2)
GET_ELEMENT_AT(float3)
GET_ELEMENT_AT(float4)
GET_ELEMENT_AT(double)
GET_ELEMENT_AT(double2)
GET_ELEMENT_AT(double3)
GET_ELEMENT_AT(double4)
#undef GET_ELEMENT_AT
// Jelly Bean
#if (defined(RS_VERSION) && (RS_VERSION >= 16))
/**
* Send the contents of the Allocation to the queue.
* @param a allocation to work on
*/
extern const void __attribute__((overloadable))
rsAllocationIoSend(rs_allocation a);
/**
* Receive a new set of contents from the queue.
* @param a allocation to work on
*/
extern const void __attribute__((overloadable))
rsAllocationIoReceive(rs_allocation a);
/**
* Get the element object describing the allocation's layout
* @param a allocation to get data from
* @return element describing allocation layout
*/
extern rs_element __attribute__((overloadable))
rsAllocationGetElement(rs_allocation a);
/**
* Fetch allocation in a way described by the sampler
* @param a 1D allocation to sample from
* @param s sampler state
* @param location to sample from
*/
extern const float4 __attribute__((overloadable))
rsSample(rs_allocation a, rs_sampler s, float location);
/**
* Fetch allocation in a way described by the sampler
* @param a 1D allocation to sample from
* @param s sampler state
* @param location to sample from
* @param lod mip level to sample from, for fractional values
* mip levels will be interpolated if
* RS_SAMPLER_LINEAR_MIP_LINEAR is used
*/
extern const float4 __attribute__((overloadable))
rsSample(rs_allocation a, rs_sampler s, float location, float lod);
/**
* Fetch allocation in a way described by the sampler
* @param a 2D allocation to sample from
* @param s sampler state
* @param location to sample from
*/
extern const float4 __attribute__((overloadable))
rsSample(rs_allocation a, rs_sampler s, float2 location);
/**
* Fetch allocation in a way described by the sampler
* @param a 2D allocation to sample from
* @param s sampler state
* @param location to sample from
* @param lod mip level to sample from, for fractional values
* mip levels will be interpolated if
* RS_SAMPLER_LINEAR_MIP_LINEAR is used
*/
extern const float4 __attribute__((overloadable))
rsSample(rs_allocation a, rs_sampler s, float2 location, float lod);
#endif // (defined(RS_VERSION) && (RS_VERSION >= 16))
#if (defined(RS_VERSION) && (RS_VERSION >= 18))
/**
* Set single element of an allocation.
*/
extern void __attribute__((overloadable))
rsSetElementAt(rs_allocation a, void* ptr, uint32_t x);
/**
* \overload
*/
extern void __attribute__((overloadable))
rsSetElementAt(rs_allocation a, void* ptr, uint32_t x, uint32_t y);
#define SET_ELEMENT_AT(T) \
extern void __attribute__((overloadable)) \
rsSetElementAt_##T(rs_allocation a, T val, uint32_t x); \
extern void __attribute__((overloadable)) \
rsSetElementAt_##T(rs_allocation a, T val, uint32_t x, uint32_t y); \
extern void __attribute__((overloadable)) \
rsSetElementAt_##T(rs_allocation a, T val, uint32_t x, uint32_t y, uint32_t z);
SET_ELEMENT_AT(char)
SET_ELEMENT_AT(char2)
SET_ELEMENT_AT(char3)
SET_ELEMENT_AT(char4)
SET_ELEMENT_AT(uchar)
SET_ELEMENT_AT(uchar2)
SET_ELEMENT_AT(uchar3)
SET_ELEMENT_AT(uchar4)
SET_ELEMENT_AT(short)
SET_ELEMENT_AT(short2)
SET_ELEMENT_AT(short3)
SET_ELEMENT_AT(short4)
SET_ELEMENT_AT(ushort)
SET_ELEMENT_AT(ushort2)
SET_ELEMENT_AT(ushort3)
SET_ELEMENT_AT(ushort4)
SET_ELEMENT_AT(int)
SET_ELEMENT_AT(int2)
SET_ELEMENT_AT(int3)
SET_ELEMENT_AT(int4)
SET_ELEMENT_AT(uint)
SET_ELEMENT_AT(uint2)
SET_ELEMENT_AT(uint3)
SET_ELEMENT_AT(uint4)
SET_ELEMENT_AT(long)
SET_ELEMENT_AT(long2)
SET_ELEMENT_AT(long3)
SET_ELEMENT_AT(long4)
SET_ELEMENT_AT(ulong)
SET_ELEMENT_AT(ulong2)
SET_ELEMENT_AT(ulong3)
SET_ELEMENT_AT(ulong4)
SET_ELEMENT_AT(float)
SET_ELEMENT_AT(float2)
SET_ELEMENT_AT(float3)
SET_ELEMENT_AT(float4)
SET_ELEMENT_AT(double)
SET_ELEMENT_AT(double2)
SET_ELEMENT_AT(double3)
SET_ELEMENT_AT(double4)
#undef SET_ELEMENT_AT
/**
* Extract a single element from an allocation.
*/
extern const uchar __attribute__((overloadable))
rsGetElementAtYuv_uchar_Y(rs_allocation a, uint32_t x, uint32_t y);
/**
* Extract a single element from an allocation.
*
* Coordinates are in the dimensions of the Y plane
*/
extern const uchar __attribute__((overloadable))
rsGetElementAtYuv_uchar_U(rs_allocation a, uint32_t x, uint32_t y);
/**
* Extract a single element from an allocation.
*
* Coordinates are in the dimensions of the Y plane
*/
extern const uchar __attribute__((overloadable))
rsGetElementAtYuv_uchar_V(rs_allocation a, uint32_t x, uint32_t y);
#endif // (defined(RS_VERSION) && (RS_VERSION >= 18))
#if (defined(RS_VERSION) && (RS_VERSION >= 22))
#define VOP(T) \
extern T __attribute__((overloadable)) \
rsAllocationVLoadX_##T(rs_allocation a, uint32_t x); \
extern T __attribute__((overloadable)) \
rsAllocationVLoadX_##T(rs_allocation a, uint32_t x, uint32_t y); \
extern T __attribute__((overloadable)) \
rsAllocationVLoadX_##T(rs_allocation a, uint32_t x, uint32_t y, uint32_t z); \
extern void __attribute__((overloadable)) \
rsAllocationVStoreX_##T(rs_allocation a, T val, uint32_t x); \
extern void __attribute__((overloadable)) \
rsAllocationVStoreX_##T(rs_allocation a, T val, uint32_t x, uint32_t y); \
extern void __attribute__((overloadable)) \
rsAllocationVStoreX_##T(rs_allocation a, T val, uint32_t x, uint32_t y, uint32_t z);
VOP(char2)
VOP(char3)
VOP(char4)
VOP(uchar2)
VOP(uchar3)
VOP(uchar4)
VOP(short2)
VOP(short3)
VOP(short4)
VOP(ushort2)
VOP(ushort3)
VOP(ushort4)
VOP(int2)
VOP(int3)
VOP(int4)
VOP(uint2)
VOP(uint3)
VOP(uint4)
VOP(long2)
VOP(long3)
VOP(long4)
VOP(ulong2)
VOP(ulong3)
VOP(ulong4)
VOP(float2)
VOP(float3)
VOP(float4)
VOP(double2)
VOP(double3)
VOP(double4)
#undef VOP
#endif //(defined(RS_VERSION) && (RS_VERSION >= 22))
#endif