src/SDL_dataqueue.h
author Ryan C. Gordon <icculus@icculus.org>
Thu, 21 Apr 2016 03:16:44 -0400
changeset 11729 d1ce8396c356
parent 11582 cc0b1273a381
child 11811 5d94cb6b24d3
permissions -rw-r--r--
Initial shot at a renderer target for Apple's Metal API.

This isn't complete, but is enough to run testsprite2. It's currently
Mac-only; with a little work to figure out how to properly glue in a Metal
layer to a UIView, this will likely work on iOS, too.

This is only wired up to the configure script right now, and disabled by
default. CMake and Xcode still need their bits filled in as appropriate.
icculus@10681
     1
/*
icculus@10681
     2
  Simple DirectMedia Layer
slouken@10737
     3
  Copyright (C) 1997-2017 Sam Lantinga <slouken@libsdl.org>
icculus@10681
     4
icculus@10681
     5
  This software is provided 'as-is', without any express or implied
icculus@10681
     6
  warranty.  In no event will the authors be held liable for any damages
icculus@10681
     7
  arising from the use of this software.
icculus@10681
     8
icculus@10681
     9
  Permission is granted to anyone to use this software for any purpose,
icculus@10681
    10
  including commercial applications, and to alter it and redistribute it
icculus@10681
    11
  freely, subject to the following restrictions:
icculus@10681
    12
icculus@10681
    13
  1. The origin of this software must not be misrepresented; you must not
icculus@10681
    14
     claim that you wrote the original software. If you use this software
icculus@10681
    15
     in a product, an acknowledgment in the product documentation would be
icculus@10681
    16
     appreciated but is not required.
icculus@10681
    17
  2. Altered source versions must be plainly marked as such, and must not be
icculus@10681
    18
     misrepresented as being the original software.
icculus@10681
    19
  3. This notice may not be removed or altered from any source distribution.
icculus@10681
    20
*/
icculus@10681
    21
#ifndef SDL_dataqueue_h_
icculus@10681
    22
#define SDL_dataqueue_h_
icculus@10681
    23
icculus@10681
    24
/* this is not (currently) a public API. But maybe it should be! */
icculus@10681
    25
icculus@10681
    26
struct SDL_DataQueue;
icculus@10681
    27
typedef struct SDL_DataQueue SDL_DataQueue;
icculus@10681
    28
icculus@10681
    29
SDL_DataQueue *SDL_NewDataQueue(const size_t packetlen, const size_t initialslack);
icculus@10681
    30
void SDL_FreeDataQueue(SDL_DataQueue *queue);
icculus@10681
    31
void SDL_ClearDataQueue(SDL_DataQueue *queue, const size_t slack);
icculus@10681
    32
int SDL_WriteToDataQueue(SDL_DataQueue *queue, const void *data, const size_t len);
icculus@10681
    33
size_t SDL_ReadFromDataQueue(SDL_DataQueue *queue, void *buf, const size_t len);
icculus@11582
    34
size_t SDL_PeekIntoDataQueue(SDL_DataQueue *queue, void *buf, const size_t len);
icculus@10681
    35
size_t SDL_CountDataQueue(SDL_DataQueue *queue);
icculus@10681
    36
icculus@10743
    37
/* this sets a section of the data queue aside (possibly allocating memory for it)
icculus@10743
    38
   as if it's been written to, but returns a pointer to that space. You may write
icculus@10743
    39
   to this space until a read would consume it. Writes (and other calls to this
icculus@10743
    40
   function) will safely append their data after this reserved space and can
icculus@10743
    41
   be in flight at the same time. There is no thread safety.
icculus@10743
    42
   If there isn't an existing block of memory that can contain the reserved
icculus@10743
    43
   space, one will be allocated for it. You can not (currently) allocate
icculus@10743
    44
   a space larger than the packetlen requested in SDL_NewDataQueue.
icculus@10743
    45
   Returned buffer is uninitialized.
icculus@10743
    46
   This lets you avoid an extra copy in some cases, but it's safer to use
icculus@10743
    47
   SDL_WriteToDataQueue() unless you know what you're doing.
icculus@10743
    48
   Returns pointer to buffer of at least (len) bytes, NULL on error.
icculus@10743
    49
*/
icculus@10743
    50
void *SDL_ReserveSpaceInDataQueue(SDL_DataQueue *queue, const size_t len);
icculus@10743
    51
icculus@10681
    52
#endif /* SDL_dataqueue_h_ */
icculus@10681
    53
icculus@10681
    54
/* vi: set ts=4 sw=4 expandtab: */
icculus@10681
    55